Sign in

v1

latestOpenAPI 3.1.02026-07-24890394.2 KB

Listar cobranças

Este recurso retorna uma lista com todas as cobranças já criadas.

get/charges

Query parameters

q[clientControlNumberEq]string

Número de controle definido pelo cliente.

q[documentNumberEq]integer

CPF ou CNPJ do pagador.

q[createdAtEq]string date

Data de criação da cobrança igual a. <br>Formato: <code>YYYY-MM-DD</code>

q[createdAtGteq]string date

Data de criação da cobrança <b>maior igual que. </b><br>Formato: <code>YYYY-MM-DD</code>

q[createdAtLteq]string date

Data de criação da cobrança <b>menor igual que. </b><br>Formato: <code>YYYY-MM-DD</code>

q[paidAtEq]string date

Data do pagamento da cobrança <b> igual a. </b><br>Formato: <code>YYYY-MM-DD</code>

q[paidAtGt]string date

Data de pagamento da cobrança <b>maior que. </b><br>Formato: <code>YYYY-MM-DD</code>

q[paidAtLt]string date

Data de pagamento da cobrança <b>menor que. </b> <br>Formato: <code>YYYY-MM-DD</code>

q[paidAtGteq]string date

Data de pagamento da cobrança <b>maior igual que. </b><br>Formato: <code>YYYY-MM-DD</code>

q[paidAtLteq]string date

Data de pagamento da cobrança <b>menor igual que. </b><br>Formato: <code>YYYY-MM-DD</code>

q[statusEq]'pending' | 'paid' | 'overpaid' | 'paid_externally'

Status da cobrança igual a. <br>valores permitidos: <code>pending</code> (pendente), <code>paid</code> (paga), <code>paid_externally</code> (baixada) e <code>overpaid (pago a mais)</code>

q[paymentMethodEq]'boleto' | 'pix' | 'ted'

Método de pagamento da cobrança igual a. <br>valores permitidos: <code>ted</code> ou <code>boleto</code>

q[dueDateEq]string date

Data de vencimento da cobrança igual a. <br>Formato: <code>YYYY-MM-DD</code>

q[dueDateGt]string date

Data de vencimento da cobrança <b>maior que. </b> <br>Formato: <code>YYYY-MM-DD</code>

q[dueDateLt]string date

Data de vencimento da cobrança <b>menor que. </b> <br>Formato: <code>YYYY-MM-DD</code>

q[yourNumberEq]string

Seu número do boleto bancário igual a.

q[receivedAtEq]string date

Data de liquidação do pagamento da cobrança <b>igual a. </b><br>Formato: <code>YYYY-MM-DD</code>

q[receivedAtGt]string date

Data de liquidação do pagamento da cobrança <b>maior que</b><br>Formato: <code>YYYY-MM-DD</code>

q[receivedAtLt]string date

Data de liquidação do pagamento da cobrança <b>menor que</b> <br>Formato: <code>YYYY-MM-DD</code>

p[page]integer

Número da página que será retornada.

p[per_page]integer

Quantidade de itens que serão retornados por página.

Response

200