POST /api/v3/generatebillimport

Generates a bill import file from historical bill data for specified bill IDs

ExportHistoricalBillsV3 Permissions: BillsAndBatches (View)
Use this endpoint to export existing bills into a file format suitable for re-import. This is useful for data migration between environments or for re-processing bills. The output format is determined by the VPR (vendor-place-rate) flag in the request. 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, including the request body.

Query Parameters

Name Description Type Required
exportFileName Optional custom filename for the exported file; auto-generated if not provided string Optional

Request Body

BillActionHistoricalExport
Property Description Type
ids List of bill IDs to mark as historically exported. Must contain at least one ID. Cannot be Empty integer[]
vpr The historical export type. Valid values: empty string (none), “V” (voucher), “P” (payment), “R” (receipt). Case-insensitive. One of ‘’, ‘V’, ‘P’, ‘R’ string
Example Request Body application/json 
{  "ids": [
    1
  ],  "vpr": "string"
}

Responses

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

Response Body Parameters

Type: string (binary)

Example Response application/json 
"string"