Atualizar parcialmente uma parcela por id

Request

Permite atualizar parcialmente uma parcela existente identificada pelo id, alterando campos como data de vencimento, valor, observações, conta financeira e outros campos permitidos. Essa operação ajuda a ajustar lançamentos financeiros sem a necessidade de recriá-los.

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

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