GET /api/v202401/import/bill/task/{taskGuid}/kickout/{filename}/detail

Retrieves detailed kickout records for a specific file within a bill import task, optionally filtered by message

GetBillImportKickoutDetailsByFileV202401 Permissions: BillsAndBatches (View)
Use this endpoint to get line-level kickout detail scoped to a single file when the import contained multiple files. 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
filename The specific kickout file name to retrieve details for string 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
Property Description Type
id The column identifier. This is a dynamic field and may vary between requests. integer (int32)
name The column name string
Example Response application/json 
{  "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.