Sign in

v1

latestOpenAPI 3.1.02026-07-249043961.2 KB
Relatórios

Contagem de Boletos.

Contagem de Boletos.

get/v1/reports/bank_billets

Query parameters

expire_fromstring date

A partir da Data de vencimento.

expire_tostring date

Até a Data de vencimento.

paid_fromstring date

A partir da Data de pagamento.

paid_tostring date

Até a Data de pagamento.

registered_fromstring date

A partir da Data de registro.

registered_tostring date

Até a Data de registro.

created_fromstring date

A partir da Data de criação.

created_tostring date

Até a Data de criação.

status'generating' | 'opened' | 'paid' | 'overdue' | 'canceled' | 'draft' | 'generation_failed' | 'validation_failed' | 'blocked' | 'chargeback'

Status do boleto.

Headers

User-Agentstring

Informar um e-mail válido para contatos.

Response

Sucesso na listagem de boletos

bank_billet_account_idinteger nullable

ID da Carteira de Cobrança.

bank_billet_countinteger nullable

Quantidade de boletos.

bank_billet_amountnumber nullable

Valor total dos boletos.