Skip to content
API
/
Financeiro
/
v1
/
Busca despesas por filtro

Financeiro (v1)

API para gerenciamento de recursos financeiros

Download OpenAPI description
financial-apis-openapi.json
financial-apis-openapi.yaml
Languages
Servers
Servidor de produção

https://api-v2.contaazul.com/

Mock server

https://developers.contaazul.com/_mock/docs/financial-apis-openapi/

v1

Operações relacionadas a centros de custo

Operations

Procura e retorna os centros de custos

Request

Procura e retorna os centros de custos que atendam às condições do filtro aplicado

Security
BearerAuth
Query
paginanumberrequired

Número da página

Example: pagina=1
tamanho_paginanumberrequired

Tamanho da página

Example: tamanho_pagina=10
buscastring

Busca por nome ou código

Example: busca=010
filtro_rapidostring

Filtro rápido para itens ativos, inativos ou todos.

Enum"ATIVO""INATIVO""TODOS"
Example: filtro_rapido=ATIVO
campo_ordenado_ascendentestring
campo_ordenado_descendentestring
curl -i -X GET \
  'https://api-v2.contaazul.com/v1/centro-de-custo?pagina=1&tamanho_pagina=10&busca=010&filtro_rapido=ATIVO&campo_ordenado_ascendente=string&campo_ordenado_descendente=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista de centros de custo

Bodyapplication/json
itens_totaisinteger
Example: 6
itemsArray of objects(CentroDeCusto)
totaisobject(Totais)
Response
application/json
{
  "itens_totais": 6,
  "items": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}

Cria um novo centro de custo

Request

Cria um novo centro de custo e retorna os detalhes do centro de custo criado.

Security
BearerAuth
Bodyapplication/jsonrequired

Dados do centro de custo a ser criado

codigostring or null

Código do centro de custo

Example: "10"
nomestringrequired

Nome do centro de custo

Example: "Centro de custo do Robinho"
curl -i -X POST \
  https://api-v2.contaazul.com/v1/centro-de-custo \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "codigo": "10",
    "nome": "Centro de custo do Robinho"
  }'

Responses

Centro de custo criado com sucesso

Bodyapplication/json
idstring(uuid)

Identificador único do centro de custo

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
codigostring or null

Código do centro de custo

Example: "10"
nomestring

Nome do centro de custo

Example: "Nome do centro de custo"
ativoboolean

Indica se o centro de custo está ativo

Example: true
Response
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "codigo": "10",
  "nome": "Nome do centro de custo",
  "ativo": true
}

Busca as parcelas de acordo com o id do evento

Request

Retorna as parcelas de acordo com o id do evento informado

Security
BearerAuth
Path
id_eventostringrequired

UUID ou ID legado do evento.

Example: 35473eec-4e74-11ee-b500-9f61de8a8b8b
curl -i -X GET \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/35473eec-4e74-11ee-b500-9f61de8a8b8b/parcelas \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista de Parcelas

