v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Tipos de Arquivos de Pagamento Comissão

Recupera a lista de tipos de arquivos de pagamento de comissões

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

Esta rota permite consultar e recuperar uma lista paginada de tipos de arquivos de pagamento de comissões registrados no sistema CVCRM.

Os tipos de arquivos são utilizados para categorizar os documentos anexados aos pagamentos de comissões.

get/v3/configuracoes/tipos-arquivos-pagamentos-comissoes

Query parameters

paginainteger

Example:1

Página que deseja visualizar os registros.

registros_por_paginainteger

Example:30

Quantidade de registro por página, máximo 500 registros.

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

Operação realizada com sucesso.

statusstring

codeinteger

Example response

{
  "status": "sucesso",
  "code": 200,
  "pagination": {
    "pagina": 1,
    "registros": 5,
    "totalRegistros": 5,
    "totalPaginas": 1
  },
  "order": {
    "campo": "idtipo",
    "valor": "DESC"
  },
  "data": [
    {
      "idtipo": 1,
      "nome": "Nota Fiscal",
      "obrigatorioWorkflow": true,
      "tipoPessoa": "Física",
      "dataCad": "2022-01-01 00:00:00",
      "ativoPainel": true
    }
  ]
}