Query a fee export
Queries a fee export. When the export is done, the response includes the file name and a download link.
Endpoint
ENDPOINT
/billing/invoices/exports/INVOICE_EXPORT_KEYMETHOD
GETSTATUS
200Authentication
Requires a signed request. See Authentication.
Path parameters
| Field | Type | Required | Description | Size |
|---|---|---|---|---|
INVOICE_EXPORT_KEY | uuid | Yes | Export key, returned when you request the export. | 36 |
Response
| Field | Type | Description |
|---|---|---|
invoice_export_key | uuid | Export key. |
status | string | pending, processing, done or expired. See export status. |
filters | object | Export filters. |
row_count | integer | Number of fees written. Final in done and expired. |
created_at | string | Date and time of the request. |
finished_at | string | Date and time the file became ready, or null. |
expires_at | string | Date and time until which the file can be downloaded, or null. |
file_name | string | File name, tarifas-<request date>.csv. Only in done; null in the other statuses. |
download_url | string | Download link, valid for 1 hour. Only in done; null in the other statuses. |
{
"invoice_export_key": "7a9c0a5e-1b2f-4c3d-9e8f-0123456789ab",
"status": "done",
"filters": {
"start_date": "2026-09-01",
"end_date": "2026-09-30",
"payment_method": null,
"status": null,
"billing_types": [],
"owner_document_number": null,
"account_number": null,
"owner_name": null,
"account_key": null
},
"row_count": 1250000,
"created_at": "2026-10-15T14:03:11",
"finished_at": "2026-10-15T14:09:40",
"expires_at": "2026-10-22T14:09:38",
"file_name": "tarifas-2026-10-15.csv",
"download_url": "https://storage.googleapis.com/EXEMPLO/tarifas.csv?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Expires=3600"
}
Download link
- The link is generated on every query and is valid for 1 hour. If it expires, query the export again to get a new one.
- The file is available for 7 days after it is ready, until
expires_at. After that the export becomesexpired,file_nameanddownload_urlreturnnull, and a new request is needed.
File format
A single CSV file with every fee of the export, one per line:
- UTF-8 encoding with BOM,
;separator,CRLFline breaks. - Dates in
dd/mm/yyyyformat; amounts with a decimal comma (30,00). - The column headers are in Portuguese, in this order:
Data(date),Tarifa(fee),Status,Método de pagamento(payment method),Conta(account),Titular(holder),Documento do titular(holder document),Documento do pagador do boleto(bank slip payer document),Valor(amount),Valor pago(amount paid),Valor devido(amount owed). - Fees charged to the requester itself, with no originating account, have
ContaandDocumento do titularempty and the requester's name inTitular.
Errors
| Status | Code | Description |
|---|---|---|
| 404 | BLL000135 | The export does not exist or belongs to another requester. |
The error body follows the standard format (title, description, translation, code). The table above lists the codes of this endpoint; platform-wide errors, such as QIT000001, are in the common errors of the BaaS error catalog.
Related webhooks
The invoice_export webhook notifies you when the export reaches done, so there is no need to poll.