Retornar as receitas por filtro

Request

Permite consultar as parcelas de receitas (contas a receber) mediante filtros como data de vencimento, data de competência, data de pagamento, data de alteração, valor, status, dentre outros. Essa funcionalidade ajuda no controle e análise de entradas financeiras com base nas condições definidas.

Security

BearerAuth

Query

paginainteger, >= 1required

Página

Default:1

Example:pagina=1

tamanho_paginainteger, >= 1required

Tamanho da página

Enum:1020501002005001000

Example:tamanho_pagina=10

campo_ordenado_ascendentestring

Campo para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por nome

Example:campo_ordenado_ascendente=nome

campo_ordenado_descendentestring

Campo para ordenação descendente. Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar por nome

Example:campo_ordenado_descendente=nome

descricaostring

Descrição da conta

Example:descricao=Conta Corrente

data_vencimento_destring, (date)required

Data de vencimento de (ISO date format)

Example:data_vencimento_de=2027-08-15

data_vencimento_atestring, (date)required

Data de vencimento até (ISO date format)

Example:data_vencimento_ate=2027-08-20

data_competencia_destring, (date)

Data de competência de (ISO date format)

Example:data_competencia_de=2025-08-15

data_competencia_atestring, (date)

Data de competência até (ISO date format)

Example:data_competencia_ate=2025-08-20

data_pagamento_destring, (date)

Data de pagamento de (ISO date format)

Example:data_pagamento_de=2025-08-15

data_pagamento_atestring, (date)

Data de pagamento até (ISO date format)

Example:data_pagamento_ate=2025-08-20

data_alteracao_destring, (date-time)

Data de alteração de (ISO 8601, São Paulo/GMT-3)

Example:data_alteracao_de=2025-10-20T07:00:00

data_alteracao_atestring, (date-time)

Data de alteração até (ISO 8601, São Paulo/GMT-3)

Example:data_alteracao_ate=2025-10-20T07:59:59

valor_destring^[0-9]+(\.[0-9]{1,2})?$

Valor de

Example:valor_de=100

valor_atestring^[0-9]+(\.[0-9]{1,2})?$

Valor até

Example:valor_ate=500

statusArray of strings

Status da conta

Items Enum:"PERDIDO""RECEBIDO""EM_ABERTO""RENEGOCIADO""RECEBIDO_PARCIAL""ATRASADO"

Example:status=ATRASADO

ids_contas_financeirasArray of strings

Lista de IDs de contas financeiras

ids_categoriasArray of strings

Lista de IDs de categorias

ids_centros_de_custoArray of strings

Lista de IDs de centros de custo

ids_clientesArray of strings

Lista de IDs de clientes

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/contas-a-receber/buscar?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=nome&campo_ordenado_descendente=nome&descricao=Conta%20Corrente&data_vencimento_de=2027-08-15&data_vencimento_ate=2027-08-20&data_competencia_de=2025-08-15&data_competencia_ate=2025-08-20&data_pagamento_de=2025-08-15&data_pagamento_ate=2025-08-20&data_alteracao_de=2025-10-20T07%3A00%3A00&data_alteracao_ate=2025-10-20T07%3A59%3A59&valor_de=100&valor_ate=500&status=ATRASADO&ids_contas_financeiras=string&ids_categorias=string&ids_centros_de_custo=string&ids_clientes=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json

itens_totaisinteger

Example:6

itensArray of objects(ContaAReceber)

totaisobject(Totais)

Response

{
  "itens_totais": 6,
  "itens": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}