Exports bills to an accounting system (AP, GL, or Payment) and returns the export file content
Use this endpoint to generate a bill export file. Maximum of 10,000 bills per export. Only eligible bills are included:
approved (if approval enabled), in a closed batch (if required by workflow), not held for export, not void,
within the user’s topmost, and not already exported. Returns the export file as text/plain content.
The response header ‘Ec-Guid’ contains a GUID that can be used to unexport these bills later via PUT /bill/unexport/{guid}.
For Managed Services payment exports, additional rules apply (payment cutoff date, positive cost, not excluded).
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
BillExport
| Property | Description | Type |
|---|---|---|
| billIds | List of bill IDs to mark as exported. Null exports all unexported bills matching the filter. Must not be empty if provided. Cannot be Empty NULL Valid Required (defined) | integer[] |
| exportMode | The export mode to use. Valid values are ‘AP’, ‘GL’, ‘Payment’ Required One of ‘ap’, ‘gl’, ‘payment’ | string |
| exportNote | Optional note/comment. Required (defined) | string |
| fileName | Optional filename to use for the export file. Filenames may only contain alphanumeric characters, dashes, underscores, or periods. Required (defined) | string |
| markAsExported | Flag to mark bills as exported after the export is complete. Required | boolean |
Example Request Body
{ "billIds": [
1
], "exportMode": "string", "exportNote": "string", "fileName": "string", "markAsExported": false
}
Responses
200
OK
The request succeeded and the response body contains the requested data.