Consulte boletos gerados de acordo com a data de vencimento
Quais são os requisitos para a utilização desta API?
- Token: possuir um token de acesso válido é essencial. Caso ainda não tenha gerado um, temos um guia detalhado disponível no tópico Fluxos de Autorização e Autenticação.
- Boleto: para que a resposta da API seja preenchida, é recomendável que um boleto tenha sido gerado anteriormente.
Parâmetros da requisição
Parâmetro | Tipo | Descrição |
|---|---|---|
start opcional | String | Data início, no formato YYYY-MM-DD Atenção O intervalo de tempo da consulta estará relacionado à data de vencimento da fatura |
end\ opcional | String | Data final, no formato YYYY-MM-DD |
state\ opcional | String | Descrição dos possíveis estados do boleto |
search\ opcional | String | CPF/CNPJ do destinatário |
page\ opcional | Int | Número da página. Possui valor padrão 1 |
perPage\ opcional | Int | Número de itens por página. Possui o valor padrão 20 |
Estados dos boletos
| Parâmetro | Descrição |
|---|---|
| CANCELLED | Boletos cancelados |
| DRAFT | Boletos em rascunho, um estado intermediário entre criação e registro |
| IN_PAYMENT | Boletos em processo de pagamento |
| INITIATED | Boletos iniciados, aguardando a atualização dos próximos passos do fluxo |
| LATE | Boletos com pagamento em atraso, ou seja, após a data de vencimento |
| OPEN | Boletos registrados, mas ainda não pagos |
| PAID | Boletos que foram pagos com sucesso |
| RECURRENCE_DRAFT | Boletos criados com recorrência que nos quais o usuário não deu andamento à criação da cobrança |
Parâmetros da resposta
Parâmetro | Tipo | Descrição |
|---|---|---|
totalItems obrigatório | Int | Total de items retornados na lista |
items\ obrigatório | Lista de Strings | Lista de objetos Invoice |
Dicas de implementação
Premissas
O parâmetro start e o parâmetro end são usados para especificar o intervalo de tempo desejado na consulta. É importante notar que as datas inseridas no parâmetro end devem ser maiores que as datas informadas no parâmetro startErros Comuns
Código de erro | Descrição |
|---|---|
401 (Unauthorized) | O token de acesso está inválido ou expirado. Erro comum no momento de trocas de ambientes (Stage/Production) |
400 (Bad Request) | Requisição mal formatada. Alguns exemplos comuns:
- O Start e/ou End está com o formato errado. Para garantir que as informações sejam interpretadas e processadas corretamente pelo sistema, é essencial inseri-las no formato YYYY-MM-DD. Um exemplo prático pode ajudar a entender melhor: suponha que você deseja consultar os boletos a partir do dia 15 de janeiro de 2023. Neste caso, a data deve ser informada como 2023-01-15 |
