Skip to content

Criar um novo evento financeiro de contas a receber

Request

Security
BearerAuth
Bodyapplication/jsonrequired

Dados do evento financeiro a ser criado

condicao_pagamentoobject(CondicaoPagamento)required

Condição de pagamento do evento financeiro

conta_financeirastringrequired

ID da conta financeira

Example:"c89475a2-bdf9-4e6b-ae5b-5a8e96cab946"
data_competenciastringrequired

Data de competência do evento financeiro

Example:"2025-01-01"
descricaostringrequired

Descrição do evento financeiro

Example:"Conta a receber - Cliente X"
id_clientestringrequired

ID do cliente

Example:"c89475a2-bdf9-4e6b-ae5b-5a8e96cab946"
observacaostring

Observação do evento financeiro

Example:"Observação"
rateioArray of objects(Rateio)required

Rateio das categorias do evento financeiro

referencia_externastring

Referência externa do evento financeiro

Example:"5b04139f-fcca-4c64-8d01-1dd568eb420e"
valornumber, >= 0required

Valor do evento financeiro (deve ser maior que zero)

Example:100
curl -i -X POST \
  https://api-v2.contaazul.com/v1/financeiro/contas-a-receber \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "condicao_pagamento": {
      "parcelas": [
        {
          "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
          "data_vencimento": "2025-01-01",
          "descricao": "Parcela 1",
          "detalhe_valor": {
            "desconto": 0,
            "juros": 0,
            "multa": 0,
            "taxa": 0,
            "valor_bruto": 100
          },
          "metodo_pagamento": "CARTAO_CREDITO",
          "nota": "Pagamento referente à fatura"
        }
      ]
    },
    "conta_financeira": "c89475a2-bdf9-4e6b-ae5b-5a8e96cab946",
    "data_competencia": "2025-01-01",
    "descricao": "Conta a receber - Cliente X",
    "id_cliente": "c89475a2-bdf9-4e6b-ae5b-5a8e96cab946",
    "observacao": "Observação",
    "rateio": [
      {
        "id_categoria": "937f6d29-3b2c-4eee-9778-29e54606f8b5",
        "rateio_centro_custo": [
          {
            "id_centro_custo": "bbe8049e-71df-4bf7-91f8-3b14ac5a6cdc",
            "valor": 100
          }
        ],
        "valor": 100
      }
    ],
    "referencia_externa": "5b04139f-fcca-4c64-8d01-1dd568eb420e",
    "valor": 100
  }'

Responses

Created

Bodyapplication/json
agendadoboolean

se o evento financeiro é agendado

Example:true
condicao_pagamentoobject(EventoFinanceiroCriadoCondicaoPagamento)

condição de pagamento do evento financeiro

data_competenciastring

data de competência do evento financeiro

Example:"2025-07-23"
descricaostring

descrição do evento financeiro

Example:"Descrição do evento"
idstring

id do evento financeiro

Example:"9e4bb72d-f6f6-4fbf-9ca9-5e444e0c2e39"
id_clientestring

id do cliente do evento financeiro caso receita

Example:"f91047eb-2cff-4546-80e3-0f2b54d2cce0"
id_fornecedorstring

id do fornecedor do evento financeiro caso despesa

Example:"fda2f85c-ecd1-4cf1-9d0b-170c54b4cb3e"
id_recorrenciastring

id da recorrência do evento financeiro

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

índice da recorrência do evento financeiro

Example:1
observacaostring

observação do evento financeiro

Example:"Observação do evento"
rateioArray of objects(EventoFinanceiroCriadoRateioCategoria)

rateio do evento financeiro

referenciaobject(EventoFinanceiroCriadoReferencia)

referência do evento financeiro

referencia_externastring

referência externa do evento financeiro

Example:"5b04139f-fcca-4c64-8d01-1dd568eb420e"
tipostring(TipoDeCategoriaFinanceira)

tipo do evento financeiro

Enum:"RECEITA""DESPESA"
Example:"DESPESA"
valornumber

valor do evento financeiro

Example:100
versaointeger

versão do evento financeiro

Example:1
Response
{ "agendado": true, "condicao_pagamento": { "parcelas": [ … ], "quantidade_parcelas": 1 }, "data_competencia": "2025-07-23", "descricao": "Descrição do evento", "id": "9e4bb72d-f6f6-4fbf-9ca9-5e444e0c2e39", "id_cliente": "f91047eb-2cff-4546-80e3-0f2b54d2cce0", "id_fornecedor": "fda2f85c-ecd1-4cf1-9d0b-170c54b4cb3e", "id_recorrencia": "35473eec-4e74-11ee-b500-9f61de8a8b8b", "indice_recorrencia": 1, "observacao": "Observação do evento", "rateio": [ { … } ], "referencia": { "id": "9e4bb72d-f6f6-4fbf-9ca9-5e444e0c2e39", "origem": "LANCAMENTO_FINANCEIRO", "revisao": 1 }, "referencia_externa": "5b04139f-fcca-4c64-8d01-1dd568eb420e", "tipo": "DESPESA", "valor": 100, "versao": 1 }