Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

Incluir Realizar a inclusão do NCM.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Ncm/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 


Image Added

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)

codNcmCódigo do NCMStringNão há
descricaoDescrição do NCMStringNão há
descReduzidaDescrição reduzida do NCMStringNão há
perImpostoImportAlíquota de Imposto de ImportaçãoNumber(
$double
$double)Não há
aliquotaIpiAlíquota IPINumber(
$double
$double)Não há
indControlePfGera Arquivo Magnético DPFStringNão há
codTipiNcm
Cód.
Código TIPI do NCMInteger(
$int64
$int64)Não há
indPermExcecaoPermite Informar uma ExceçãoStringNão há
statusStatus do NCM (A-ATIVO / I-INATIVO -
OBS
Obs: Valores nulos/vazios são
tratados
considerados como Ativos)StringNão há
dtaInicioVigenciaData inicial do período de vigênciaString (
$date
$date-time)Não há
dtaFimVigenciaData final do período de vigênciaString (
$date
$date-time)Não há
indSubIcmsDifDiDeduz o valor do ICMS diferido com o ICMS próprio na geração do valor do item (Nota de Importação)String
Não há
Valores permitidos SN ou nulo.

Informações para Resposta (Response Information)

...

Bloco de código
languageactionscript3
{
  "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

Bloco de código
languageactionscript3
{
  "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
    }
  ]
}

...