5.11. Marcar Parcela como Paga¶

🔗 Endpoint¶

Método	URL
	`/public/v1/nota-comercial/{id}/parcelas/{idParcela}`

🧾 Descrição¶

Registra o pagamento de uma parcela específica de uma Nota Comercial. A parcela deve estar com status Em Aberto (1) ou Vencido (3) para aceitar a marcação.

🔹 Path Parameters¶

Parâmetro	Tipo	Descrição
id	integer	Identificador único da NC
idParcela	integer	Identificador único da parcela

📤 Requisição¶

📋 Payload (JSON)¶

{
  "dataPagamento": "2025-11-01",
  "valorPago": 44753.62
}

🧾 Detalhamento dos Campos¶

Campo	Tipo	Obrigatório	Descrição
dataPagamento	string	Sim	Data em que o pagamento foi realizado (YYYY-MM-DD)
valorPago	number	Sim	Valor efetivamente pago

🧪 Exemplo de cURL¶

curl -X PATCH https://api.vehub.com.br/public/v1/nota-comercial/100/parcelas/201 \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d '{
    "dataPagamento": "2025-11-01",
    "valorPago": 44753.62
  }'

📥 Responses¶

✅ 200 OK¶

{
  "mensagem": "Parcela marcada como paga com sucesso.",
  "idParcela": 201,
  "status": 2,
  "descricaoStatus": "Pago"
}

Campo	Tipo	Descrição
mensagem	string	Confirmação da operação
idParcela	integer	Identificador da parcela atualizada
status	integer	Novo status da parcela
descricaoStatus	string	Descrição do novo status

❌ Erros Comuns¶

400 Bad Request¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "titulo": "Atenção",
  "status": 400,
  "erros": [
    "Campo 'dataPagamento' é obrigatório.",
    "Campo 'valorPago' deve ser um valor positivo.",
    "A parcela já está com status 'Pago' e não pode ser alterada."
  ]
}

404 Not Found¶

{
  "tipo": "https://tools.ietf.org/html/rfc9110#section-15.5.5",
  "titulo": "Não encontrado",
  "status": 404,
  "erros": ["Parcela não encontrada."]
}