Incluir Pessoa - POST

Objetivo

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

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)
Versao	Versão da pessoa	Integer($int64)	Não há
NomeRazaoSocial	Razão Social	String	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 / I - Inativo / P - Prospect / O - Outros)	String	Obrigatório, valores permitidos A, I, P, O.
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á
PaisCidade	País	String	Não há
CodigoMunicipio	Código do município	Integer($int64)	Não há
CodigoPais	Código do país.	Integer($int64)	Não há
NomeBairro	Nome do bairro	String	Não há
TipoLogradouro	Tipo do logradouro. (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)	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)	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)

Códigos do Recurso (Response Codes)

Success (201)
BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
    "status": "string",
    "nomeRazaoSocial": "string",
    "versao": 0,
    "fantasia": "string",
    "tipo": "string",
    "sexo": "string",
    "idCidade": 0,
    "nomeCidade": "string",
    "ufCidade": "string",
    "paisCidade": "string",
    "idBairro": 0,
    "nomeBairro": "string",
    "idLogradouro": 0,
    "descricaoLogradouro": "string",
    "numeroLogradouro": "string",
    "complementoLogradouro": "string",
    "cep": "string",
    "telefoneDDD1": "string",
    "telefoneNumero1": "string",
    "telefoneComplemento1": "string",
    "numeroCPFCNPJ": "string",
    "digitoCPFCNPJ": "string",
    "email": "string",
    "homePage": "string",
    "contribuinteICMS": "string"
}

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