v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Pagamentos

Cadastra um pagamento para uma comissão

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Cria um pagamento vinculado à comissão informada.

post/v3/financeiro/comissoes/{idComissao}/pagamentos

Path parameters

idComissaointeger required

Example:7367

Identificador da comissão.

Request body

valornumber float required

Valor do pagamento

dataPagamentostring required

Data do pagamento

idregrainteger required

ID da regra de comissão

idsituacaointeger required

ID da situação do pagamento

notaFiscalstring nullable

Nota fiscal

dataMedicaostring nullable

Data de medição

observacoesstring nullable

Observações sobre o pagamento

formaPagamentostring required

Sigla da forma de pagamento

Example request

{
  "valor": 1500,
  "dataPagamento": "2025-01-05",
  "idregra": 1,
  "idsituacao": 1,
  "notaFiscal": "NF-001234",
  "dataMedicao": "2025-01-01",
  "observacoes": "Pagamento referente à primeira parcela",
  "formaPagamento": "PIX"
}

Response

Pagamento criado com sucesso

successboolean

Example response

{
  "success": true,
  "data": {
    "idpagamento": 1
  }
}