Skip to content
API/
Financeiro
/
/v1

v1

Conjunto de recursos para acompanhar e administrar operações relacionadas ao gerenciamento de baixas - esses recursos incluem criar uma nova baixa, retornar as baixas pelo id da parcela, atualizar parcialmente uma baixa por id, deletar baixa por id e retornar a baixa por id

Operations

Criar uma nova baixa

Request

Permite registrar uma nova baixa vinculada a uma parcela específica. Por meio desse endpoint, é possível informar os dados do pagamento, como data, valor, juros, multa, descontos e método de pagamento. Ao registrar a baixa, o sistema atualiza automaticamente o status da parcela refletindo a quitação realizada.

Security
BearerAuth
Path
parcela_idstring, (uuid)required
Example:35473eec-4e74-11ee-b500-9f61de8a8b8b
Bodyapplication/jsonrequired
data_pagamentostring, (date)required

Data do pagamento

Example:"2023-10-01"
composicao_valorobject(ValorComposicaoDTO)required
conta_financeirastring, (uuid)required

Identificador único da conta financeira

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

Método de pagamento

Enum:"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example:"CARTAO_CREDITO"
observacaostring

Observação

Example:"Pagamento referente à fatura #1234."
nsustring

Número sequencial único

Example:"1234567890"
curl -i -X POST \
  https://api-v2.contaazul.com/v1/financeiro/eventos-financeiros/parcelas/35473eec-4e74-11ee-b500-9f61de8a8b8b/baixa \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "data_pagamento": "2023-10-01",
    "composicao_valor": {
      "multa": 5,
      "juros": 2.5,
      "valor_bruto": 150,
      "desconto": 10,
      "taxa": 3.75
    },
    "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
    "metodo_pagamento": "CARTAO_CREDITO",
    "observacao": "Pagamento referente à fatura #1234.",
    "nsu": "1234567890"
  }'

Responses

OK

Bodyapplication/json
idstring, (uuid)

Identificador único gerado automaticamente após a criação

Example:"35473eec-4e74-11ee-b500-9f61de8a8b8b"
versaointeger, (int64)

Versão da baixa

Example:1
data_pagamentostring, (date)

Data do pagamento

Example:"2023-10-01"
composicao_valorobject(ValorComposicaoDTO)
conta_financeirastring, (uuid)

Identificador único da conta financeira

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

Método de pagamento

Enum:"DINHEIRO""CARTAO_CREDITO""BOLETO_BANCARIO""CARTAO_CREDITO_VIA_LINK""CHEQUE""CARTAO_DEBITO""TRANSFERENCIA_BANCARIA""OUTRO""CARTEIRA_DIGITAL""CASHBACK"
Example:"CARTAO_CREDITO"
observacaostring

Observação

Example:"Pagamento referente à fatura #1234."
nsustring

Número sequencial único

Example:"1234567890"
Response
{
  "id": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "versao": 1,
  "data_pagamento": "2023-10-01",
  "composicao_valor": {
    "multa": 5,
    "juros": 2.5,
    "valor_bruto": 150,
    "desconto": 10,
    "taxa": 3.75
  },
  "conta_financeira": "35473eec-4e74-11ee-b500-9f61de8a8b8b",
  "metodo_pagamento": "CARTAO_CREDITO",
  "observacao": "Pagamento referente à fatura #1234.",
  "nsu": "1234567890"
}