v1
latestOpenAPI 3.1.02026-07-24890394.2 KBListar cobranças disponíveis
este recurso retorna uma lista com todas as cobranças disponíveis para captura.
get/concessions/assignors/{assignor_id}/charges
Path parameters
assignor_idstring required
Id do cedente.
Query parameters
q[dueDateEq]string date
Data de vencimento dos títulos igual a.
q[dueDateGt]string date
Data de vencimento dos títulos maior que.
q[dueDateLt]string date
Data de vencimento dos títulos menor que.
q[ourNumberEq]string
Nosso Número da cobrança igual a.
q[ourNumberGt]string
Nosso Número da cobrança maior que.
q[ourNumberLt]string
Nosso Número da cobrança menor que.
q[yourNumberEq]string
Seu Número da cobrança igual a.
q[paymentMethodEq]'boleto' | 'pix' | 'ted'
Forma de pagamento dos títulos igual a.
q[valueEq]number double
Valor dos títulos igual a.
q[valueGt]number double
Valor dos títulos maiores que.
q[valueLt]number double
Valor dos títulos menores que.
q[receiptNumberEq]integer
Número da nota fiscal igual a.
q[nameEq]string
Razão social ou Nome do pagador igual a.
q[documentNumberEq]integer
CNPJ ou CPF do pagador igual a.
p[page]integer
Página que será carregada.
p[per_page]integer
Quantidade de itens que serão retornados por página.
Response
200
Example response
{
"data": {
"id": "d8d74d12-88db-4b51-a6ca-6ac7bdd6cc23",
"type": "charge",
"attributes": [
{
"createdAt": "2021-01-01T00:00:00.000-03:00",
"updatedAt": "2021-01-01T00:00:00.000-03:00",
"status": "pending",
"paymentMethod": "boleto",
"dueDate": "2021-01-01T00:00:00.000-03:00",
"value": "20.0",
"payer": {
"data": {
"type": "payer",
"attributes": {
"name": "Grafeno Digital",
"documentNumber": "05944596991300",
"email": "your_email@grafeno.digital"
}
}
},
"clientControlNumber": "001-2",
"origin": "unknown",
"receiptNumber": "51080701212344000127550010000000981364117781",
"expiresAfter": 90
}
]
},
"meta": {
"search": {
"filteredFieldEq": "grafeno"
},
"currentPage": 2,
"previousPage": 1,
"nextPage": 3,
"totalPages": 5,
"perPage": 10,
"totalCount": 250
}
}