Consultar NCM - GET

Objetivo

Consultar os NCMs cadastrados.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Ncm

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Comercial Web> API Cadastros Estruturais > API Cadastros Estruturais

Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

• Success (200)
• BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "hasNext": true,
  "items": [
    {
      "codNcm": "string",
      "descricao": "string",
      "descReduzida": "string",
      "perImpostoImport": 0,
      "aliquotaIpi": 0,
      "indControlePf": "string",
      "codTabGenero": "string",
      "codTipiNcm": 0,
      "indPermExcecao": "string",
      "status": "string",
      "dtaInicioVigencia": "2021-07-14T12:45:49.286Z",
      "dtaFimVigencia": "2021-07-14T12:45:49.286Z",
      "usuarioAlteracao": "string",
      "indSubIcmsDifDi": "string",
      "dtaAlteracao": "2021-07-14T12:45:49.286Z"
    }
  ]
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}