INTRODUÇÃO
Este web service tem por objetivo realizar operações e consultas de pessoas. Também é possível importar os dados de pessoas e seus telefones através do Xml que é montado conforme o arquivo XSD, o qual contém o formato que deve ser obedecido o Xml.
ImportarDadosPessoasParaUau
Método para importar os dados de pessoas através do Xml que é montado conforme o arquivo XSD, o qual contém o formato que deve ser obedecido o Xml.
Parâmetros
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| infoPes | Objeto PessoasInfo | Sim | Objeto com os dados de pessoa. |
| infoPesfis | Objeto PesFisInfo | Sim | Objeto com os dados da pessoa física |
| infoPesJur | Objeto PesJurInfo | Sim | Objeto com os dados da pessoa Jurídica |
| dsPesTel | Objeto DataSet | Sim | Objeto com os dados do telefone da pessoa |
| infoPesDoc | Objeto PessoasDocInfo | Sim | Objeto com os dados dos documentos da pessoa |
| infoPesEnderecoPrincipal | Objeto PesEnderecoInfo | Sim | Objeto com os dados de endereço principal da pessoa |
| infoPesEnderecoCobranca | Objeto PesEnderecoInfo | Sim | Objeto com os dados de endereço de cobrança |
| infoPesEnderecoComercial | Objeto PesEnderecoInfo | Sim | Objeto com os dados de endereço comercial da pessoa |
Abaixo seguem exemplos de arquivos para requisição e XSD de validação.
Retorno
| Valor | Descrição |
|---|---|
| Resultado Execução | Caso a propriedade Sucesso esteja true, é que tudo foi executado com sucesso e a mensagem é apenas de informação. Caso a propriedade Sucesso esteja false, é porque houve algum erro de validação e os detalhes estarão na propriedade de mensagem. |
Abaixo seguem exemplos de arquivos de retorno
- Exemplo que a string esta diferente do arquivo XSD: Existem informações que não estão de acordo com o arquivo XSD de Pessoas. Por favor, verfique:
Data at the root level is invalid. Line 1, position 1 - Exemplo de campo com valor inválido: Existem informações que não estão de acordo com o arquivo XSD de Pessoas. Por favor, verfique: Linha 1, Posição 429, Mensagem The ‘Cep’ element is invalid – The value ” is invalid according to its datatype ‘tsCep’ – The Pattern constraint failed.
Dicionário de dados
O parâmetro xml é do tipo string na estrutura de um arquivo xml, segue abaixo a descrição dos campos utilizados nesse arquivo para importar pessoas.
Pessoas
Valor Descrição String Retorna uma string, caso os dados importado com sucesso retorna um "Ok", caso ocorra alguma exceção retorna a string com a mensagem informado o motivo da exceção.
Obs.: Caso o tipo de pessoa for igual a zero (0) (pessoa física) então deve informar os campos: Profissão, CodigoEmpresa.
Caso não possui profissão e(ou) CodigoEmpresa, então deve informar zero (0).
Obs.: Caso informe o endereço de cobrança o campo CodigoEmpresa deve ser informado, caso não tenha o valor informe zero (0).
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| cod_pes | Int | Sim | Código da pessoa. Para inclusão de novo registro informar 0(zero) |
| nome_pes | String(150) | Sim | Nome da pessoa |
| tipo_pes | Tinyint | Sim | Tipo de pessoa: 0 - pessoa Física(padrão) 1 - pessoa jurídica. |
| cpf_pes | Varchar(14) | Sim | CPF OU CNPJ da pessoa |
| dtcad_pes | DateTime | Não | Data de cadastro |
| dtnasc_pes | DateTime | Não | Data de nascimento da pessoa |
| IntExt_pes | Tinyint | Não | Pessoa interno ou externo: 1 - interno, 2 - externo(padrão) |
| UsrCad_pes | Varchar(8) | Não | Código do usuário que está cadastrando a pessoa. |
| UsrAlt_pes | Varchar(8) | Não | Código do usuário que está alterando a pessoa. |
| Status_pes | Tinyint | Não | Situação da pessoa: 1 - temporário 2 - confirmado |
| Tratamento_pes | Varchar(50) | Não | Tipo de tratamento |
| SiglaObr_pes | Varchar(5) | Não | Código da obra |
| Email_pes | Varchar(400) | Não | E-mail. Separar com ;(ponto e vírgula) para vários |
| EndWWW_pes | Varchar(255) | Não | Página na internet |
| Matricula_Pes | Varchar(15) | Não | Número da matrícula na folha de pagamento |
| AtInat_pes | Tinyint | Sim | Status da pessoa: 0 - ativo 1 - inativo |
| DataAlt_pes | DateTime | Não | Data de alteração dos dados da pessoa |
| NomeFant_Pes | Varchar(150) | Não | Nome fantasia |
| Anexos_pes | Tinyint | Não | Código do anexo: Indicar os tipos de Anexos de um registro (Pendencia, Comentário ou foto) |
| InscrMunic_pes | Varchar(30) | Não | Inscrição municipal |
| inscrest_pes | Varchar(30) | Não | Inscrição estadual |
| SiglaEmp_pes | Smallint | Não | Código da empresa |
| Login_pes | Varchar(30) | Não | Login no UAU |
| Senha_pes | Varchar(15) | Não | Senha do UAU |
| CNAE_pes | Varchar(8) | Não | Armazenar o código do CNAE que corresponde a sua descrição de atividade econômica. |
| DataCadPortal_pes | DateTime | Não | Data de cadastro no portal |
| CadastradoPrefeituraGyn_pes | bit | Sim | Saber se a pessoa é cadastrada na prefeitura de Goiânia. 0 - Não 1 - Sim |
| HabilitadoRiscoSacado_pes | bit | Sim | Se a pessoa está habilitada para a opção risco sacado 1 - Sim, 0 - Não |
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Venda | int | Sim | Número da venda |
| Obra | string | Sim | Código da obra |
| Empresa | int | Sim | Número da empresa |
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| cod_pf | int | Sim | Informar o mesmo valor do campo Cod_Pes |
| lotacao_pf | Varchar(50) | Não | Lotação |
| cargo_pf | Varchar(90) | Não | Cargo |
| dtadm_pf | DateTime | Não | Data de admissão |
| corresp_pf | Tinyint | Não | Endereço de correspondência: 0 - nenhum 1 - comercial 2 - residencial |
| estciv_pf | Tinyint | Não | Estado civil: 0 - separado 1 - solteiro 2 - casado 3 - desquitado 4 - viúvo 5 - divorciado 6 - outros |
| doc_pf | Varchar(15) | Não | Número do documento |
| tdoc_pf | Varchar(10) | Não | Tipo do documento |
| dtdoc_pf | DateTime | Não | Data do documento |
| sexo_pf | Tinyint | Não | Sexo: 0 - masculino 1 - feminino |
| nacion_pf | Varchar(15) | Não | Nacionalidade |
| numdep_pf | Tinyint | Não | Número de dependentes |
| pai_pf | Varchar(150) | Não | Nome do pai |
| dtpai_pf | DateTime | Não | Data de nascimento do pai |
| mae_pf | Varchar(150) | Não | Nome da mãe |
| dtmae_pf | DateTime | Não | Data de nascimento da mãe |
| naturalid_pf) | Varchar(40) | Não | Naturalidade |
| CodNacao_pf | Varchar(5) | Não | Código da nação |
| CodGrau_pf | Varchar(2) | Não | Código do grau de instrução |
| CodRaca_pf | Varchar(2) | Não | Código da raça |
| CodSMil_pf | Varchar(2) | Não | Código da situação militar |
| UfNasc_pf | Varchar(5) | Não | UF de nascimento |
| CidadeNat_pf | Int | Não | Código da cidade de nascimento |
| FatorRH_pf | Varchar(3) | Não | Fator RH |
| RegCasamento_pf | Tinyint | Não | Regime de casamento |
| Cdi_pf | Varchar(12) | Não | Número CDI |
| NumPro_pf | Int | Não | Código da profissão |
| UniaoEstavel_pf | Bit | Não | União estável: 0 - não 1 - sim |
| profis_pf | Varchar(20) | Não | Profissão |
| DetalhaNacao_pf | Tinyint | Não | Código do detalhamento da nacionalidade |
| CodNacaoOrigem_pf | Varchar(5) | Não | Código da nação de origem. |
| CodMunicNasc_pf | Int | Não | Código município de nascimento |
| IndicativoFiscal_pf | Tinyint | Não | Indicativo fiscal |
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| cod_pj | int | Sim | Informar o mesmo valor do campo Cod_Pes |
| contato_pj | Varchar(30) | Não | Nome da pessoa de contato na empresa |
| contato2_pj | Varchar(30) | Não | Nome da segunda pessoa de contato da empresa |
| InsSuframa_pj | Varchar(9) | Não | Armazenar o código de inscrição no SUFRAMA da pessoa jurídica |
| Natureza_pj | Tinyint | Não | Indicador da natureza da pessoa: 1 - Órgão, Autarquia ou Fundação Federal 2 - Entidade da Administração Pública Federal 3 - Pessoa Jurídica de Direito Privado 4 - Sociedade Cooperativa 5 - Fabricante de Máquinas e Veículos |
| OptanteSimples_pj | Bit | Não | Verificar se é Optante do Simples: 0 - Não; 1 - Sim. |
| ANS_pj | Varchar(9) | Não | Código ANS |
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Ddd_tel | Varchar(4) | Sim | DDD do telefone |
| Fone_tel | Varvhar(11) | Sim | Número do telefone |
| Ram_tel | Varvhar(50) | Não | Número do ramal |
| Tipo_tel | Tinyint | Não | Tipo do telefone: 0- Res 1- Com 2- Celular 3 - Recado 4 - Fax 5 - Bip 6 - Telex 7 - Outro 8 - Fone/Fax |
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CodPes_Doc | Int | Sim | Código da pessoa |
| Tipo_Doc | Tinyint | Sim | Tipo do documento |
| Registro_Doc | Varchar(25) | Sim | Código de registro |
| OrgaoEmissor_Doc | Varchar(20) | Não | Órgão emissor |
| CodNacao_Doc | Varchar(5) | Não | Código da nação |
| UF_Doc | Varchar(5) | Não | UF do Documento |
| DataEmissao_Doc | DateTime | Não | Data da emissão do documento |
| DataValidade_Doc | DateTime | Não | Data de validade do documento |
| Categoria_Doc | Varchar(5) | Não | Categoria do documento |
| ZonaEleit_Doc | Varchar(3) | Não | Zona eleitoral |
| Secao_Doc | varchar(10) | Não | Seção eleitoral |
| TipoEntClasse_Doc | smallint | Não | Tipo entidade: 0 - Administração 1 - Advocacia 2 - Biblioteconomia 3 - Biologia 4 - Biomedicina 5 - Contabilidade 6 - Economia 7 - Educação física 8 - Enfermagem 9 - Engenharia 10 - Farmácia 11 - Fisioterapia 12 - Fonoaudiologia 13 - Medicina 14 - Medicina veterinária 15 - Nutrição 16 - Odontologia 17 - Psicologia 18 - Química 19 - Serviço Social |
| SeqConselho_Doc | Varchar(50) | Não | Número sequencial do conselho |
| DataAlt_Doc | datetime | Não | Data alteração |
| UsrAlt_Doc | varchar(8) | Não | Usuário alterou |
GravarPessoa
Método para gravar dados de pessoa física ou jurídica.
Rota: /api/v{version}/Pessoas/GravarPessoa
Dependência: Depende das seguintes rotas:
- /api/v{version}/Autenticador/AutenticarUsuario OU
- /api/v{version}/Autenticador/AutenticarUsuarioCorporativo
Exemplo Postman: GravarPessoa.postman_collection.zip
Parâmetros
Exemplo de Estrutura do Parâmetro de entrada: ParametroGravarPessoa.txt
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CodPes_pend | int | Sim | Código pessoa |
| Tipo_pend | Tinyint | Sim | Tipo de endereço: 0 - Endereço Principal 1 - Endereço Cobrança 2 - Endereço Comercial |
| Endereco_pend) | Varchar(100) | Não | Logradouro |
| Bairro_pend | Varchar(100) | Não | Bairro |
| Cidade_pend | Varchar(50) | Não | Cidade |
| UF_pend | Varchar(5) | Não | Sigla da UF |
| CEP_pend | Varchar(8) | Não | CEP |
| NumEnd_pend | Varchar(20) | Não | Número endereço |
| ComplEndereco_pend | Varchar(80) | Não | Complemento do endereço |
| ReferEnd_pend | Varchar(80) | Não | Referencia do endereço |
| Proprio_pend | tinyint | Não | Identifica se o endereço da pessoa é próprio. 0 - sim 1 - não |
| NumCid_pend | Int | Não | Código da cidade |
| NumBrr_pend | Int | Não | Código do bairro |
| NumLogr_pend | Int | Não | Código do logradouro |
| CodEmp_pend | int | Não | Código da empresa |
| NomeEmp_pend | Varchar(50) | Não | Nome da empresa |
| TipoEndEmp_pend | Tinyint | Não | Tipo do endereço comercial. 0 - selecionado 1 - gravado |
Retorno
Exemplo de Retorno: RetornoGravarPessoa.txt
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Empresa | Integer | SIM | Código da empresa |
| Obra | String | SIM | Código da obra |
| Produto | Integer | SIM | Código do produto |
| CodPerson | Integer | SIM | Código da personalização |
Dicionário de dados
Descrição dos campos, necessário para montar os objetos para gravar pessoas.
Pessoas
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| strWhere | string | Sim | String com a condição que será usada para filtrar os dados da consulta. |
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| idEmpresa | int | Sim | Código da empresa |
| idProduto | int | Sim | Código do produto |
| idPersonalização | int | Sim | Número da personalização |
| idObra | string | Não | Código da obra |
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| camposCustom | CamposCustom | SIM | Classe que contém uma lista com as chave das unidades que serão usadas para atualizar os campos customizados. |
| Valor | Descrição |
|---|---|
| String | "OK" caso a atualização seja concluída com sucesso ou uma lista contendo os erros caso a atualização falhe. |
| Parâmetros | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| dataInicio | Date | Não | Período inicial. |
| dataFim | Date | Não | Período final. |
| statusEscrituracao | boolean | Não | false - Não buscará as vendas que tiveram o status de escritura alterados. true - Irá buscar as vendas que tiveram o status de escritura alterados. |
| listaVendas | lista de ChavesVendas | Não | Lista com as chaves das vendas. |
Os objetos infoPesEnderecoPrincipal, infoPesEnderecoCobranca, infoPesEnderecoComercial usa o mesmo dicionário de dados que é PesEndereco.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| ListChavesUnid | List ListChavesUnid | SIM | Contém a lista de chaves das unidades |
| ListValoresUnid | List ListValoresUnid | SIM | Lista com campos e valores customizados a serem atualizados |