Retrieves the progress and completion state of a bulk bill-image download
Use this endpoint to poll a bulk bill-image download queued by POST /api/v202607/bill/billImage/download.
The client should keep polling while State is “processing” and download the zip once State is “complete”.
A “processing” state with a total of zero is returned briefly before the job first reports progress.
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 |
|---|---|---|---|
| token | The token returned when the download was queued | string (uuid) | Required |
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
BillImageDownloadStatus
| Property | Description | Type |
|---|---|---|
| fileName | Suggested download file name for the finished zip. Null until State is “complete”. | string |
| included | Number of bill images successfully downloaded and added to the zip. | integer (int32) |
| processed | Number of bills processed so far (included + skipped). Equals Total when State is “complete”. | integer (int32) |
| skipped | Number of bills skipped because they had no available image or the image could not be downloaded. | integer (int32) |
| state | Current job state: “processing” while images are still being collected, “complete” when the zip is ready to download, or “error” if the job failed before finishing. | string |
| total | Total number of bills requested for this download. | integer (int32) |
Example Response
{ "fileName": "string", "included": 1, "processed": 1, "skipped": 1, "state": "string", "total": 1
}