Bill
Download Bills URL
Generate a URL for downloading a CSV file containing a comprehensive list of Bills data for the specified organization for a specified period. This endpoint facilitates easy exporting of billing data for external analysis and reporting.
The response to this call returns a pre-signed downloadUrl, which you then enter into your browser to download the CSV file of the Bill entities.
You can use the externalSystem request parameter to control the format of the Bills data in the CSV file:
- STANDARD A wider range of Bills data columns is given.
- XERO A more limited range of data columns is given and compatible with loading into your 3rd-party Xero system.
NOTES:
- Download Limits. You can only download Bills for a period of up to 31 days or up to a maximum of 5000 Bills. If you attempt a download that exceeds either of these two limits, you'll receive an error message
- Empty Bills. The CSV formatted file is compiled for download by taking each of the line items found in Bills that exist in your Organization for the specified period. The Bill for each line item record is given, along with Bill Total and other billing attributes. However, this means that if you have an empty Bill that exists for the specified period - one for which no line items currently exist - then no line item records will be shown for this Bill in the CSV file you download.
post/organizations/{orgId}/bills/download/csv/url
Path parameters
orgIdstring required
The unique identifier (UUID) of your Organization. The Organization represents your company as a direct customer of our service.
Request body
Example request
{
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"externalSystem": "STANDARD"
}Response
Returns the download URL