5.10. Fluxo de Pagamento¶

🔗 Endpoint¶

Método	URL
	`/public/v1/nota-comercial/{id}/fluxo-pagamento`

🧾 Descrição¶

Retorna o fluxo de pagamento completo de uma Nota Comercial, com todas as parcelas detalhadas por número, data de vencimento, saldo devedor, amortização, juros e status.

🔹 Path Parameter¶

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

🧪 Exemplo de cURL¶

curl -X GET https://api.vehub.com.br/public/v1/nota-comercial/100/fluxo-pagamento \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}"

📥 Responses¶

✅ 200 OK¶

[
  {
    "id": 201,
    "numero": 1,
    "dataVencimento": "2025-11-01",
    "diasPeriodo": 31,
    "saldoDevedor": 500000.00,
    "amortizacao": 38503.62,
    "juros": 6250.00,
    "valor": 44753.62,
    "taxaPeriodo": 1.25,
    "status": 2,
    "descricaoStatus": "Pago",
    "dataPagamento": "2025-11-01",
    "valorPago": 44753.62
  },
  {
    "id": 202,
    "numero": 2,
    "dataVencimento": "2025-12-01",
    "diasPeriodo": 30,
    "saldoDevedor": 461496.38,
    "amortizacao": 38984.92,
    "juros": 5768.70,
    "valor": 44753.62,
    "taxaPeriodo": 1.25,
    "status": 1,
    "descricaoStatus": "Em Aberto",
    "dataPagamento": null,
    "valorPago": null
  }
]

Detalhamento dos Campos¶

Campo	Tipo	Descrição
id	integer	Identificador único da parcela
numero	integer	Número sequencial da parcela
dataVencimento	string	Data de vencimento (YYYY-MM-DD)
diasPeriodo	integer	Número de dias no período
saldoDevedor	number	Saldo devedor no início do período
amortizacao	number	Valor de amortização do principal
juros	number	Valor de juros do período
valor	number	Valor total da parcela
taxaPeriodo	number	Taxa aplicada no período (%)
status	integer	Status da parcela (ver Enumerações)
descricaoStatus	string	Descrição do status
dataPagamento	string \| null	Data do pagamento realizado (YYYY-MM-DD)
valorPago	number \| null	Valor efetivamente pago

Status das Parcelas¶

Código	Descrição
`1`	Em Aberto
`2`	Pago
`3`	Vencido
`4`	Em Processo de Antecipação
`5`	Vencido (Não Pago)
`6`	Cancelado

❌ Erros Comuns¶

404 Not Found¶

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