Obtenha uma lista de transações financeiras
Retorna lista de transações financeiras com diversos filtros opcionais incluindo informações de processos, clientes, datas e dados financeiros.
Como funcionam os filtros:
- Múltiplos filtros são combinados com AND (interseção)
- Filtros de texto como
responsible,customer_name,debit_bankedescriptionsão busca parcial (case-insensitive) - Filtros como
lawsuit_id,category,cost_centersão busca exata - Filtros de data funcionam como range (use _start e _end juntos)
A resposta inclui totalCount, limit, offset e array data com as transações.
Authorization
BearerAuth In: header
Query Parameters
[Optional] ID exato do processo associado à transação.
[Optional] Busca parcial na categoria da transação. Case-insensitive. Exemplos: ALUGUEL, HONORÁRIOS, ENERGIA.
[Optional] Busca parcial no nome do responsável. Case-insensitive.
[Optional] Busca parcial no nome do cliente. Case-insensitive.
[Optional] Busca parcial no banco de débito. Case-insensitive.
[Optional] Busca parcial no centro de custo. Case-insensitive.
[Optional] Busca parcial na descrição da transação. Case-insensitive.
[Optional] Número exato do processo associado à transação (ex: 5003807-92.2020.8.24.0067). Busca exata - não aceita busca parcial.
[Optional] Número do protocolo associado à transação.
[Optional] CPF ou CNPJ do cliente. IMPORTANTE: Validação obrigatória - deve ser CPF/CNPJ válido, caso contrário retorna erro Invalid identification.
^([0-9]{3}\.?[0-9]{3}\.?[0-9]{3}-?[0-9]{2}|[0-9]{2}\.?[0-9]{3}\.?[0-9]{3}/?[0-9]{4}-?[0-9]{2})$[Optional] Data inicial para filtrar por data de criação (formato: YYYY-MM-DD). Deve ser usado junto com created_end.
date[Optional] Data final para filtrar por data de criação (formato: YYYY-MM-DD). Deve ser usado junto com created_start.
date[Optional] Data inicial para filtrar por data de vencimento (formato: YYYY-MM-DD). Deve ser usado junto com date_due_end.
date[Optional] Data final para filtrar por data de vencimento (formato: YYYY-MM-DD). Deve ser usado junto com date_due_start.
date[Optional] Data inicial para filtrar por data de pagamento (formato: YYYY-MM-DD). Deve ser usado junto com date_payment_end.
date[Optional] Data final para filtrar por data de pagamento (formato: YYYY-MM-DD). Deve ser usado junto com date_payment_start.
date[Optional] Data inicial para filtrar por competência (formato: YYYY-MM-DD). Deve ser usado junto com competence_end.
date[Optional] Data final para filtrar por competência (formato: YYYY-MM-DD). Deve ser usado junto com competence_start.
dateResponse Body
application/json
application/json
application/json
curl -X GET "https://app.advbox.com.br/api/v1/transactions"{
"totalCount": 150,
"limit": 1000,
"offset": 0,
"data": [
{
"id": 12345678,
"type": "income",
"date_due": "2025-04-30",
"date_payment": null,
"competence": "04/2025",
"amount": 7000,
"description": null,
"responsible": "João Silva",
"category": "HONORÁRIOS DE PARCEIROS",
"lawsuit_id": null,
"process_number": null,
"protocol_number": null,
"name": null,
"identification": null,
"debit_bank": "CONTA PRINCIPAL",
"credit_bank": null,
"cost_center": "GERAL"
},
{
"id": 12345679,
"type": "income",
"date_due": "2025-05-30",
"date_payment": "2025-05-30",
"competence": "05/2025",
"amount": 1000,
"description": null,
"responsible": "Maria Santos",
"category": "ALVARÁS",
"lawsuit_id": 12345,
"process_number": null,
"protocol_number": null,
"name": "Cliente Exemplo",
"identification": null,
"debit_bank": "CONTA PRINCIPAL",
"credit_bank": null,
"cost_center": "GERAL"
},
{
"id": 12345680,
"type": "expense",
"date_due": "2025-05-31",
"date_payment": null,
"competence": "05/2025",
"amount": 1000,
"description": "SALA 1234",
"responsible": "Pedro Oliveira",
"category": "ALUGUEL",
"lawsuit_id": null,
"process_number": null,
"protocol_number": null,
"name": null,
"identification": null,
"debit_bank": "CONTA PRINCIPAL",
"credit_bank": null,
"cost_center": "GERAL"
}
]
}{
"error": "Invalid identification."
}{
"error": "Unauthenticated."
}