Incluir NCM - POST

Objetivo

Realizar a inclusão do NCM.

Chamada

POST [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

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

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

Parâmetros URI (URI Parameters)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
codNcm	Código do NCM	String	Não há
descricao	Descrição do NCM	String	Não há
descReduzida	Descrição reduzida do NCM	String	Não há
perImpostoImport	Alíquota de Imposto de Importação	Number($double)	Não há
aliquotaIpi	Alíquota IPI	Number($double)	Não há
indControlePf	Gera Arquivo Magnético DPF	String	Não há
codTipiNcm	Código TIPI do NCM	Integer($int64)	Não há
indPermExcecao	Permite Informar uma Exceção	String	Não há
status	Status do NCM (A-ATIVO / I-INATIVO - Obs: Valores nulos/vazios são considerados como Ativos)	String	Não há
dtaInicioVigencia	Data inicial do período de vigência	String ($date-time)	Não há
dtaFimVigencia	Data final do período de vigência	String ($date-time)	Não há
indSubIcmsDifDi	Deduz o valor do ICMS diferido com o ICMS próprio na geração do valor do item (Nota de Importação)	String	Valores permitidos S, N ou nulo.

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

{
  "codNcm": "string",
  "descricao": "string",
  "descReduzida": "string",
  "perImpostoImport": 0,
  "aliquotaIpi": 0,
  "indControlePf": "string",
  "codTabGenero": "string",
  "codTipiNcm": 0,
  "indPermExcecao": "string",
  "status": "string",
  "dtaInicioVigencia": "2021-07-12T16:41:56.506Z",
  "dtaFimVigencia": "2021-07-12T16:41:56.506Z",
  "usuarioAlteracao": "string",
  "indSubIcmsDifDi": "string",
  "dtaAlteracao": "2021-07-12T16:41:56.506Z"
}

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
    }
  ]
}

Árvore de páginas