Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Séries de Tabelas de Preços

Cadastro de Séries de Tabelas de Preços

🔒 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 o cadastro, a modificação e a remoção de uma série de tabela de preço no sistema CV. Verificando se o dado inserido no campo 'idserie_int' é compatível com algum código interno de uma série já cadastrada no CV, se não existir vai ocorrer a ação de cadastro, caso contrário vai ocorrer a ação de modificação. Para remover é preciso preencher o campo 'remover' com o código interno da série que deseja inativar.

post/v1/comercial/seriestabeladepreco

Headers

emailstring required
Example:email@email.com

Email de autenticação no CV

tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação no CV

Request body

nomestring required

Nome da série.

siglastring

Sigla da série.

disponivelstring

Disponibilidade da série (Ativo ou Inativo).

tipo_distanciastring required

Tipo de distância Dia(s): D, Semana(s): S, Mês(es): M ou Ano(s): A.

tamanho_distanciastring required

Quantidade da distância.

contrato_forastring required

Informa se a série poderá ser retirada do contrato. Sim: S ou Não: N

comissaostring required

Informa se a série será incluída no cálculo da comissão. Sim: S ou Não: N

financiamentostring required

Informa se a série será incluída no cálculo do repasse. Sim: S ou Não: N

data_vencimento_contratostring required

Informa se a data de vencimento será exibida nos locais de exibição desta série. Sim: S ou Não: N

atostring

Informa se a série é de Ato (Caso a geração de boletos esteja habilitada será possível gerar boletos para essa série). Sim: S ou Não: N

idserie_intstring

Identificador da série no sistema legado (código interno).

exibir_vencimentostring required

Informe se a data de vencimento será incluída no contrato. Sim: S ou Não: N

removerstring

Código interno da série que deseja remover. Informar esse campo apenas se desejar remover a série.

idindexadorinteger

Identificador do indexador da série

idportadorinteger

Identificador do portador da série

forma_pagamentostring

Sigla da forma de pagamento da série

Example request

{
  "nome": "Série A3",
  "sigla": "SA",
  "disponivel": "Ativo",
  "tipo_distancia": "M",
  "tamanho_distancia": "1",
  "contrato_fora": "N",
  "comissao": "N",
  "financiamento": "S",
  "data_vencimento_contrato": "N",
  "ato": "N",
  "idserie_int": "956",
  "exibir_vencimento": "N",
  "remover": "0",
  "idindexador": 1,
  "idportador": 1,
  "forma_pagamento": "BO"
}

Response

Operação realizada com sucesso.

codigostring string
mensagemstring string

Example response

{
  "codigo": "200",
  "mensagem": "Operação realizada com sucesso."
}