Documentação para Desenvolvedores

Relatórios

Recurso Descrição
GET /api/v1/reports/bank_billet Contagem de boletos

Modelo de Dados

Parâmetro Tipo Tamanho Descrição
bank_billet_account_id Integer   ID da Carteira de Cobrança. Se não informado, usará a carteira padrão.
bank_billet_count Integer   Quantidade de boletos.

Contagem de boletos

GET /api/v1/reports/bank_billets

Parâmetro Obrigatório Tipo Descrição
expire_from Não Date A partir da Data de vencimento
expire_to Não Date Até a Data de vencimento
paid_from Não Date A partir da Data de pagamento
paid_to Não Date Até a Data de pagamento
registered_from Não Date A partir da Data de Registro
registered_to Não Date Até a Data de Registro
created_from Não Date A partir da Data de criação
created_to Não Date Até a Data de criação

Exemplo

Requisição:
curl -i \
-H "Authorization: Bearer $BOLETOSIMPLES_TOKEN" \
-H 'Content-Type: application/json' \
-H 'User-Agent: MyApp (myapp@example.com)' \
-X GET "https://sandbox.boletosimples.com.br/api/v1/report/bank_billets?created_from=2019-10-01"
Resposta:
HTTP/1.1 200 OK
Date: Wed, 02 Oct 2019 19:46:16 GMT
Status: 200 OK
Content-Type: application/json; charset=utf-8
...

[
  {
    "bank_billet_account_id":1254,
    "bank_billet_count":543
  },
  {
    "bank_billet_account_id":1281,
    "bank_billet_count":1218
  }
]