PUT /api/v202108/bill/billPaymentDetailsFile

For each bill in the import file, update the bill payment details.

BillPaymentDetailsFileV202108 Permissions: BillsAndBatches (Edit)

The import file needs to be a comma separated file.

All lines are data lines (No header line allowed).

The file structure is as follows- Bill Id (required), Check Number (required), Check Date YYYYMMDD format (required), Pay Status (upto 10 characters- do not use commas) (required), Cleared Date YYYYMMDD format (optional), Accounting Period YYYYMM (optional), comment (optional) - comment will be ignored. Example data:12345,7098,20210801,Procesed,20210806,202107,July bill paid via AP

For this request, please use application/octet-stream as Content-Type and include your file as binary in the body of the request. ///

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, including the request body.

Request Body

Type: string

Example Request Body application/json
"string"

Responses

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

Response Body Parameters

BillPaymentDetailsFileResponseV202108
Property Description Type
failure Number of unsuccessful bill payment detail updates Required (defined) integer (int32)
kickoutStream Base64 encoded File content of unsuccessful bill payment detail updates with reasons for failure Required (defined) string
success Number of successful bill payment detail updates Required (defined) integer (int32)
Example Response application/json
{  "failure": 1,  "kickoutStream": "string",  "success": 1
}