Bodyapplication/jsonArray [
eventoobject(Evento)
idstring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)
Example: 1
referenciastring
Example: "Alguma referencia"
indiceinteger(int32)
Example: 1
conciliadoboolean
Example: true
statusstring
Enum"PENDENTE""QUITADO""CANCELADO"
Example: "PENDENTE"
valor_pagonumber(double)
Example: 10
perdaobject(PerdaFinanceira)
nao_pagonumber(double)
Example: 5
data_vencimentostring(date)
Example: "01/01/2030"
data_pagamento_previstostring(date)
Example: "01/01/2030"
descricaostring
Example: "bla bla bla"
notastring
Example: "bla bla bla"
conta_financeiraobject(ContaFinanceira)
id_conta_financeirastring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
valor_composicaoobject(ValorComposicao)
metodo_pagamentostring
Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "DEPOSITO_BANCARIO"
nsustring
Example: "ABC"
baixa_agendadaboolean
Example: false
baixasArray of objects(Baixa)
anexosArray of objects(AnexoParcela)
solicitacoes_cobrancasArray of objects(SolicitacaoCobranca)
id_ultima_solicitacao_pagamentostring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_boleto_bancario_autorizadostring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
faturaobject(Fatura)
valor_total_liquidonumber(double)
Example: 10
id_ultimo_solicitacao_cobrancastring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
]
Response
application/json
[
  {
    "evento": { … },
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "versao": 1,
    "referencia": "Alguma referencia",
    "indice": 1,
    "conciliado": true,
    "status": "PENDENTE",
    "valor_pago": 10,
    "perda": { … },
    "nao_pago": 5,
    "data_vencimento": "01/01/2030",
    "data_pagamento_previsto": "01/01/2030",
    "descricao": "bla bla bla",
    "nota": "bla bla bla",
    "conta_financeira": { … },
    "id_conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "valor_composicao": { … },
    "metodo_pagamento": "DEPOSITO_BANCARIO",
    "nsu": "ABC",
    "baixa_agendada": false,
    "baixas": [ … ],
    "anexos": [ … ],
    "solicitacoes_cobrancas": [ … ],
    "id_ultima_solicitacao_pagamento": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "id_boleto_bancario_autorizado": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "fatura": { … },
    "valor_total_liquido": 10,
    "id_ultimo_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
  }
]

Procura e retorna as categorias

Request

Procura e retorna as categorias que atendam às condições do filtro aplicado

Security
BearerAuth
Query
paginanumberrequired

Número da página

Example: pagina=1
tamanho_paginanumberrequired

Tamanho da página

Example: tamanho_pagina=10
campo_ordenado_ascendentestring

Campo para ordenação ascendente. Use 'NOME' ou 'TIPO'. Se informado ele desconsidera o valor do campo_ordenado_descendente.

Enum"NOME""TIPO"
Example: campo_ordenado_ascendente=NOME
campo_ordenado_descendentestring

Campo para ordenação descendente. Use 'NOME' ou 'TIPO'. Esse valor é ignorado quando o valor do campo_ordenado_ascendente já estiver preenchido.

Enum"NOME""TIPO"
Example: campo_ordenado_descendente=TIPO
buscastring

Busca por nome ou código

Example: busca=010
tipostring

Tipo da categoria

Enum"RECEITA""DESPESA"
Example: tipo=RECEITA
apenas_filhosboolean

Filtrar apenas categorias filhas

Example: apenas_filhos=true
nomestring

Nome da categoria

Example: nome=Nome da Categoria
permite_apenas_filhosbooleanrequired

Permite apenas categorias filhas

Example: permite_apenas_filhos=true
curl -i -X GET \
  'https://api-v2.contaazul.com/v1/categorias?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=NOME&campo_ordenado_descendente=TIPO&busca=010&tipo=RECEITA&apenas_filhos=true&nome=Nome+da+Categoria&permite_apenas_filhos=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista de categorias

Bodyapplication/json
itens_totaisinteger
Example: 6
itensArray of objects(Categoria)
totaisobject(Totais)
Response
application/json
{
  "itens_totais": 6,
  "itens": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}

Buscar contas financeiras

Request

Procura e retorna as contas financeiras que atendam às condições do filtro aplicado

Security
BearerAuth
Query
paginainteger

Número da página

Default 1
Example: pagina=1
tamanho_paginainteger

Tamanho da página

Default 10
Example: tamanho_pagina=10
tiposArray of strings

Lista de tipos de conta

Items Enum"APLICACAO""CAIXINHA""CONTA_CORRENTE""CARTAO_CREDITO""INVESTIMENTO""OUTROS""MEIOS_RECEBIMENTO""POUPANCA""COBRANCAS_CONTA_AZUL""RECEBA_FACIL_CARTAO"
Example: tipos=APLICACAO
nomestring

