Objetivo

Realizar a inclusão de Pessoa.

Chamada

POST /api/v1/Pessoa

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)

VersaoVersão da pessoaInteger($int64)Não há
NomeRazaoSocialRazão SocialStringObrigató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 (A-ATIVO / I-INATIVO) StringObrigatório, valores permitidos AI.
NomeCidadeNome da cidadeStringNão há
UFCidadeEstadoStringNão há
PaisCidadePaísStringNão há
CodigoMunicipioCódigo do municípioInteger($int64)Não há
CodigoPaisCódigo do país.Integer($int64)Não há
NomeBairroNome do bairroStringNão há
TipoLogradouroTipo do logradouro. (Rua, avenida, etc.)StringNã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 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 CPFStringValores 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)

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
    }
  ]
}