Skip to navigation
Integrações privadasComercialCadastros comerciais

Listar motivos de cancelamento comercial

View as Markdown

Lista os motivos de cancelamento comercial disponíveis para oportunidade, venda ou ambos.

Uso comum:

  • justificar cancelamentos em venda e oportunidade;
  • padronizar relatórios de perda;
  • alimentar automações dependentes da causa do cancelamento.

Exemplo de uso:

GET {{base_url}}/simplificav2/motivo_cancelamento?q={"ativo":"S"}
Authorization: Bearer {{bearer_token}}
Accept: application/json

Authentication

AuthorizationBearer

Token privado usado para consultar dados da plataforma.

Como usar:

  • obtenha o token privado da sua empresa;
  • envie Authorization: Bearer SEU_TOKEN_PRIVADO;
  • não use x-api-key neste módulo.

Query parameters

offsetintegerOptional>=0

Quantos registros pular antes de começar a resposta.

limitintegerOptional>=1

Quantidade máxima de registros por resposta.

Observação:

  • informe limit explicitamente quando quiser controlar a quantidade por resposta.
qstringOptional

Filtro opcional para restringir, combinar ou ordenar os resultados.

Se você não enviar q, o endpoint retorna a listagem padrão daquele recurso.

Quando precisar filtrar, o q recebe um JSON no padrão FilterObject do ORDS.

Regras práticas:

  • comece testando o endpoint sem filtro;
  • use os nomes de coluna publicados naquele endpoint;
  • use sempre o nome do campo exatamente como ele aparece no schema do endpoint;
  • offset e limit não entram dentro do q;
  • em clientes HTTP fora do Postman, o conteúdo normalmente precisa ser enviado URL-encoded;
  • no Postman, prefira informar o valor na aba Params.

Operadores úteis:

  • $or
  • $between
  • $orderby
  • $date
  • $ne, $lt, $lte, $gt, $gte
  • $instr, $ninstr
  • $notnull

Exemplos legíveis:

  • {"id":162472}
  • {"ativo":"S"}
  • {"receita_recorrente_id":{"$notnull":null}}
  • {"status":"ABERTO","$orderby":{"data_vencimento":"ASC"}}
  • {"criado_em":{"$between":[{"$date":"2026-03-01T00:00:00Z"},{"$date":"2026-03-31T23:59:59Z"}]}}

Os mesmos exemplos prontos para URL:

  • %7B%22id%22%3A162472%7D
  • %7B%22ativo%22%3A%22S%22%7D
  • %7B%22receita_recorrente_id%22%3A%7B%22%24notnull%22%3Anull%7D%7D
  • %7B%22status%22%3A%22ABERTO%22%2C%22%24orderby%22%3A%7B%22data_vencimento%22%3A%22ASC%22%7D%7D
  • %7B%22criado_em%22%3A%7B%22%24between%22%3A%5B%7B%22%24date%22%3A%222026-03-01T00%3A00%3A00Z%22%7D%2C%7B%22%24date%22%3A%222026-03-31T23%3A59%3A59Z%22%7D%5D%7D%7D

Response

Coleção paginada de motivos de cancelamento.

countinteger
hasMoreboolean
limitinteger
offsetinteger
itemslist of objectsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error