Nome da conta

Example: nome=Conta do Robinho
apenas_ativoboolean

Filtrar apenas contas ativas

Example: apenas_ativo=true
esconde_conta_digitalboolean

Esconder contas digitais

Example: esconde_conta_digital=true
mostrar_caixinhaboolean

Mostrar contas de caixinha

Example: mostrar_caixinha=true
curl -i -X GET \
  'https://api-v2.contaazul.com/v1/conta-financeira?pagina=1&tamanho_pagina=10&tipos=APLICACAO&nome=Conta+do+Robinho&apenas_ativo=true&esconde_conta_digital=true&mostrar_caixinha=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista de contas financeiras

Bodyapplication/json
itens_totaisinteger
Example: 6
itensArray of objects(ContaFinanceira)
totaisobject(Totais)
Response
application/json
{
  "itens_totais": 6,
  "itens": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}

Cria evento financeiro de conta a receber

Request

Realização a criação do evento financeiro de conta a receber e retorna o protocolo da operação

Security
BearerAuth
Bodyapplication/jsonrequired

Dados do evento financeiro de contas a receber

data_competenciastring(date)required

Data da compentência do evento financeiro é obrigatório.

Example: "2024-07-15"
valornumber(decimal)required

Valor do evento financeiro é obrigatório.

Example: 100
observacaostringrequired

Observação do evento financeiro é obrigatório.

Example: "Observação do evento financeiro"
descricaostringrequired

Descrição do evento financeiro é obrigatório.

Example: "Descriação do evento financeiro"
contatostring(uuid)required

Identificador do negociador é obrigatório.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
conta_financeirastring(uuid)required

Identificador da Conta Financeira é obrigatório.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
rateioArray of objects(CategoriaRateio)
condicao_pagamentoobject(ListaCondicaoPagamento)required
condicao_pagamento.​parcelasArray of objects(ParcelaCondicaoPagamento)required

Lista de parcelas da condição de pagamento

condicao_pagamento.​parcelas[].​descricaostringrequired

A descrição da parcela é obrigatória.

Example: "Descrição da parcela"
condicao_pagamento.​parcelas[].​data_vencimentostring(date)required

A data de vencimento da parcela é obrigatória.

Example: "2024-07-15"
condicao_pagamento.​parcelas[].​notastringrequired

Nota adicional sobre a parcela é obrigatória.

Example: "Nota adicional sobre a parcela"
condicao_pagamento.​parcelas[].​conta_financeirastring(uuid)required

Identificador da conta financeira associada à parcela é obrigatória.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
condicao_pagamento.​parcelas[].​detalhe_valorobject(ComposicaoValor)required
condicao_pagamento.​parcelas[].​detalhe_valor.​multanumber

Valor da multa.

Example: 100.25
condicao_pagamento.​parcelas[].​detalhe_valor.​jurosnumber

Valor dos juros.

Example: 1.5
condicao_pagamento.​parcelas[].​detalhe_valor.​valor_brutonumberrequired

Valor bruto da parcela é obrigatório.

Example: 275.99
condicao_pagamento.​parcelas[].​detalhe_valor.​valor_liquidonumber

Valor líquido da parcela.

Example: 250.33
condicao_pagamento.​parcelas[].​detalhe_valor.​descontonumber

Valor do desconto.

Example: 2.1
condicao_pagamento.​parcelas[].​detalhe_valor.​taxanumber

Valor da taxa.

Example: 4.4
curl -i -X POST \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/contas-a-receber \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data_competencia": "2024-07-15",
    "valor": 100,
    "observacao": "Observação do evento financeiro",
    "descricao": "Descriação do evento financeiro",
    "contato": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "rateio": [
      {
        "id_categoria": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "valor": 100,
        "rateio_centro_custo": [
          {
            "id_centro_custo": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
            "valor": 100
          }
        ]
      }
    ],
    "condicao_pagamento": {
      "parcelas": [
        {
          "descricao": "Descrição da parcela",
          "data_vencimento": "2024-07-15",
          "nota": "Nota adicional sobre a parcela",
          "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
          "detalhe_valor": {
            "multa": 100.25,
            "juros": 1.5,
            "valor_bruto": 275.99,
            "valor_liquido": 250.33,
            "desconto": 2.1,
            "taxa": 4.4
          }
        }
      ]
    }
  }'

