Boleto

Salva os boletos para o Portal do cliente

🔒 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)

Interface responsável salvar boletos para exibição no Portal do Cliente.

post/v1/financeiro/boletos

Request

  • Base URL
    https://integracao.cvcrm.com.br/api
  • URL
    https://integracao.cvcrm.com.br/api/v1/financeiro/boletos
  • Auth
    none declared. Required headers: email, token

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 multipart/form-data

idreservainteger required

Identificador da reserva no CV.

codigointerno_reservastring required

Caso não possua o idreserva utilizar este campo.

vencimentostring required

Data do vencimento do boleto.

tipostring required

Tipo do boleto: Ato, Mensal, Anual, etc.

valorstring required

Valor do boleto.

linha_digitavelstring required

Linha digitável do boleto, enviar apenas os numeros.

codigointernostring required

Código identificador do boleto para nos informar futuramente se o boleto foi compensado ou não no upload.

titulostring

Título para o boleto.

arquivostring required

Binário do arquivo no upload de boleto.

Example request

{
  "idreserva": 123,
  "codigointerno_reserva": "5458954",
  "vencimento": "2023-05-01",
  "tipo": "Ato",
  "valor": "1999.99",
  "linha_digitavel": "00190500954014481606906809350314337370000000100",
  "codigointerno": "BOL01",
  "arquivo": "JVBERi0xLjcKCjQgMCBvYmoKPDwKL0xpTm1ldGF0aW9uIC9EZXZpY2VJbmZvIDw8IC..."
}

Response

Operação realizada com sucesso no post de boletos.

sucessoboolean
idinteger

Example response

{
  "sucesso": true,
  "id": 400
}

Changes

No recorded changes to this operation across all 1 revision of this API.