---
title: "Contagem de Boletos."
method: GET
path: "/v1/reports/bank_billets"
tags: ["Relatórios"]
---

# Contagem de Boletos.

`GET /v1/reports/bank_billets`

## Request

- Base URL: `https://api-sandbox.kobana.com.br`
- URL: `https://api-sandbox.kobana.com.br/v1/reports/bank_billets`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/kobana/apis/cobran-as/docs/v1/reports/bank_billets/get.ts> (a function with typed inputs; its response is checked against the schema)

Contagem de Boletos.

## Query parameters

- `expire_from` string, date
- `expire_to` string, date
- `paid_from` string, date
- `paid_to` string, date
- `registered_from` string, date
- `registered_to` string, date
- `created_from` string, date
- `created_to` string, date
- `status` 'generating' | 'opened' | 'paid' | 'overdue' | 'canceled' | 'draft' | 'generation_failed' | 'validation_failed' | 'blocked' | 'chargeback'

## Headers

- `User-Agent` string

## Response `200`

Sucesso na listagem de boletos

- BankBilletReportObject[]
  - `bank_billet_account_id` integer, nullable: ID da Carteira de Cobrança.
  - `bank_billet_count` integer, nullable: Quantidade de boletos.
  - `bank_billet_amount` number, nullable: Valor total dos boletos.

## Other responses

- `401`: Falha de autenticação. Token inválido
- `403`: Falha de permissão. Você não tem o Scope obrigatório para essa chamada.

---

[API](https://skmtc.dev/kobana/apis/cobran-as.md) - [All operations](https://skmtc.dev/kobana/apis/cobran-as/llms.txt) - [OpenAPI document](https://skmtc.dev/kobana/apis/cobran-as/revisions/728c362ec4d7?raw)