Skip to content
API
/
Financeiro
/
/v1

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

Conjunto de recursos para acompanhar e administrar as finanças da empresa - esses recursos incluem centros de custo, parcelas, categorias, categorias dre, contas financeiras e movimentações (contas a pagar e a receber)

Operations

Retornar os centros de custo por filtro

Request

Retorna os centros de custo cadastrados que atendam às condições do filtro aplicado - utilizados para classificar lançamentos financeiros e facilitar o controle e análise de pagamentos e recebimentos

Security
BearerAuth
Query
paginanumberrequired

Página

Example: pagina=1
tamanho_paginanumberrequired

Tamanho da página

Example: tamanho_pagina=10
buscastring

Busca textual 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 para ordenação ascendente. Se informado ele desconsidera o valor do campo_ordenado_descendente. É possível ordenar por nome ou por código

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 ou por código

Example: campo_ordenado_descendente=nome
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=nome&campo_ordenado_descendente=nome' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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

Criar 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: "1040"
nomestringrequired

Nome do centro de custo

Example: "Contabilidade"
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": "1040",
    "nome": "Contabilidade"
  }'

Responses

OK

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: "1040"
nomestring

Nome do centro de custo

Example: "Contabilidade"
ativoboolean

Indica se o centro de custo está ativo

Example: true
Response
application/json
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "codigo": "1040",
  "nome": "Contabilidade",
  "ativo": true
}

Retornar as parcelas pelo id do evento financeiro

Request

Retorna as parcelas de acordo com o id do evento financeiro 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

OK

Bodyapplication/jsonArray [
eventoobject(Evento)
idstring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger(int64)
Example: 1
referenciastring
Example: "5b04139f-fcca-4c64-8d01-1dd568eb420e"
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: "2025-09-05"
data_pagamento_previstostring(date)
Example: "2025-09-05"
descricaostring
Example: "Parcela do evento financeiro de contas a pagar"
notastring
Example: "A data de pagamento prevista é para 01/01/2030"
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: "000215783210"
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)
data_alteracaostring(date-time)
Example: "2025-10-22T08:37:05"
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": "5b04139f-fcca-4c64-8d01-1dd568eb420e",
    "indice": 1,
    "conciliado": true,
    "status": "PENDENTE",
    "valor_pago": 10,
    "perda": { … },
    "nao_pago": 5,
    "data_vencimento": "2025-09-05",
    "data_pagamento_previsto": "2025-09-05",
    "descricao": "Parcela do evento financeiro de contas a pagar",
    "nota": "A data de pagamento prevista é para 01/01/2030",
    "conta_financeira": { … },
    "id_conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "valor_composicao": { … },
    "metodo_pagamento": "DEPOSITO_BANCARIO",
    "nsu": "000215783210",
    "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": { … },
    "data_alteracao": "2025-10-22T08:37:05",
    "valor_total_liquido": 10,
    "id_ultimo_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
  }
]

Retornar as categorias por filtro

Request

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

Security
BearerAuth
Query
paginanumberrequired

Página

Example: pagina=1
tamanho_paginanumberrequired

Tamanho da página

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' ou 'TIPO'

Enum"NOME""TIPO"
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' ou 'TIPO'

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

Busca textual 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=Eletrônicos
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=Eletr%C3%B4nicos&permite_apenas_filhos=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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

Retornar as categorias DRE

Request

Este endpoint permite listar a estrutura completa de categorias da Demonstração do Resultado do Exercício (DRE), composta por categorias principais e subcategorias hierárquicas

Security
BearerAuth
curl -i -X GET \
  https://api-v2.contaazul.com/v1/financeiro/categorias-dre \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
itensArray of objects(CategoriaDRE)

Lista principal de itens da DRE

Response
application/json
{
  "itens": [
    { … }
  ]
}

Retornar as contas financeiras por filtro

Request

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

Security
BearerAuth
Query
paginainteger

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 corrente
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+corrente&apenas_ativo=true&esconde_conta_digital=true&mostrar_caixinha=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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

Retornar o saldo atual pelo id da conta financeira

Request

Este endpoint tem como objetivo disponibilizar, de forma simples e direta, o saldo atual de uma conta financeira específica, identificada pelo seu id_conta_financeira

Security
BearerAuth
Path
id_conta_financeirastringrequired

uuid da conta financeira

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

Responses

OK

Bodyapplication/json
saldo_atualnumber(double)
Example: 1000.36
Response
application/json
{
  "saldo_atual": 1000.36
}

Criar um novo evento financeiro de contas a receber

Request

Cria o evento financeiro de contas 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 competência do evento financeiro

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

Valor do evento financeiro

Example: 100
observacaostringrequired

Observação do evento financeiro

Example: "Evento financeiro no valor de R$100,00"
descricaostringrequired

Descrição do evento financeiro

Example: "Prestação de serviço"
contatostring(uuid)required

Identificador do negociador

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

Identificador da Conta Financeira

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

Descrição da parcela

Example: "Mensalidade (2/6)"
condicao_pagamento.​parcelas[].​data_vencimentostring(date)required

Data de vencimento da parcela

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

Nota adicional sobre a parcela

Example: "Pagamento realizado via PIX"
condicao_pagamento.​parcelas[].​conta_financeirastring(uuid)required

