Árvore de páginas

Versões comparadas

Chave

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

Objetivo

Realizar a inclusão do NCMde Pessoa.

Chamada

POST /api/v1/NcmPessoa

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

...

Parâmetros do Corpo (Body Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

codNcm
idPessoaCódigo
do NCM
da pessoaInteger($int64)Não há
VersaoVersão da pessoaInteger($int64)
String
Não há
descricaoDescrição do NCM
NomeRazaoSocialRazão SocialStringNão há
descReduzidaDescrição reduzida do NCM
FantasiaNome fantasiaStringNão há
perImpostoImportAlíquota de Imposto de ImportaçãoNumber($double)Não háaliquotaIpiAlíquota IPINumber($double)Não háindControlePfGera Arquivo Magnético DPF
TipoFísica ou Jurídica  (Opções: F - Física / J - Jurídica)StringValores permitidos FJ ou nulo.
SexoSexo (Opções: M - Masculino / F - Feminino)StringNão há
StatusStatus da pessoa (A-ATIVO / I-INATIVO) Valores nulos/vazios são considerados como Ativos StringValores permitidos AI ou nulo.
IdCidadeCódigo da cidadeInteger($int64)Não há
NomeCidadeNome da cidadeStringNão há
UFCidadeEstadoStringNão há
PaisCidadePaísStringNão há
codTipiNcm
IdBairroCódigo
TIPI
do
NCM
bairroInteger($int64)Não há
indPermExcecaoPermite Informar uma Exceção
NomeBairroNome do bairroStringNão há
status
IdLogradouro
Status
Código do
NCM (A-ATIVO / I-INATIVO - Obs: Valores nulos/vazios são considerados como Ativos)
logradouroInteger($int64)Não há
DescricaoLogradouroNome do logradouroStringNão há
NumeroLogradouroNúmero do logradouroStringNão há
ComplementoLogradouroComplemento do logradouroStringNão há
CEPCódigo postalStringNão há
TelefoneDDD1DDD do primeiro telefoneStringNão há
TelefoneNumero1Numero do primeiro telefoneStringNão há
TelefoneComplemento1Complemento do primeiro telefoneStringNão há
TelefoneDDD2DDD do segundo telefoneStringNão há
TelefoneNumero2Numero do segundo telefoneStringNão há
TelefoneComplemento2Complemento do segundo telefoneStringNão há
TelefoneDDD3DDD do terceiro telefoneStringNão há
TelefoneNumero3Numero do terceiro telefoneStringNão há
TelefoneComplemento3Complemento do terceiro telefoneStringNão há
dtaInicioVigencia
NumeroCPFCNPJ
Data inicial do período de vigênciaString ($date-time
Número do CPF ou CNPJ sem dígitoInteger($int64)Não há
dtaFimVigencia
DigitoCPFCNPJ
Data final do período de vigência
Dígito do CPF ou CNPJInteger($int64)Não há
InscricaoEstadualRGNumero da inscrição estadualStringNão há
EmailE-mailStringNão há
HomePageSiteStringNão há
EstadoCivilEstado CivilString
String ($date-time)
Não há
indSubIcmsDifDi
ContribuinteIcmsIdentificador de Contribuinte ICMSStringValores permitidos SN ou nulo.
ProdutorRuralIdentificador de Produtor RuralStringValores permitidos SN ou nulo.
MicroEmpresaIdentificador de Micro EmpresaStringValores permitidos SN ou nulo.
InscricaoProdutorRuralInscrição de produtor ruralStringNão há
NumeroCNPJProdutorRuralNúmero do CNPJ de produtor rural sem dígitoInteger($int64)Não há
DigitoCNPJProdutorRuralDígito do CNPJInteger($int64)Não há
ProdutorRuralComCPFIdentificador de Produtor Rural Com CPF
Deduz o valor do ICMS diferido com o ICMS próprio na geração do valor do item (Nota de Importação)
StringValores permitidos SN ou nulo.
NumeroCPFProdutorRuralNúmero do CPF de produtor rural sem dígitoInteger($int64)Não há
DigitoCPFProdutorRuralDígito do CPFInteger($int64)Não há

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • Success (200201)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

...

Bloco de código
languageactionscript3
{
    "status": "string",
    "nomeRazaoSocial": "string",
    "versao": 0,
    "codNcmfantasia": "string",
    "descricaotipo": "string",
    "descReduzidasexo": "string",
    "perImpostoImportidCidade": 0,
    "aliquotaIpinomeCidade": 0"string",
    "indControlePfufCidade": "string",
    "codTabGeneropaisCidade": "string",
    "codTipiNcmidBairro": 0,
    "indPermExcecaonomeBairro": "string",
    "idLogradouro": 0,
    "statusdescricaoLogradouro": "string",
    "dtaInicioVigencianumeroLogradouro": "2021-07-12T16:41:56.506Z",
  "dtaFimVigencia": "2021-07-12T16:41:56.506Zstring",
    "complementoLogradouro": "string",
    "cep": "string",
    "telefoneDDD1": "string",
    "telefoneNumero1": "string",
    "telefoneComplemento1": "string",
    "usuarioAlteracaonumeroCPFCNPJ": "string",
    "indSubIcmsDifDidigitoCPFCNPJ": "string",
    "dtaAlteracaoemail": "2021-07-12T16:41:56.506Z"string",
    "homePage": "string",
    "contribuinteICMS": "string"
}

application/json, text/json

...