API ADVBOX
Transactions

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_bank, description, category e cost_center são busca parcial (case-insensitive)
  • Filtros como lawsuit_id, process_number são busca exata
  • Filtros de data funcionam como range (use _start e _end juntos)
  • competence_start/end usa formato MM/YYYY (ex: 03/2026), diferente dos demais filtros de data

A resposta inclui totalCount, limit, offset e array data com as transações.

GET
/transactions

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

lawsuit_id?integer

[Optional] ID exato do processo associado à transação.

category?string

[Optional] Busca parcial na categoria da transação. Case-insensitive. Exemplos: ALUGUEL, HONORÁRIOS, ENERGIA.

responsible?string

[Optional] Busca parcial no nome do responsável. Case-insensitive.

customer_name?string

[Optional] Busca parcial no nome do cliente. Case-insensitive.

debit_bank?string

[Optional] Busca parcial no banco de débito. Case-insensitive.

cost_center?string

[Optional] Busca parcial no centro de custo. Case-insensitive.

description?string

[Optional] Busca parcial na descrição da transação. Case-insensitive.

process_number?string

[Optional] Número exato do processo associado à transação (ex: 5003807-92.2020.8.24.0067). Busca exata - não aceita busca parcial.

protocol_number?string

[Optional] Número do protocolo associado à transação.

customer_identification?string

[Optional] CPF ou CNPJ do cliente. IMPORTANTE: Validação obrigatória - deve ser CPF/CNPJ válido, caso contrário retorna erro Invalid identification.

Match^([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})$
created_start?string

[Optional] Data inicial para filtrar por data de criação (formato: YYYY-MM-DD). Deve ser usado junto com created_end.

Formatdate
created_end?string

[Optional] Data final para filtrar por data de criação (formato: YYYY-MM-DD). Deve ser usado junto com created_start.

Formatdate
date_due_start?string

[Optional] Data inicial para filtrar por data de vencimento (formato: YYYY-MM-DD). Deve ser usado junto com date_due_end.

Formatdate
date_due_end?string

[Optional] Data final para filtrar por data de vencimento (formato: YYYY-MM-DD). Deve ser usado junto com date_due_start.

Formatdate
date_payment_start?string

[Optional] Data inicial para filtrar por data de pagamento (formato: YYYY-MM-DD). Deve ser usado junto com date_payment_end.

Formatdate
date_payment_end?string

[Optional] Data final para filtrar por data de pagamento (formato: YYYY-MM-DD). Deve ser usado junto com date_payment_start.

Formatdate
competence_start?string

[Optional] Competência inicial para filtrar (formato: MM/YYYY, ex: 03/2026). Deve ser usado junto com competence_end.

Match^(0[1-9]|1[0-2])/\d{4}$
competence_end?string

[Optional] Competência final para filtrar (formato: MM/YYYY, ex: 03/2026). Deve ser usado junto com competence_start.

Match^(0[1-9]|1[0-2])/\d{4}$

Response Body

application/json

application/json

application/json

curl -X GET "https://app.advbox.com.br/api/v1/transactions"

{
  "offset": 0,
  "limit": 1000,
  "totalCount": 42,
  "data": [
    {
      "id": 5000001,
      "entry_type": "income",
      "date_due": "2026-04-30",
      "date_payment": null,
      "competence": "04/2026",
      "amount": 5000,
      "description": "HONORARIOS CONTRATUAIS",
      "responsible": "MARIA SILVA",
      "category": "HONORARIOS INICIAIS",
      "lawsuit_id": 1234501,
      "process_number": "0001234-56.2026.5.15.0001",
      "protocol_number": null,
      "name": "JOAO PEREIRA",
      "identification": "111.222.333-44",
      "debit_bank": "CONTA PRINCIPAL",
      "credit_bank": null,
      "cost_center": "GERAL"
    },
    {
      "id": 5000002,
      "entry_type": "expense",
      "date_due": "2026-04-15",
      "date_payment": "2026-04-15",
      "competence": "04/2026",
      "amount": 350,
      "description": null,
      "responsible": "CARLOS SOUZA",
      "category": "CUSTAS PROCESSUAIS",
      "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."
}