Home TOTVS Varejo Supermercados

Árvore de páginas

Versões comparadas

Versão antiga 4

changes.mady.by.user Usuário desconhecido (delciney.oliveira)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Gleydson Guedes Morais

Gravado em

Chave

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

...

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)

...

Código da pessoa

Nome (Name)

Descrição (Description)

Tipo (Type)

Informações Adicionais (Adittional Information)

idPessoa

Integer($int64)Não háVersaoVersão da pessoaInteger($int64)Não há
NomeRazaoSocialRazão SocialStringNão háObrigatório.
FantasiaNome fantasiaStringNão há
TipoFísica ou Jurídica  (Opções: F - Física / J - Jurídica)StringValores permitidos F, J ou nulo.
SexoSexo (Opções: M - Masculino / F - Feminino)StringNão há
StatusStatus da pessoa (Opções: A - ATIVO Ativo / I -INATIVO) Valores nulos/vazios são considerados como Ativos String- Inativo / P - Prospect / O - Outros) StringObrigatório, valores permitidos Valores permitidos A, I ou nulo, P, O.
IdCidadeNomeCidadeCódigo Nome da cidadeStringSerá usado o menor Identificador(SEQCIDADE), caso hajam cidades com nomes iguais na mesma UF.
UFCidadeEstadoInteger($int64)Não háNomeCidadeNome da cidadeStringNão há
UFCidadePaisCidadeEstadoPaísStringNão há
PaisCidadeCodigoMunicipioPaísCódigo do municípioInteger($int64)StringNão há
IdBairroCodigoPaisCódigo do bairropaís.Integer($int64)Não há
NomeBairroNome do bairroStringNão há
IdLogradouroTipoLogradouroCódigo Tipo do logradouroInteger($int64. (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)StringNã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 S, N ou nulo.
ProdutorRuralIdentificador de Produtor Rural (Opções: S - Sim / N - Não)StringValores permitidos S, N ou nulo.
MicroEmpresaIdentificador de Micro Empresa (Opções: S - Sim / N - Não)StringValores permitidos S, N ou nulo.
InscricaoProdutorRuralInscrição de produtor ruralStringNão há
NumeroCNPJProdutorRuralNúmero do CNPJ de produtor rural sem dígitoInteger($int64)StringNã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 S, N ou nulo.
NumeroCPFProdutorRuralNúmero do CPF de produtor rural sem dígitoInteger($int64)Não há
DigitoCPFProdutorRuralDígito do CPFInteger($int64)Não há

...

Bloco de código
languageactionscript3
{
    "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

...