Pular para o conteúdo principal

Listar tarifas

Lista as tarifas do requester, da mais recente para a mais antiga, com paginação por cursor. Sem filtros, a lista traz as tarifas de todas as contas e as tarifas cobradas do próprio requester. Para ver o extrato de tarifas de uma conta, filtre pela conta com account_key.

Endpoint​

ENDPOINT
/billing/requester_configuration/invoices
MÉTODO
GET
STATUS
200

Autenticação​

Requer assinatura da requisição. Ver Autenticação. O requester é o da credencial que assina a requisição.

Query params​

Todos os parâmetros são opcionais.

CampoTipoDescrição
start_datestringData inicial do período, no formato aaaa-mm-dd, inclusiva.
end_datestringData final do período, no formato aaaa-mm-dd, inclusiva. Não pode ser anterior a start_date.
statusstringStatus da tarifa. Enumerador status
billing_typestringTipo de tarifa. Pode ser repetido para combinar tipos (billing_type=account_maintenance&billing_type=outgoing_ted).
payment_methodstringMétodo de pagamento da tarifa. Enumerador payment_method
account_keyuuidChave da conta. Traz o extrato de tarifas dessa conta. Pode ser repetido, até o valor de page_size. Quando enviado, os três filtros de conta abaixo são ignorados.
owner_document_numberstringCPF ou CNPJ do titular da conta, só números. Traz as tarifas de todas as contas desse titular.
account_numberstringNúmero da conta, sem o dígito.
owner_namestringInício do nome do titular. A lista traz as tarifas das 50 contas mais recentes cujo titular começa com esse nome.
page_sizeintegerQuantidade de tarifas por página. Padrão 100, mínimo 1, máximo 100.
cursorstringValor de cursor da resposta anterior, para buscar a próxima página. Na primeira página, não envie.

Paginação​

  1. Faça a primeira requisição sem cursor.
  2. Se has_next_page vier true, repita a requisição com os mesmos filtros e cursor igual ao cursor da resposta.
  3. Pare quando has_next_page vier false.

Mantenha os mesmos filtros em todas as páginas. O cursor é a chave da última tarifa da página e só vale para o requester que fez a consulta.

Resposta​

CampoTipoDescrição
dataarrayTarifas da página. Data
requester_namestringNome do requester. Vem preenchido quando a página tem alguma tarifa cobrada do requester (account nulo); senão, null.
page_sizeintegerQuantidade de tarifas por página.
has_next_pagebooleantrue quando existe uma próxima página.
cursorstringValor a enviar em cursor para buscar a próxima página. null na última página.
accounts_truncatedbooleantrue quando o filtro owner_name encontrou mais de 50 contas e a lista trouxe só as tarifas das 50 mais recentes. Refine o nome para ver as demais.

Data​

CampoTipoDescrição
invoice_keyuuidChave da tarifa.
reference_datestringData da tarifa, no formato aaaa-mm-dd.
billing_typestringTipo de tarifa.
billing_type_descriptionstringDescrição do tipo de tarifa.
statusstringStatus da tarifa. Enumerador status
total_amountnumberValor total da tarifa.
paid_amountnumberValor já pago.
amount_owednumberValor em aberto. 0 para tarifa baixada.
payment_methodstringMétodo de pagamento da tarifa. null quando não se enquadra em nenhum método. Enumerador payment_method
billing_account_owner_typestringDe quem é a conta debitada. null quando não há conta debitada ou quando ela não é nenhuma das duas do enumerador. Enumerador billing_account_owner_type
payer_document_numberstringCPF ou CNPJ do pagador do boleto. null quando a tarifa não é cobrada por boleto.
accountobjectConta que originou a tarifa. null quando a tarifa é cobrada do próprio requester. Account

Account​

CampoTipoDescrição
account_keyuuidChave da conta.
account_numberstringNúmero da conta, sem o dígito.
account_digitstringDígito da conta.
owner_namestringNome do titular da conta.
owner_document_numberstringCPF ou CNPJ do titular da conta.
{
"data": [
{
"invoice_key": "d1f4a2b6-8c3e-4f5a-9b7d-2e6c8a0f1d3b",
"reference_date": "2026-10-01",
"billing_type": "account_maintenance",
"billing_type_description": "Tarifa de Manutenção de Conta",
"status": "paid",
"total_amount": 30.00,
"paid_amount": 30.00,
"amount_owed": 0.00,
"payment_method": "account_debit",
"billing_account_owner_type": "account_holder",
"payer_document_number": null,
"account": {
"account_key": "5b0e8c1a-3f2d-4e6b-9a7c-1d2e3f4a5b6c",
"account_number": "1234567",
"account_digit": "8",
"owner_name": "Empresa Exemplo Ltda",
"owner_document_number": "96969879000101"
}
},
{
"invoice_key": "b2e5c3a7-9d4f-4a6b-8c1e-3f7d9b1a2c4e",
"reference_date": "2026-09-30",
"billing_type": "outgoing_ted",
"billing_type_description": "Tarifa de Envio de TED",
"status": "open",
"total_amount": 20.00,
"paid_amount": 0.00,
"amount_owed": 20.00,
"payment_method": "centralizing_account_debit",
"billing_account_owner_type": "centralizing_account",
"payer_document_number": null,
"account": null
}
],
"requester_name": "Requester Exemplo S.A.",
"page_size": 2,
"has_next_page": true,
"cursor": "b2e5c3a7-9d4f-4a6b-8c1e-3f7d9b1a2c4e",
"accounts_truncated": false
}

Erros​

StatusCódigoDescrição
400BLL000096Data fora do formato aaaa-mm-dd, ou end_date anterior a start_date.
400BLL000043status fora do enumerador.
400BLL000130payment_method fora do enumerador.
400BLL000090page_size não é um número inteiro.
400BLL000091page_size menor que 1 ou maior que 100.
400BLL000132cursor não é uma tarifa do requester.
400BLL000133Mais account_key do que o valor de page_size.
404BLL000111Um dos billing_type não existe.
422BLL000129A consulta passou do tempo máximo. Escolha um período menor ou filtre por conta.

O corpo de erro segue o formato padrão (title, description, translation, code). Os erros gerais da plataforma estão nos erros comuns do catálogo de erros do BaaS.

Enumeradores​

Enumerador status​

ValorDescrição
openTarifa em aberto.
pendingAguardando pagamento.
paidTarifa quitada.
written_offTarifa baixada.

Enumerador payment_method​

ValorDescrição
account_debitDébito na conta do titular.
centralizing_account_debitDébito na conta centralizadora do requester.
bank_slipCobrança por boleto.
account_debit_and_bank_slipParte debitada em conta e o restante cobrado por boleto.

Enumerador billing_account_owner_type​

ValorDescrição
account_holderConta do titular que originou a tarifa.
centralizing_accountConta centralizadora do requester.

Próximo passo​

Para baixar as mesmas tarifas num arquivo CSV, use a exportação de tarifas, que aceita os mesmos filtros.