...
Realizar a inclusão de Pessoa.
Atenção antes de realizar um cadastro de pessoa através da API é necessário que o endereço completo esteja cadastrado, ou seja, cidade, bairro, logradouro devem estar previamente cadastrados no banco.
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) |
|---|
idPessoa | Código da pessoaInteger($int64) | Não há | | Versao | Versão da pessoa | Integer($int64) | Não há |
| NomeRazaoSocial | Razão Social | String |
Não há| Obrigatório. |
| Fantasia | Nome fantasia | String | Não há |
| Tipo | Física ou Jurídica (Opções: F - Física / J - Jurídica) | String | Valores permitidos F, J ou nulo. |
| Sexo | Sexo (Opções: M - Masculino / F - Feminino) | String | Não há |
| Status | Status da pessoa (Opções: A - |
ATIVO Valores permitidos -INATIVO) Valores nulos/vazios são considerados como Ativos String | | - Inativo / P - Prospect / O - Outros) | String | Obrigatório, valores permitidos |
ou nuloIdCidadeCódigo Integer($int64) | Não há | NomeCidade | Nome da cidade | | String | Será usado o menor Identificador(SEQCIDADE), caso hajam cidades com nomes iguais na mesma UF. |
| UFCidade | Estado | String | Não há |
UFCidadeEstadoPaisCidadePaís | String| Código do município | Integer($int64) | Não há |
IdBairro bairro| país. | Integer($int64) | Não há |
| NomeBairro | Nome do bairro | String | Não há |
IdLogradouroCódigo Integer($int64| . (Rua, avenida, etc.) | String | Não há |
| DescricaoLogradouro | Nome do logradouro | String | Não há |
| NumeroLogradouro | Número do logradouro | String | Não há |
| ComplementoLogradouro | Complemento do logradouro | String | Não há |
| CEP | Código postal | String | Não há |
| TelefoneDDD1 | DDD do primeiro telefone | String | Não há |
| TelefoneNumero1 | Numero do primeiro telefone | String | Não há |
| TelefoneComplemento1 | Complemento do primeiro telefone | String | Não há |
| TelefoneDDD2 | DDD do segundo telefone | String | Não há |
| TelefoneNumero2 | Numero do segundo telefone | String | Não há |
| TelefoneComplemento2 | Complemento do segundo telefone | String | Não há |
| TelefoneDDD3 | DDD do terceiro telefone | String | Não há |
| TelefoneNumero3 | Numero do terceiro telefone | String | Não há |
| TelefoneComplemento3 | Complemento do terceiro telefone | String | Não há |
| NumeroCPFCNPJ | Número do CPF ou CNPJ sem dígito |
Integer($int64)| String | Não há |
| DigitoCPFCNPJ | Dígito do CPF ou CNPJ | Integer($int64) | Não há |
| InscricaoEstadualRG | Numero da inscrição estadual | String | Não há |
| Email | E-mail | String | Não há |
| HomePage | Site | String | Não há |
| EstadoCivil | Estado Civil | String | Não há |
| ContribuinteIcms | Identificador de Contribuinte ICMS (Opções: S - Sim / N - Não) | String | Valores permitidos S, N ou nulo. |
| ProdutorRural | Identificador de Produtor Rural (Opções: S - Sim / N - Não) | String | Valores permitidos S, N ou nulo. |
| MicroEmpresa | Identificador de Micro Empresa (Opções: S - Sim / N - Não) | String | Valores permitidos S, N ou nulo. |
| InscricaoProdutorRural | Inscrição de produtor rural | String | Não há |
| NumeroCNPJProdutorRural | Número do CNPJ de produtor rural sem dígito |
Integer($int64)| String | Não há |
| DigitoCNPJProdutorRural | Dígito do CNPJ | Integer($int64) | Não há |
| ProdutorRuralComCPF | Identificador de Produtor Rural Com CPF (Opções: S - Sim / N - Não) | String | Valores permitidos S, N ou nulo. |
| NumeroCPFProdutorRural | Número do CPF de produtor rural sem dígito | Integer($int64) | Não há |
| DigitoCPFProdutorRural | Dígito do CPF | Integer($int64) | Não há |
Informações para Resposta (Response Information)
...
| Bloco de código |
|---|
|
{
"statusexpandables": [
"string"
],
"versao": 99,
"nomeRazaoSocial": "string",
"fantasia": "string",
"versaotipo": 0"s",
"sexo": "s",
"fantasiastatus": "strings",
"tiponomeCidade": "string",
"ufCidade": "st",
"sexopaisCidade": "string",
"codigoMunicipio": 99999,
"idCidadecodigoPais": 099999,
"nomeBairro": "string",
"nomeCidadetipoLogradouro": "string",
"descricaoLogradouro": "string",
"ufCidadenumeroLogradouro": "string",
"complementoLogradouro": "string",
"paisCidadecep": "string",
"telefoneDDD1": "strin",
"idBairrotelefoneNumero1": 0"string",
"nomeBairrotelefoneComplemento1": "string",
"telefoneDDD2": "strin",
"idLogradourotelefoneNumero2": 0"string",
"descricaoLogradourotelefoneComplemento2": "string",
"telefoneDDD3": "strin",
"numeroLogradourotelefoneNumero3": "string",
"telefoneComplemento3": "string",
"complementoLogradouronumeroCPFCNPJ": "string",
"digitoCPFCNPJ": 99,
"cepinscricaoEstadualRG": "string",
"telefoneDDD1email": "string",
"telefoneNumero1homePage": "string",
"estadoCivil": "s",
"telefoneComplemento1contribuinteICMS": "strings",
"produtorRural": "s",
"numeroCPFCNPJmicroEmpresa": "strings",
"digitoCPFCNPJinscricaoProdutorRural": "string",
"emailnumeroCNPJProdutorRural": "string",
"digitoCNPJProdutorRural": 99,
"homePageprodutorRuralComCPF": "strings",
"numeroCPFProdutorRural": 9999999999999,
"contribuinteICMSdigitoCPFProdutorRural": "string"999
} |
application/json, text/json
...