GET /api/v3/import/bill/profile

Get all bill import profiles

GetBillImportProfilesV3 Permissions: BillsAndBatches (Create)

Request Headers

Header Value Required Description
ECI-ApiKey string Yes Your API key. See Authentication.
Content-Type application/json Yes All requests must specify JSON content type.

Responses

200 OK The request succeeded and the response body contains the requested data.

Response Body Parameters

Array of:

BillImportProfileResponse
Property Description Type
columnMapping BillImportProfileColumnMapping
BillImportProfileColumnMapping properties
Property Description Type
accountCodeColumnIndex Required Must be between 1 and 2147483647 integer (int32)
accountPeriodColumnIndex Must be between 1 and 2147483647 integer (int32)
aceFlagColumnIndex Must be between 1 and 2147483647 integer (int32)
billNoteColumnIndex Must be between 1 and 2147483647 integer (int32)
billingPeriodColumnIndex Must be between 1 and 2147483647 integer (int32)
commodityColumnIndex Must be between 1 and 2147483647 integer (int32)
controlCodeColumnIndex Must be between 1 and 2147483647 integer (int32)
dateFormat Required One of ‘mm/dd/yyyy’, ‘Month dd yyyy’, ‘dd/mm/yyyy’, ‘dd Month yyyy’, ‘yyyymmdd’ Case sensitive string
dueDateColumnIndex Must be between 1 and 2147483647 integer (int32)
endDateColumnIndex Required Must be between 1 and 2147483647 integer (int32)
invoiceNumberColumnIndex Must be between 1 and 2147483647 integer (int32)
meterCodeColumnIndex Must be between 1 and 2147483647 integer (int32)
observations Cannot be Empty BillImportProfileObservation[]
BillImportProfileObservation properties
Property Description Type
caption Required Must be between 0 and 100 characters string
columnIndex Required Must be between 1 and 2147483647 integer (int32)
observationTypeCode Required string
unitCode Required string
payAmountColumnIndex Must be between 1 and 2147483647 integer (int32)
rateColumnIndex Must be between 1 and 2147483647 integer (int32)
serialNumberColumnIndex Must be between 1 and 2147483647 integer (int32)
serviceChargeColumnIndex Must be between 1 and 2147483647 integer (int32)
startDateColumnIndex Required Must be between 1 and 2147483647 integer (int32)
statementDateColumnIndex Must be between 1 and 2147483647 integer (int32)
vendorCodeColumnIndex Must be between 1 and 2147483647 integer (int32)
vprFlagColumnIndex Must be between 1 and 2147483647 integer (int32)
profileCode Required Must be between 0 and 64 characters Required Must be between 0 and 64 characters string
profileId integer (int32)
Example Response application/json 
[
  {    "columnMapping": {      "accountCodeColumnIndex": 1,      "accountPeriodColumnIndex": 1,      "aceFlagColumnIndex": 1,      "billNoteColumnIndex": 1,      "billingPeriodColumnIndex": 1,      "commodityColumnIndex": 1,      "controlCodeColumnIndex": 1,      "dateFormat": "string",      "dueDateColumnIndex": 1,      "endDateColumnIndex": 1,      "invoiceNumberColumnIndex": 1,      "meterCodeColumnIndex": 1,      "observations": [],      "payAmountColumnIndex": 1,      "rateColumnIndex": 1,      "serialNumberColumnIndex": 1,      "serviceChargeColumnIndex": 1,      "startDateColumnIndex": 1,      "statementDateColumnIndex": 1,      "vendorCodeColumnIndex": 1,      "vprFlagColumnIndex": 1
    },    "profileCode": "string",    "profileId": 1
  }
]