Responses

Evento financeiro de conta a receber criado com sucesso

Bodyapplication/json
protocolIdstring(uuid)

Identificador do protocolo

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
statusstring

Status do protocolo

Enum"PENDING""SUCCESS""ERROR"
Example: "SUCCESS"
createdAtstring(date-time)

Data de criação do protocolo

Example: "2024-10-22T14:30:00Z"
Response
application/json
{
  "protocolId": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "status": "SUCCESS",
  "createdAt": "2024-10-22T14:30:00Z"
}

Busca receitas por filtro

Request

Retorna uma lista de lançamentos financeiros baseado nos filtros

Security
BearerAuth
Query
paginainteger>= 1required

Número da página

Default 1
Example: pagina=1
tamanho_paginainteger>= 1required

Número de itens por página

Default 10
Example: tamanho_pagina=10
campo_ordenado_ascendentestring

Campo para ordenação ascendente

Example: campo_ordenado_ascendente=nome
campo_ordenado_descendentestring

Campo para ordenação descendente

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
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

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+Corrente&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&valor_de=100&valor_ate=500&status=ATRASADO&ids_contas_financeiras=string&ids_categorias=string&ids_centros_de_custo=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista de Contas a Receber

Bodyapplication/json
itens_totaisinteger
Example: 6
itensArray of objects(ContaAReceber)
totaisobject(Totais)
Response
application/json
{
  "itens_totais": 6,
  "itens": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}

Cria evento financeiro de conta a pagar

Request

Realização a criação do evento financeiro de conta a pagar e retorna o protocolo da operação

Security
BearerAuth
Bodyapplication/jsonrequired

Dados do evento financeiro de contas a pagar

data_competenciastring(date)required

Data da compentência do evento financeiro é obrigatório.

Example: "2024-07-15"
valornumber(decimal)required

Valor do evento financeiro é obrigatório.

Example: 100
observacaostringrequired

Observação do evento financeiro é obrigatório.

Example: "Observação do evento financeiro"
descricaostringrequired

Descrição do evento financeiro é obrigatório.

Example: "Descriação do evento financeiro"
contatostring(uuid)required

Identificador do negociador é obrigatório.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
conta_financeirastring(uuid)required

Identificador da Conta Financeira é obrigatório.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
rateioArray of objects(CategoriaRateio)
condicao_pagamentoobject(ListaCondicaoPagamento)required
condicao_pagamento.​parcelasArray of objects(ParcelaCondicaoPagamento)required

Lista de parcelas da condição de pagamento

condicao_pagamento.​parcelas[].​descricaostringrequired

A descrição da parcela é obrigatória.

Example: "Descrição da parcela"
condicao_pagamento.​parcelas[].​data_vencimentostring(date)required

A data de vencimento da parcela é obrigatória.

Example: "2024-07-15"
condicao_pagamento.​parcelas[].​notastringrequired

Nota adicional sobre a parcela é obrigatória.

Example: "Nota adicional sobre a parcela"
condicao_pagamento.​parcelas[].​conta_financeirastring(uuid)required

Identificador da conta financeira associada à parcela é obrigatória.

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
condicao_pagamento.​parcelas[].​detalhe_valorobject(ComposicaoValor)required
condicao_pagamento.​parcelas[].​detalhe_valor.​multanumber

Valor da multa.

Example: 100.25
condicao_pagamento.​parcelas[].​detalhe_valor.​jurosnumber

Valor dos juros.

