Retrieves detailed kickout records for a bill import task, optionally filtered by message
Use this endpoint to get line-level detail about which bills were kicked out and why.
Optionally filter to a specific kickout message type. The task must be of type Bill Import.
Requires Bills and Batches View permission.
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. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| taskGuid | The GUID of the bill import task | string (uuid) | Required |
Query Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| kickoutMessage | Optional kickout message string to filter results to a specific error type | string | Optional |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
BillImportKickoutDetailsResponse
| Property | Description | Type | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| data | The kickout values | array[] | |||||||||
| fields | The kickout fields | KickoutField[] | |||||||||
|
KickoutField properties
|
|||||||||||
Example Response
{ "data": [
[
{ "fieldId": 1, "value": "string"
}
]
], "fields": [
{ "id": 1, "name": "string"
}
]
}
404
Not Found
The requested resource was not found. Verify the ID or path is correct.