v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Mensagens da comissão

Retorna o arquivo de uma mensagem da 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)

Api responsável por retornar o arquivo de uma mensagem da comissão

get/v3/financeiro/comissoes/{idComissao}/mensagens/{idMensagem}/arquivos/{idArquivo}

Path parameters

idComissaointeger required

Example:7367

Identificador da comissão.

idMensageminteger required

Example:7367

Identificador da mensagem.

idArquivointeger required

Example:7367

Identificador do arquivo.

Query parameters

acao'link' | 'base64' | 'download'

Example:link

Define a forma como o arquivo será retornado pela API:

link → retorna o body padrão da requisição acrescido de um campo contendo a URL para download do arquivo.
base64 → retorna o body padrão da requisição acrescido de um campo contendo o conteúdo do arquivo em Base64.
download → retorna diretamente o binário do arquivo. Nesse caso não há body no retorno, apenas o próprio arquivo.

Response

Arquivo da mensagem da comissão retornada com sucesso.

statusstring required

Situação da requisição

codeinteger required

Código da requisição

Example response

{
  "status": "success",
  "code": 200,
  "data": {
    "idarquivo": 123,
    "dataCad": "2022-03-28 20:35:57",
    "nome": "teste.pdf",
    "arquivo": "https://integracao.cvcrm.com.br/api/get/download/temp/comissoes_mensagens_arquivos/teste.pdf"
  }
}