Example: 1.5
condicao_pagamento.​parcelas[].​detalhe_valor.​valor_brutonumberrequired

Valor bruto da parcela é obrigatório.

Example: 275.99
condicao_pagamento.​parcelas[].​detalhe_valor.​valor_liquidonumber

Valor líquido da parcela.

Example: 250.33
condicao_pagamento.​parcelas[].​detalhe_valor.​descontonumber

Valor do desconto.

Example: 2.1
condicao_pagamento.​parcelas[].​detalhe_valor.​taxanumber

Valor da taxa.

Example: 4.4
curl -i -X POST \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/contas-a-pagar \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data_competencia": "2024-07-15",
    "valor": 100,
    "observacao": "Observação do evento financeiro",
    "descricao": "Descriação do evento financeiro",
    "contato": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "rateio": [
      {
        "id_categoria": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
        "valor": 100,
        "rateio_centro_custo": [
          {
            "id_centro_custo": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
            "valor": 100
          }
        ]
      }
    ],
    "condicao_pagamento": {
      "parcelas": [
        {
          "descricao": "Descrição da parcela",
          "data_vencimento": "2024-07-15",
          "nota": "Nota adicional sobre a parcela",
          "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
          "detalhe_valor": {
            "multa": 100.25,
            "juros": 1.5,
            "valor_bruto": 275.99,
            "valor_liquido": 250.33,
            "desconto": 2.1,
            "taxa": 4.4
          }
        }
      ]
    }
  }'

Responses

Evento financeiro de conta a pagar criado com sucesso

Bodyapplication/json
protocolIdstring(uuid)

Identificador do protocolo

Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
statusstring

Status do protocolo

Enum"PENDING""SUCCESS""ERROR"
Example: "SUCCESS"
createdAtstring(date-time)

Data de criação do protocolo

Example: "2024-10-22T14:30:00Z"
Response
application/json
{
  "protocolId": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "status": "SUCCESS",
  "createdAt": "2024-10-22T14:30:00Z"
}

Busca despesas por filtro

Request

Retorna uma lista de lançamentos financeiros baseado nos filtros

Security
BearerAuth
Query
paginainteger>= 1required

Número da página

Default 1
Example: pagina=1
tamanho_paginainteger>= 1required

Número de itens por página

Default 10
Example: tamanho_pagina=10
campo_ordenado_ascendentestring

Se este campo for utilizado, o parâmetro campo_ordenado_descendente será desconsiderado. É possível ordenar por id do centro de custo (ID), pelo código (CODIGO), pelo nome (NOME) e por ativo (ATIVO).

Enum"ID""CODIGO""NOME""ATIVO"
Example: campo_ordenado_ascendente=nome
campo_ordenado_descendentestring

Se este campo for utilizado, o campo campo_ordenado_ascendente não deverá ser informado. É possível ordenar por id do centro de custo (ID), pelo código (CODIGO), pelo nome (NOME) e por ativo (ATIVO).

Enum"ID""CODIGO""NOME""ATIVO"
Example: campo_ordenado_descendente=nome
descricaostring

Descrição da conta

Example: descricao=Conta Corrente
data_vencimento_destring(date)required

Date 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
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

Lista de 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

Example: ids_contas_financeiras=35473eec-4e74-11ee-b500-9f61de8a8b8b
ids_categoriasArray of strings

Lista de IDs de categorias

Example: ids_categorias=35473eec-4e74-11ee-b500-9f61de8a8b8b
ids_centros_de_custoArray of strings

Lista de IDs de centros de custo

Example: ids_centros_de_custo=35473eec-4e74-11ee-b500-9f61de8a8b8b
curl -i -X GET \
  'https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/contas-a-pagar/buscar?pagina=1&tamanho_pagina=10&campo_ordenado_ascendente=nome&campo_ordenado_descendente=nome&descricao=Conta+Corrente&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&valor_de=100&valor_ate=500&status=ATRASADO&ids_contas_financeiras=35473eec-4e74-11ee-b500-9f61de8a8b8b&ids_categorias=35473eec-4e74-11ee-b500-9f61de8a8b8b&ids_centros_de_custo=35473eec-4e74-11ee-b500-9f61de8a8b8b' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Lista de Contas a Pagar

