POST /api/v202607/bill/billImage/download

Queues a background job that zips the scanned images for the selected bills

StartDownloadV202607 Permissions: BillsAndBatches (View)
Use this endpoint to start a bulk bill-image download for a set of selected bills. The images are gathered asynchronously by a background job; poll GET /api/v202607/bill/billImage/download/{token}/status with the returned token to track progress, then GET /api/v202607/bill/billImage/download/{token} to download the finished zip. Bills that have no available image (or whose image cannot be downloaded) are skipped and counted, not failed.

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

BillImageDownloadRequest
Property Description Type
billIds The identifiers of the bills whose scanned images should be collected into a single zip file. Bills that have no available image are skipped rather than causing the request to fail. Required Cannot be Empty integer[]
Example Request Body application/json 
{  "billIds": [
    1
  ]
}

Responses

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

Response Body Parameters

BillImageDownloaken
Property Description Type
token Unique token identifying this bulk bill-image download request. Use it to poll GET /api/v202607/bill/billImage/download/{token}/status and to retrieve the finished zip from GET /api/v202607/bill/billImage/download/{token}. string (uuid)
Example Response application/json 
{  "token": "string"
}