Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Lotes

Altera lote de pagamentos de comissão

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

A interface viabiliza a alteração de lote do sistema CV. A requisição cria o lote no CVCRM com os pagamentos das comissões, se não enviar os pagamentos irá inserir todos os pagamentos da comissão que não esteja num lote.

put/v1/financeiro/lotes/{idLote}/alterar

Path parameters

idLoteinteger required
Example:1

Identificador do lote de pagamento.

Headers

emailstring required
Example:email@email.com
tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Request body

situacao_lotestring string

Situação do Lote (Programado, Cancelado, Pago)

nota_fiscalstring string

Nota fiscal do lote de pagamentos

observacaostring string

Observação do lote de pagamentos.

descricaostring string

Descrição do lote de pagamentos

nomestring string

Nome de exibição do lote de pagamentos

Example request

{
  "situacao_lote": "Programado",
  "nota_fiscal": "nota 123",
  "observacao": "Lote de pagamento com finadade tal",
  "descricao": "Descrição do lote",
  "nome": "Nome de exibição do lote"
}

Response

Lote alterado com sucesso.

idLotestring

Retorna o identificador do lote cadastrado

sucessoboolean

Example response

{
  "idLote": 12340,
  "sucesso": true
}