Bodyapplication/json
itens_totaisinteger
Example: 6
itensArray of objects(ContaAPagar)
totaisobject
Response
application/json
{
  "itens_totais": 6,
  "itens": [
    { … }
  ],
  "totais": {
    "ativo": 6,
    "inativo": 0,
    "todos": 6
  }
}

Busca parcela por ID

Request

Retorna as informações de uma parcela específica pelo seu ID.

Security
BearerAuth
Path
idstring(uuid)required

Identificador único da parcela

Example: 9986f173-f531-4660-96ae-04b71c879264
curl -i -X GET \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/parcelas/9986f173-f531-4660-96ae-04b71c879264 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Informações da parcela retornadas com sucesso

Bodyapplication/json
eventoobject(Evento)
idstring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)
Example: 1
referenciastring
Example: "Alguma referencia"
indiceinteger(int32)
Example: 1
conciliadoboolean
Example: true
statusstring
Enum"PENDENTE""QUITADO""CANCELADO"
Example: "PENDENTE"
valor_pagonumber(double)
Example: 10
perdaobject(PerdaFinanceira)
nao_pagonumber(double)
Example: 5
data_vencimentostring(date)
Example: "01/01/2030"
data_pagamento_previstostring(date)
Example: "01/01/2030"
descricaostring
Example: "bla bla bla"
notastring
Example: "bla bla bla"
conta_financeiraobject(ContaFinanceira)
id_conta_financeirastring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
valor_composicaoobject(ValorComposicao)
metodo_pagamentostring
Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "DEPOSITO_BANCARIO"
nsustring
Example: "ABC"
baixa_agendadaboolean
Example: false
baixasArray of objects(Baixa)
anexosArray of objects(AnexoParcela)
solicitacoes_cobrancasArray of objects(SolicitacaoCobranca)
id_ultima_solicitacao_pagamentostring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
id_boleto_bancario_autorizadostring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
faturaobject(Fatura)
valor_total_liquidonumber(double)
Example: 10
id_ultimo_solicitacao_cobrancastring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
Response
application/json
{
  "evento": {
    "data_competencia": "2030-01-01",
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "condicao_pagamento": { … },
    "referencia": { … },
    "agendado": true,
    "tipo": "RECEITA",
    "rateio": [ … ]
  },
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 1,
  "referencia": "Alguma referencia",
  "indice": 1,
  "conciliado": true,
  "status": "PENDENTE",
  "valor_pago": 10,
  "perda": {
    "data": "2024-07-15",
    "valor": 1.99
  },
  "nao_pago": 5,
  "data_vencimento": "01/01/2030",
  "data_pagamento_previsto": "01/01/2030",
  "descricao": "bla bla bla",
  "nota": "bla bla bla",
  "conta_financeira": {
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "banco": "BANCO_BRASIL",
    "codigo_banco": 1,
    "nome": "Nome da Conta",
    "ativo": true,
    "tipo": "APLICACAO",
    "conta_padrao": true,
    "possui_config_boleto_bancario": false,
    "agencia": "001",
    "numero": "123"
  },
  "id_conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "valor_composicao": {
    "multa": 10,
    "juros": 1,
    "valor_bruto": 20,
    "desconto": 0.1,
    "taxa": 0.03,
    "valor_liquido": 9
  },
  "metodo_pagamento": "DEPOSITO_BANCARIO",
  "nsu": "ABC",
  "baixa_agendada": false,
  "baixas": [
    { … }
  ],
  "anexos": [
    { … }
  ],
  "solicitacoes_cobrancas": [
    { … }
  ],
  "id_ultima_solicitacao_pagamento": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "id_boleto_bancario_autorizado": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "fatura": {
    "numero": 123,
    "rps": 1,
    "tipo_fatura": "NFE"
  },
  "valor_total_liquido": 10,
  "id_ultimo_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
}

