Consultar exportação de tarifas
Consulta um pedido de exportação de tarifas. Quando o pedido está done, a resposta traz o nome do arquivo e um link de download.
Endpoint
ENDPOINT
/billing/invoices/exports/INVOICE_EXPORT_KEYMÉTODO
GETSTATUS
200Autenticação
Requer assinatura da requisição. Ver Autenticação.
Parâmetros de caminho
| Campo | Tipo | Obrigatório | Descrição | Tamanho |
|---|---|---|---|---|
INVOICE_EXPORT_KEY | uuid | Sim | Chave do pedido, devolvida ao pedir a exportação. | 36 |
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
invoice_export_key | uuid | Chave do pedido. |
status | string | pending, processing, done ou expired. Ver status do pedido. |
filters | object | Filtros do pedido. |
row_count | integer | Quantidade de tarifas gravadas. Definitiva em done e expired. |
created_at | string | Data e hora do pedido. |
finished_at | string | Data e hora em que o arquivo ficou pronto, ou null. |
expires_at | string | Data e hora até a qual o arquivo pode ser baixado, ou null. |
file_name | string | Nome do arquivo, tarifas-<data do pedido>.csv. Só em done; null nos demais status. |
download_url | string | Link de download, válido por 1 hora. Só em done; null nos demais status. |
{
"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"
}
Link de download
- O link é gerado a cada consulta e vale por 1 hora. Se expirar, consulte o pedido de novo para obter outro.
- O arquivo fica disponível por 7 dias depois de pronto, até
expires_at. Depois disso o pedido passa aexpired,file_nameedownload_urlvoltamnull, e é preciso fazer um novo pedido.
Formato do arquivo
Um único arquivo CSV com todas as tarifas do pedido, uma por linha:
- Codificação UTF-8 com BOM, separador
;, quebra de linhaCRLF. - Datas no formato
dd/mm/aaaa; valores com vírgula decimal (30,00). - Colunas, nesta ordem:
Data,Tarifa,Status,Método de pagamento,Conta,Titular,Documento do titular,Documento do pagador do boleto,Valor,Valor pago,Valor devido. - Tarifas cobradas do próprio requester, sem conta de origem, saem com
ContaeDocumento do titularvazios e o nome do requester emTitular.
Erros
| Status | Código | Descrição |
|---|---|---|
| 404 | BLL000135 | O pedido não existe ou pertence a outro requester. |
O corpo de erro segue o formato padrão (title, description, translation, code). A tabela acima lista os códigos deste endpoint; os erros gerais da plataforma, como QIT000001, estão nos erros comuns do catálogo de erros do BaaS.
Webhooks relacionados
O webhook invoice_export avisa quando o pedido chega a done, sem precisar consultar em intervalos.