Identificador da conta financeira associada à parcela

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

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": "Evento financeiro no valor de R$100,00",
    "descricao": "Prestação de serviço",
    "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": "Mensalidade (2/6)",
          "data_vencimento": "2024-07-15",
          "nota": "Pagamento realizado via PIX",
          "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 contas 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"
}

Retornar as receitas por filtro

Request

Retorna uma lista de lançamentos financeiros baseado nos filtros

Security
BearerAuth
Query
paginainteger>= 1required

Página

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

Tamanho da página

Default 10
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 alteracao de (ISO 8601 date-time format)

Example: data_alteracao_de=2025-10-20T07:00:00
data_alteracao_atestring(date-time)

Data de alteracao até (ISO 8601 date-time format)

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

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&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' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

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

Criar um novo evento financeiro de contas a pagar

Request

Cria o evento financeiro de contas 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 competência do evento financeiro

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

Valor do evento financeiro

Example: 100
observacaostringrequired

Observação do evento financeiro

Example: "Evento financeiro no valor de R$100,00"
descricaostringrequired

Descrição do evento financeiro

Example: "Prestação de serviço"
contatostring(uuid)required

Identificador do negociador

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

Identificador da Conta Financeira

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

Descrição da parcela

Example: "Mensalidade (2/6)"
condicao_pagamento.​parcelas[].​data_vencimentostring(date)required

Data de vencimento da parcela

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

Nota adicional sobre a parcela

Example: "Pagamento realizado via PIX"
condicao_pagamento.​parcelas[].​conta_financeirastring(uuid)required

Identificador da conta financeira associada à parcela

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

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": "Evento financeiro no valor de R$100,00",
    "descricao": "Prestação de serviço",
    "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": "Mensalidade (2/6)",
          "data_vencimento": "2024-07-15",
          "nota": "Pagamento realizado via PIX",
          "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"
}

Retornar as despesas por filtro

Request

Retorna uma lista de lançamentos financeiros baseado nos filtros

Security
BearerAuth
Query
paginainteger>= 1required

Página

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

Tamanho da página

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

Campo para ordenação descendente. 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) ou por ativo (ATIVO)

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

Descrição da conta

Example: descricao=Pagamento do salário
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
data_alteracao_destring(date-time)

Data de alteracao de (ISO 8601 date-time format)

Example: data_alteracao_de=2025-10-20T07:00:00
data_alteracao_atestring(date-time)

Data de alteracao até (ISO 8601 date-time format)

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

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=Pagamento+do+sal%C3%A1rio&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=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

OK

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

Retornar a 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: "5b04139f-fcca-4c64-8d01-1dd568eb420e"
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: "2025-09-05"
data_pagamento_previstostring(date)
Example: "2025-09-05"
descricaostring
Example: "Parcela do evento financeiro de contas a pagar"
notastring
Example: "A data de pagamento prevista é para 01/01/2030"
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: "000215783210"
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)
data_alteracaostring(date-time)
Example: "2025-10-22T08:37:05"
valor_total_liquidonumber(double)
Example: 10
id_ultimo_solicitacao_cobrancastring(uuid)
Example: "35473eec-4e74-11ee-b500-9f61de8a8b8b"
Response
application/json
{
  "evento": {
    "data_competencia": "2025-06-11",
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "condicao_pagamento": { … },
    "referencia": { … },
    "agendado": true,
    "tipo": "RECEITA",
    "rateio": [ … ]
  },
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 1,
  "referencia": "5b04139f-fcca-4c64-8d01-1dd568eb420e",
  "indice": 1,
  "conciliado": true,
  "status": "PENDENTE",
  "valor_pago": 10,
  "perda": {
    "data": "2024-07-15",
    "valor": 1.99
  },
  "nao_pago": 5,
  "data_vencimento": "2025-09-05",
  "data_pagamento_previsto": "2025-09-05",
  "descricao": "Parcela do evento financeiro de contas a pagar",
  "nota": "A data de pagamento prevista é para 01/01/2030",
  "conta_financeira": {
    "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "banco": "BANCO_BRASIL",
    "codigo_banco": 1,
    "nome": "Conta Corrente",
    "ativo": true,
    "tipo": "APLICACAO",
    "conta_padrao": true,
    "possui_config_boleto_bancario": false,
    "agencia": "001",
    "numero": "31"
  },
  "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": "000215783210",
  "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"
  },
  "data_alteracao": "2025-10-22T08:37:05",
  "valor_total_liquido": 10,
  "id_ultimo_solicitacao_cobranca": "35473eec-4e74-11ee-b500-9f61de8a8b8b"
}

Atualizar parcialmente uma parcela por id

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

Nota da parcela

Example: "Pgto 3/5"
descricaostring

Descrição da parcela

Example: "Valor líquido referente ao serviço prestado"
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": "Pgto 3/5",
    "descricao": "Valor líquido referente ao serviço prestado",
    "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

OK

Bodyapplication/json
notastring

Nota da parcela

Example: "Pgto 3/5"
descricaostring

Descrição da parcela

Example: "Valor líquido referente ao serviço prestado"
vencimentostring(date)
Example: "2024-07-15"
composicao_valorobject(ComposicaoValor)
versaointeger

Nova versão da parcela após salvar 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": "Pgto 3/5",
  "descricao": "Valor líquido referente ao serviço prestado",
  "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": "Conta Corrente",
    "agencia": "001",
    "numero": "123",
    "tipo": "OUTROS",
    "banco": "OUTROS"
  }
}