Atualiza as informações de uma parcela

Request

Atualiza as informações de uma parcela do evento financeiro. - Sempre deverá ser enviado o campo VERSÃO com o valor atualizado do registro. - Não é necessário o envio do objeto inteiro, apenas os campos que serão atualizados.

Security
BearerAuth
Path
idstring(uuid)required
Example: 9986f173-f531-4660-96ae-04b71c879264
Bodyapplication/jsonrequired

Campos aceitos para atualização da parcela

notastring
Example: "Nota da parcela"
descricaostring
Example: "Descrição da parcela"
vencimentostring(date)
Example: "2024-07-15"
composicao_valorobject(ComposicaoValor)
versaointegerrequired

Sempre enviar o valor atual da versão.

Example: 1
data_pagamento_esperadostring(date)
Example: "2024-07-15"
metodo_pagamentostring
Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
perdaobject(PerdaFinanceira)
nsustring
Example: "1029384756"
pagamento_agendadoboolean
Example: false
id_conta_financeirastring(uuid)
Example: "e12a84ed-fb5c-4b8c-af56-4448b947337c"
curl -i -X PATCH \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/parcelas/9986f173-f531-4660-96ae-04b71c879264 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "nota": "Nota da parcela",
    "descricao": "Descrição da parcela",
    "vencimento": "2024-07-15",
    "composicao_valor": {
      "multa": 100.25,
      "juros": 1.5,
      "valor_bruto": 275.99,
      "valor_liquido": 250.33,
      "desconto": 2.1,
      "taxa": 4.4
    },
    "versao": 1,
    "data_pagamento_esperado": "2024-07-15",
    "metodo_pagamento": "CARTAO_CREDITO",
    "perda": {
      "data": "2024-07-15",
      "valor": 1.99
    },
    "nsu": "1029384756",
    "pagamento_agendado": false,
    "id_conta_financeira": "e12a84ed-fb5c-4b8c-af56-4448b947337c"
  }'

Responses

Operação realizada com sucesso

Bodyapplication/json
notastring
Example: "Nota da parcela"
descricaostring
Example: "Descrição da parcela"
vencimentostring(date)
Example: "2024-07-15"
composicao_valorobject(ComposicaoValor)
versaointeger

Nova versão da parcela após salva as alterações.

Example: 1
data_pagamento_esperadostring(date)
Example: "2024-07-15"
metodo_pagamentostring
Enum"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example: "CARTAO_CREDITO"
perdaobject(PerdaFinanceira)
nsustring
Example: "1029384756"
pagamento_agendadoboolean
Example: false
conta_financeiraobject(ParcelaContaFinanceira)
Response
application/json
{
  "nota": "Nota da parcela",
  "descricao": "Descrição da parcela",
  "vencimento": "2024-07-15",
  "composicao_valor": {
    "multa": 100.25,
    "juros": 1.5,
    "valor_bruto": 275.99,
    "valor_liquido": 250.33,
    "desconto": 2.1,
    "taxa": 4.4
  },
  "versao": 1,
  "data_pagamento_esperado": "2024-07-15",
  "metodo_pagamento": "CARTAO_CREDITO",
  "perda": {
    "data": "2024-07-15",
    "valor": 1.99
  },
  "nsu": "1029384756",
  "pagamento_agendado": false,
  "conta_financeira": {
    "id": "6bac0a7f-0422-48a9-86ea-0b1f0a6f9db9",
    "versao": 1,
    "nome": "Nome do banco",
    "agencia": "001",
    "numero": "123",
    "tipo": "OUTROS",
    "banco": "OUTROS"
  }
}