v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Mensagens da comissão

Retorna os arquivos 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 os arquivos de uma mensagem da comissão

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

Path parameters

idComissaointeger required
Example:7367

Identificador da comissão.

idMensageminteger required
Example:7367

Identificador da mensagem.

Query parameters

sortstring
Example:idusuario

Informa o campo a ser ordenado.

order'ASC' | 'DESC'

Informa a ordem da classificação.

search[operador|campo]string
Example:14

Informa o termo para busca.

  • Operadores suportados:
    • equal → igual
    • notEqual → diferente
    • greaterThan → maior que
    • greaterThanOrEqual → maior ou igual a
    • lessThan → menor que
    • lessThanOrEqual → menor ou igual a
    • in → dentro de lista de valores (passar valores separados por vírgula)
    • notIn → fora de lista de valores (passar valores separados por vírgula)
    • like → contém o valor informado

Response

Arquivos 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,
  "pagination": {
    "pagina": 1,
    "registros": 3,
    "totalRegistros": 3,
    "totalPaginas": 1
  },
  "filter": [
    {
      "campo": "idusuario",
      "valor": "14"
    }
  ],
  "order": {
    "campo": "idusuario",
    "valor": "ASC"
  },
  "data": [
    {
      "idarquivo": 123,
      "dataCad": "2022-03-28 20:35:57",
      "nome": "teste.pdf"
    }
  ]
}