Receivable
Find receivables by query filters.
Find receivables by query filters.
- Retrieve receivables based on query parameters
- Recuperar recebíveis com base nos parâmetros de consulta
get/receivables
Query parameters
statusstring[]
- One or more Status of the receivable
- Um ou mais Status de oferta
card_networkstring[]
- One or more CardNetwork of the receivable
- Uma ou mais Bandeira do recebível
issuerstring[]
- One or more Issuer name
- Um ou mais Nome de emissor
acquirerinteger[]
- One or more Acquirer ID of the receivable
- Um ou mais ID do Adquirente do recebível
investorinteger[]
- One or more Investor ID of the receivable
- Um ou mais ID do Investidor do recebível
offer_idinteger
- OfferID of the receivable
- ID da Oferta vinculada ao recebível
simulation_idinteger
- SimulationID of the receivable
- ID da Simulação da oferta vinculada ao recebível
created_greater_or_equal_thanstring
- Created date greater or equal to (YYYY-MM-DD)
- Data de criação maior ou igual a (AAAA-MM-DD)
created_less_or_equal_thanstring
- Created date less or equal to (YYYY-MM-DD)
- Data de criação menor ou igual a (AAAA-MM-DD)
due_date_greater_or_equal_thanstring
- Due Date date greater or equal to (YYYY-MM-DD)
- Data de vencimento maior ou igual a (AAAA-MM-DD)
due_date_less_or_equal_thanstring
- Due Date date less or equal to (YYYY-MM-DD)
- Data de vencimento menor ou igual a (AAAA-MM-DD)
Response
List of users matching the filters | Lista de recebíveis que correspondem aos filtros
Example response
{
"limit": 10,
"page": 1,
"rows": [
{
"card_network": "MASTERCARD",
"company_id": 10,
"compound_key": "teste H/MASTERCARD/Emissor1/2025-02-05 00:00:00 -0300 -03/Installment",
"created_at": "2025-01-29T11:00:25.734265-03:00",
"due_date": "2025-02-05T00:00:00-03:00",
"issuer": "Emissor1",
"spreadsheet_id": 5,
"status": "EXPIRED",
"transactions_number": 37,
"transactions_number_available": 37,
"value": 31200,
"value_available": 31200
}
],
"sort": "created_at desc",
"total_pages": 1,
"total_rows": 1
}