Pular para o conteúdo principal

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_KEY
MÉTODO
GET
STATUS
200

Autenticação​

Requer assinatura da requisição. Ver Autenticação.

Parâmetros de caminho​

CampoTipoObrigatórioDescriçãoTamanho
INVOICE_EXPORT_KEYuuidSimChave do pedido, devolvida ao pedir a exportação.36

Resposta​

CampoTipoDescrição
invoice_export_keyuuidChave do pedido.
statusstringpending, processing, done ou expired. Ver status do pedido.
filtersobjectFiltros do pedido.
row_countintegerQuantidade de tarifas gravadas. Definitiva em done e expired.
created_atstringData e hora do pedido.
finished_atstringData e hora em que o arquivo ficou pronto, ou null.
expires_atstringData e hora até a qual o arquivo pode ser baixado, ou null.
file_namestringNome do arquivo, tarifas-<data do pedido>.csv. Só em done; null nos demais status.
download_urlstringLink 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"
}
  • 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 a expired, file_name e download_url voltam null, 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 linha CRLF.
  • 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 Conta e Documento do titular vazios e o nome do requester em Titular.

Erros​

StatusCódigoDescrição
404BLL000135O 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.