Pessoas (básico)

Índice

Pessoas

PESSOA.WS_PESSOAS

Descrição

Esta interface é usada em diferentes guias do sistema. Clique nos links de navegação abaixo para obter maiores informações.

Pessoa:

Campos:

Código de identificação do sistema. Gerado internamente.
Tipo de pessoa. Valores aceitos:
  • Física
  • Jurídica
Ex:
  • Física
  • Jurídica
Código (único) de identificação da pessoa (física ou jurídica).
Nome completo da pessoa física ou razão social da pessoa jurídica. Razão social é o nome devidamente registrado sob o qual uma pessoa jurídica se individualiza e exerce suas atividades. A razão social diferencia-se do nome dado a um estabelecimento ou do nome comercial com que a empresa pode ser reconhecida junto ao público, o qual é conhecido como nome fantasia.
Para pessoas físicas, indica a data de nascimento.
Para pessoas jurídicas, indica a data de sua fundação.
Código de endereçamento postal (CEP no Brasil, ZIP nos EUA, etc.).
O nome deste campo depende do país.
A partir do CEP informado, o sistema busca os dados de logradouro, bairro e cidade.
O mecanismo de busca do endereço a partir do CEP informado é definido na preferência PESSOAS.ENDERECOS.MECANISMO_BUSCA_CEP.
Depende do tipo de endereço. Pode ser o nome da rua, avenida, número de telefone, endereço de e-mail, etc.
Número de identificação do prédio no logradouro.
Complemento para o endereço (andar, apartamento, sala, etc.)
Nome do bairro (ou distrito) do endereço
Nome completo da cidade (acentos e cedilhas são mantidos).
Ex:
  • SÃO LEOPOLDO
  • SÃO PAULO
  • ALVORADA
  • PARIS
Unidade da federação. Para estados de outros países (diferente de Brasil), será sempre igual a EX.
Nome do país para ser utilizado nas interfaces do sistema.
Situação do cadastro da pessoa.
  • Ativo - A pessoa está ativa e pode ser utilizada em novos processos do sistema.
  • Inativo - A pessoa está inativa e não pode ser mais utilizada em novos processos do sistema que exigem pessoas ativas ou pendentes. O registro é mantido para efeito de histórico.
  • Pendente - O cadastro da pessoa não foi avaliado e verificado, mas a pessoa pode ser mais utilizada em novos processos do sistema que exigem pessoas ativas ou pendentes.
Array contendo os documentos da pessoa. Cada documento é formado pelos seguintes atributos:
  • tipo_documento: CPF, CNPJ, CARTEIRA_IDENTIDADE, ...
  • documento: Número do documento propriamente dito.
Na consulta, os dados virão sempre formatados com as respectivas máscaras (se houverem).
Na inclusão de novos registros, os dados são validados com as respectivas regras de validação (CPF e CNPJ).

Exemplo:
[{
   "tipo_documento": "CPF",
   "documento": "708.102.499-87"
 },
 {
   "tipo_documento": "RG",
   "documento": "9029279545"
 }]
Array contendo os meios de contato da pessoa. Cada elemento do array contém 3 elementos:
  • meio: Pode ser CELULAR, TELEFONE, WHATSAPP, SKYPE, EMAIL, ...
  • contato: Texto com o identificador do contato propriamente dito (número do telefone, endereço de e-mail, etc.)
  • sequencia: Inteiro opcional utilizado para ordenar os contatos de mesmo meio.
Exemplo:
{
  "meio": "CELULAR",
  "contato": "(48) 99927-3422",
  "sequencia": 1
}
Sexo (gênero) da pessoa. Valores aceitos:
  • MASCULINO
  • FEMININO

Operações

Topo

Pesquisar

Ao pesquisar, o usuário poderá informar critérios de filtro para listar apenas os registros desejados. Normalmente depois de informar os filtros desejados, o usuário deverá executar a operação [b:Listar].
Obtenha maiores detalhes em Como utilizar a tela de pesquisa?.
Topo

Listar

Apresenta uma lista com os registros que atendem aos filtros informados.
A lista possui diversos recursos práticos e importantes para o usuário:
FísicaSÃO LEOPOLDOAtivo
JurídicaSÃO PAULOInativo
FísicaALVORADAPendente
JurídicaPARISAtivo
Topo

Consultar

A consulta de um registro é realizada quando o usuário clica no primeiro link de um dos registros resultantes a operação [b:Listar]. A tela apresenta as informações detalhadas do registro, bem como as ações que o usuário pode disparar a partir dele (alterar, excluir, cancelar, etc.).
Comportamento:Topo

Novo

Permite criar novos registros no sistema. Ao ser executado, o sistema apresenta um formulário com todos os campos do registro que deverão ser preenchidos. Quando todos os campos desejados estiverem preenchidos, clique em [b:Salvar].
Comportamento:Topo

Alterar

A partir da tela de consulta de um registro, esta operação permite alterar os dados do mesmo.
O sistema abre um formulário com os campos editáveis. Após alterar os campos, o usuário deverá clicar em [b:Salvar].
Comportamento:Topo

Excluir

Exclui o registro selecionado. A exclusão do registro pode ser disparada a partir da tela de consulta e/ou de manutenção do mesmo.
O registro somente será excluído se todas as condições necessárias forem encontradas, gerando um erro, caso alguma destas condições não estiver sendo atendida.
Topo

Incluir ou alterar

Esta operação verifica se o documento (CPF) da pessoa já existe.
Em caso negativo, inseri a pessoa como se fosse uma nova, caso contrário, altera o respectivo registro pessoa.

Regras

Alterar pessoa quando documento já existe

Caso o documento informado (CPF ou CNPJ) já existir, ao invés de incluir, o registro da pessoa deve ser atualizado.
Eventos que disparam esta regra:
  • Antes de inserir formulário "Novo"

Preencher informações

Preenche informações de detalhe:
  • Todos os documentos cadastrado para a pessoa.
  • Todos os telefones
Eventos que disparam esta regra:
  • Antes de apresentar cada registro formulário "Alterar"
  • Antes de apresentar cada registro formulário "Consultar"

Salvar detalhes

Eventos que disparam esta regra:
  • Depois de alterar formulário "Alterar"
  • Depois de inserir formulário "Novo"