Árvore de páginas

Versões comparadas

Chave

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

...

Realizar a inclusão de Pessoa.

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Pessoa

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 do Corpo (Body Parameters)

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information

)idPessoaCódigo da pessoaInteger($int64

)

Não há

VersaoVersão da pessoaInteger($int64)Não há
NomeRazaoSocialRazão SocialString
Não há
Obrigatório.
FantasiaNome fantasiaStringNão há
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 (Opções: A -
ATIVO Valores permitidos 
Ativo / I
-INATIVO) Valores nulos/vazios são considerados como Ativos String
- Inativo / P - Prospect / O - Outros) StringObrigatório, valores permitidos
AI
 ou nulo.IdCidadeCódigo da cidadeInteger($int64)Não há
, P, O.
NomeCidadeNome da cidadeStringNão há
UFCidadeEstadoStringNão há
PaisCidadePaísStringNão há
CodigoMunicipioCódigo do municípioInteger($int64)Não há
IdBairro
CodigoPaisCódigo do
bairro
país.Integer($int64)Não há
NomeBairroNome do bairroStringNão há
IdLogradouro
TipoLogradouro
Código
Tipo do logradouro
. (Rua, avenida, etc.)String
Integer($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á
NumeroCPFCNPJNúmero do CPF ou CNPJ sem dígitoInteger($int64)Não há
DigitoCPFCNPJDígito do CPF ou CNPJInteger($int64)Não há
InscricaoEstadualRGNumero da inscrição estadualStringNão há
EmailE-mailStringNão há
HomePageSiteStringNão há
EstadoCivilEstado CivilStringNão há
ContribuinteIcmsIdentificador de Contribuinte ICMS (Opções: S - Sim / N - Não)StringValores permitidos SN ou nulo.
ProdutorRuralIdentificador de Produtor Rural (Opções: S - Sim / N - Não)StringValores permitidos SN ou nulo.
MicroEmpresaIdentificador de Micro Empresa (Opções: S - Sim / N - Não)StringValores 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 (Opções: S - Sim / N - Nã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)

...