Dimensa Core Banking

Árvore de páginas

  • Criado por Usuário desconhecido (gvinskoski), última alteração em 07 ago, 2022

1.3.1.         POST alterarPessoa

Entendimento: Alteração do cliente PF.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarPessoa>

         <alterar>

            <codigoCliente>73</codigoCliente>

            <codigoUnidadeResponsavel>1</codigoUnidadeResponsavel>

            <tipoPessoa>F</tipoPessoa>

            <nomePessoa>JOÃO DA SILVA</nomePessoa>

            <numeroCic>92764644094</numeroCic>

            <dataClienteDesde>2021-06-20</dataClienteDesde>

            <dataRenovacaoCadastral>2022-06-21</dataRenovacaoCadastral>

            <dataInicioRelacionamentoInstituicao>2000-06-02</dataInicioRelacionamentoInstituicao>

            <indicadorNivelRelacionamento>false</indicadorNivelRelacionamento> !--Declaração Propósito:--

            <tipoLigacao>NAO_LIGADO</tipoLigacao> !--LIGADO, NAO_LIGADO

            <segmento>5</segmento>

            <identificadorGrupoEconomico>false</identificadorGrupoEconomico>

            <indicadorAtualizacaoCliente>true</indicadorAtualizacaoCliente>  !--Consulta BACEN:--

            <unidadePessoa>

               <codigoUnidade>1</codigoUnidade>

               <codigoGerente>1</codigoGerente>

               <dataConstituicao>1999-12-31</dataConstituicao>

               <identificadorSituacao>ATIVO</identificadorSituacao>

               <complementoUnidadePessoa>

                    <dataCadastro>2021-03-10</dataCadastro>

                    <dataRenovacaoCadastro>2022-06-21</dataRenovacaoCadastro>

                </complementoUnidadePessoa>

            </unidadePessoa>

            <pessoaFisica>

               <nacionalidade>ESPANHOLA</nacionalidade>

               <ufNaturalidade>RS</ufNaturalidade>

               <indicadorCapacidadeCivil>CAPAZ</indicadorCapacidadeCivil>

               <indicadorOutroDocumento>CARTEIRA_IDENTIDADE</indicadorOutroDocumento>

               <indicadorSexo>MASCULINO</indicadorSexo>

               <codigoEstadoCivil>CT</codigoEstadoCivil>

               <siglaUfEmissao>RS</siglaUfEmissao>

               <descricaoLocalidadeNascimento>PORTO ALEGRE</descricaoLocalidadeNascimento>

               <dataNascimento>2000-10-10</dataNascimento>

               <dataEmissaoOutroDocumento>2017-10-10</dataEmissaoOutroDocumento>

               <siglaOrgaoEmissorOutroDocumento>SSP RS</siglaOrgaoEmissorOutroDocumento>

               <numeroOutroDocumento>998877</numeroOutroDocumento>

               <pessoaPoliticamenteExposta>false</pessoaPoliticamenteExposta>

               <indicadorTipoTitularidade>false</indicadorTipoTitularidade>

            </pessoaFisica>

         </alterar>

      </cad:alterarPessoa>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMÉRICO

8

SIM

Código cliente retornado na comsulta buscarPessoa

codigoUnidadeResponsavel

NUMERICO

10

SIM

Unidade retornada na consulta, para alterar poderá chamar a consulta item (i) (abaixo)

tipoPessoa

CHAR

1

SIM

Domínio retornado na consulta. Se PF será F

nomePessoa

CHAR

55

SIM

Nome do Cliente retornado na consulta

numeroCic

NUMERICO

11

SIM

Número do CPF retornado na comsulta

dataClienteDesde

DATA

8

SIM

Data de Cadastro do Cliente.

Formato YYYY-MM-DD

dataRenovacaoCadastral

DATA

8

SIM

Data da atualização do cadastro, informar nova data para alterar

indicadorNivelRelacionamento

BOOLEAN

true/false

NÃO

Declaração Propósito e Naturez.

tipoLigacao

CHAR

10

NÃO

Cliente ligado à instituição

Domínio: LIGADO, NAO_LIGADO.

segmento

NUMERICO

10

SIM

Segmento/Setor da Pessoa

*lista consulta item (ii)

identificadorGrupoEconomico

BOOLEAN

true/false

NÃO

Se pertence a Grupo Econômico.

indicadorAtualizacaoCliente

BOOLEAN

true/false

NÃO

Campo Autoriza BACEN.

unidadePessoa

Lista




codigoUnidade

NUMERICO

10

SIM

Código da Unidade retornado na consulta

codigoGerente

CHAR

45

SIM

Código do Gerente da unidade ou setor, *lista chamar a consulta item (iii)

identificadorSituacao

CHAR

20

SIM

Situação da empresa. Ex: ATIVO

*domínio item (v)

pessoaFisica

Lista




nacionalidade

CHAR

15

NÃO

Nacionalidade do Cliente, não é validado.

ufNaturalidade

CHAR

2

NÃO

Unidade da Federação do cliente .

indicadorCapacidadeCivil

CHAR


NÃO

Capacidade Civil.

*domínio item (v)

indicadorOutroDocumento

CHAR


NÃO

Descrição de outro documento.

*domínio item (vi)

indicadorSexo

CHAR


NÃO

Informar o retorno da consulta. *Domínios: FEMININO e MASCULINO

codigoEstadoCivil

CHAR

2

NÃO

Código do estado civil.

*lista item (viii)

siglaUfEmissao

CHAR

2

NÃO

Unidade da Federação da emissão do outro documento do cliente.

*sigla do Estado item (iv)

descricaoLocalidadeNascimento

CHAR

30

NÃO

Cidade de nascimento do cliente.

*chamar serviço listar localidade por UF ou localidade por CEP: item (vii)

dataNascimento

DATA

8

NÃO

Data de Nascimento do cliente.

dataEmissaoOutroDocumento

CHAR

8

NÃO

Data Emissão Documento.

siglaOrgaoEmissorOutroDocumento

CHAR


NÃO

Sigla do órgão de emissão do número do outro documento (documento de identificação)

numeroOutroDocumento

NUMERICO

15

NÃO

Número do documento de identificação informado pelo cliente

pessoaPoliticamenteExposta

BOOLEAN

true/false

NÃO

Indica se o cliente é uma pessoa politicamente exposta

indicadorTipoTitularidade

BOOLEAN

true/false

NÃO

Indica se é Titular

*Todos os campos obrigatórios e demais campos retornados na consulta buscarPessoa deverão ser informados e poderão ser alterados, exceto código do cliente. Caso não informar um campo não obrigatório na alteração, será excluído. Caso desejar incluir um registro não retornado, poderá incluir o desejado.

Buscar Pessoa por Código

/tfs-basico-service/ParametrosService/Parametros


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:buscarPessoa>

         <codigoCliente>73</codigoCliente>

      </cad:buscarPessoa>

   </soapenv:Body>

</soapenv:Envelope>


Itens Domínios/Tabelas

  • Código Unidade


/tfs-basico-service/ParametrosService/Parametros


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="parametros.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <par:listarUnidadeOperacional>

         <listar>

         </listar>

      </par:listarUnidadeOperacional>

   </soapenv:Body>

</soapenv:Envelope>



  • Segmento


/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarSegmento>

         <listar>

            <tipoPessoa>F</tipoPessoa>

         </listar>

      </cad:listarSegmento>

   </soapenv:Body>

</soapenv:Envelope>


  • Código Gerente



/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarGerente>

         <listar>

         </listar>

      </cad:listarGerente>

   </soapenv:Body>

</soapenv:Envelope>



  • Situação Cadastro


  <xs:simpleType name="dominioSituacao">

    <xs:restriction base="xs:string">

      <xs:enumeration value="ATIVO"/>

      <xs:enumeration value="IMPEDIDO_DE_OPERAR"/>

      <xs:enumeration value="NOVO"/>

      <xs:enumeration value="PENDENTE_AUTORIZACAO"/>

      <xs:enumeration value="VENCIDO"/>

      <xs:enumeration value="BLOQUEIO_AUTORIZACAO"/>

    </xs:restriction>

  </xs:simpleType>



  • Sigla Uf


/tfs-basico-service/ParametrosService/Parametros


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="parametros.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <par:listarDominioUF/>

   </soapenv:Body>

</soapenv:Envelope>



  • Indicador Capacidade Civil


 <xs:simpleType name="dominioCapacidadeCivil">

    <xs:restriction base="xs:string">

      <xs:enumeration value="CAPAZ"/>

      <xs:enumeration value="INCAPACIDADE_RELATIVA"/>

      <xs:enumeration value="INCAPACIDADE_ABSOLUTA"/>

    </xs:restriction>

  </xs:simpleType>



  • Indicador Outro Documento


 <xs:simpleType name="dominioOutroDocumento">

    <xs:restriction base="xs:string">

      <xs:enumeration value="CARTEIRA_CONSELHO_REGIONAL"/>

      <xs:enumeration value="CARTEIRA_IDENTIDADE"/>

      <xs:enumeration value="CARTEIRA_MOTORISTA"/>

      <xs:enumeration value="CARTEIRA_TRABALHO"/>

      <xs:enumeration value="CERTIDAO_NASCIMENTO"/>

      <xs:enumeration value="PASSAPORTE"/>

      <xs:enumeration value="REGISTRO_NACIONAL_ESTRANGEIROS"/>

    </xs:restriction>

  </xs:simpleType>



  • Localidades por UF e/ou CEP



/tfs-basico-service/ParametrosService/Parametros


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

   <soap:Body>

      <ns2:listarLocalidade xmlns:ns2="parametros.basico.tfs.totvs.com">

         <localidadeRequestDTO>

            <siglaEstado>RS</siglaEstado>

         </localidadeRequestDTO>

      </ns2:listarLocalidade>

   </soap:Body>

</soap:Envelope>



<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="parametros.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <par:listarCepLogradouros>

         <listar>

            <codigoCepLogradouro>90690300</codigoCepLogradouro>

         </listar>

      </par:listarCepLogradouros>

   </soapenv:Body>

</soapenv:Envelope>



  • Estado Civil



/tfs-basico-service/ParametrosService/Parametros


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="parametros.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <par:listarEstadoCivil>

         <listar>

         </listar>

      </par:listarEstadoCivil>

   </soapenv:Body>

</soapenv:Envelope>

1.3.2.         POST alterarParentesco – Mãe

Entendimento: Alteração dados da Mãe.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarParentesco>

         <alterar>

            <codigoCliente>{{cliente}}</codigoCliente>

            <siglaRelacionamento>MAE</siglaRelacionamento>

            <nomeParente>MARIA DA SILVA</nomeParente>

            <cpfParente>11893897036</cpfParente>

            <parentePoliticamenteExposto>false</parentePoliticamenteExposto>

         </alterar>

      </cad:alterarParentesco>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código Cliente retornado da consulta listarParentesco

siglaRelacionamento

CHAR

20

SIM

Sigla do relacionamento retornada na consulta

nomeParente

CHAR

55

SIM

Nome do Parente retornado na consulta

cpfParente

NUMERO

11

NÃO/SIM

CPF da Mãe

parentePoliticamenteExposto

BOOLEAN

true/false

NÃO

Indica se o parente é uma pessoa politicamente exposta


Consulta Parentenco

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarParentesco>

         <listar>

            <codigoCliente>73</codigoCliente>

            <siglaRelacionamento>MAE</siglaRelacionamento>

         </listar>

      </cad:listarParentesco>

   </soapenv:Body>

</soapenv:Envelope>


1.3.3.        POST alterarParentesco – Pai

Entendimento: Alteração dados da Pai.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarParentesco>

         <alterar>

            <codigoCliente>73codigoCliente>

            <siglaRelacionamento>PAI</siglaRelacionamento>

            <nomeParente>PEDRO DA SILVA</nomeParente>

            <cpfParente>11893897036</cpfParente>

            <parentePoliticamenteExposto>false</parentePoliticamenteExposto>

         </alterar>

      </cad:alterarParentesco>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código Cliente retornado da consulta listarParentesco

siglaRelacionamento

CHAR

20

SIM

Sigla do relacionamento retornada na consulta

listarParentesco

nomeParente

CHAR

55

SIM

Nome do Parente retornado na consulta

cpfParente

NUMERO

11

NÃO/SIM

CPF do Pai retornado na consulta. Se não retornar não informar ou informar caso alterar para incluir 

parentePoliticamenteExposto

BOOLEAN

true/false

SIM

Indica se o parente é uma pessoa politicamente exposta, informar o mesmo que retornar true/false ou alterar


Consulta Parentesco

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarParentesco>

         <listar>

            <codigoCliente>73</codigoCliente>

            <siglaRelacionamento>PAI</siglaRelacionamento>

         </listar>

      </cad:listarParentesco>

   </soapenv:Body>

</soapenv:Envelope>


1.3.4.         POST alterarParentesco – Conjuge

Entendimento: Alterar informações do conjuge do cliente.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

<soapenv:Header/>

 <soapenv:Body>

    <cad:alterarParentesco>

       <alterar>

          <codigoCliente>{{cliente}}</codigoCliente>

          <siglaRelacionamento>CONJUGE</siglaRelacionamento>

          <nomeParente>ANA MARIA</nomeParente>

          <!--numeroCarteiraIdentidade>659452</numeroCarteiraIdentidade:-->

          <!--dataEmissao>2022-04-12</dataEmissao:-->

          <!--orgaoExpeditor>SSPRS</orgaoExpeditor:-->

          <!--ufOrgaoEmissor>RS</ufOrgaoEmissor:-->

          <!--ufNascimento>RS</ufNascimento:-->

          <!--dataNascimentoParente>1995-01-22</dataNascimentoParente:-->

          <cpfParente>03698569858</cpfParente>

          <!--naturalidade>ITALIANA</naturalidade:-->

          <parentePoliticamenteExposto>true</parentePoliticamenteExposto>

       </alterar>

    </cad:alterarParentesco>

 </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código Cliente retornado após consulta listarParentesco

siglaRelacionamento

CHAR

20

SIM

Sigla do relacionamento retornada na consulta

CONJUGE

nomeParente

CHAR

55

SIM

Nome do Parente

numeroCarteiraIdentidade

NUMERO

15

NÃO

Número Documento Indentificação

dataEmissao

DATE

8

NÃO

Data emissão do documento identificação

orgaoExpeditor

CHAR

15

NÃO

Sigla do Órgão Expedidor do documento

ufOrgaoEmissor

CHAR

2

NÃO

UF de emissão do documento

ufNascimento

CHAR

2

NÃO

UF de Nacimento do Conjuge

dataNascimentoParente

DATE

8

NÃO

Data de nascimento do conjuge

cpfParente

NUMERO

11

SIM

CPF do Parente

naturalidade

CHAR

30

NÃO

Local nascimento

parentePoliticamenteExposto

BOOLEAN

true/false

NÃO

Indica se o parente é uma pessoa politicamente exposta


Consulta Parentesco

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarParentesco>

         <listar>

            <codigoCliente>73</codigoCliente>

            <siglaRelacionamento>CONJUGE</siglaRelacionamento>

         </listar>

      </cad:listarParentesco>

   </soapenv:Body>

</soapenv:Envelope>


1.3.5.        POST alterarEndereco - Residencial

Entendimento: Alteraro o endereço residencial do cliente.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarEndereco>

         <alterar>

            <codigoCliente>73</codigoCliente>

            <codigoUnidade>1</codigoUnidade>

            <siglaTipoEndereco>RESIDENCIAL</siglaTipoEndereco>

            <siglaUf>AC</siglaUf>

            <nomeCidade>RIO BRANCO</nomeCidade>

            <nomeBairro>CONJUNTO PAULO CESAR DE OLIVEIRA</nomeBairro>

            <codigoCep>69919130</codigoCep>

            <nomeLogradouro>BOSQUE</nomeLogradouro>

            <numeroEndereco>12</numeroEndereco>

            <descricaoComplementoEndereco>AP 01</descricaoComplementoEndereco>

            <enderecoEmail>joao@email.com</enderecoEmail>

            <siglaTipoLogradouro>RUA</siglaTipoLogradouro>

            <telefoneCompleto>5599885577</telefoneCompleto>

            <celularCompleto>5199992222</celularCompleto>

            <idenTipoEndereco>true</idenTipoEndereco>

         </alterar>

      </cad:incluirEndereco>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código Cliente retornado após consulta listarEndereco

codigoUnidade

NUMERICO

10

SIM

Código da Unidade retornado na consulta

siglaTipoEndereco

CHAR

15

SIM

Tipo retornado na consulta: RESIDENCIAL

*consulta tipo item (i)

siglaUf

CHAR

2

NÃO

Unidade da Federação do endereço retornado.


nomeCidade

CHAR

72

NÃO

Cidade do Endereço

nomeBairro

CHAR

72

NÃO

Bairro do Endereço

codigoCep

NUMERO

8

SIM

CEP do Endereço

nomeLogradouro

CHAR

72

NÃO

Logradouro do Endereço

numeroEndereco

NUMERO

10

NÃO

Número do endereço

descricaoComplementoEndereco

CHAR

10

NÃO

Complemento do endereço

enderecoEmail

CHAR

70

NÃO

Endereço de e-mail do cliente

siglaTipoLogradouro

CHAR

15

NÃO

Tipo do endereço. Ex: RUA

*consulta tipo item (ii)

telefoneCompleto

NUMERO

12

NÃO

DDD + Número do Telefone

celularCompleto

NUMERO

12

NÃO

DDD + Número do Telefone

idenTipoEndereco

BOOLEAN

true/false

SIM

Identifica se é principal ou não.

Regra: caso endereço RESIDENCIAL for true como principal, CORRESPONDENCIA será false


Consulta Endereço

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarEndereco>

         <listar>

            <codigoCliente>73</codigoCliente>

            <siglaTipoEndereco>RESIDENCIAL</siglaTipoEndereco>

         </listar>

      </cad:listarEndereco>

   </soapenv:Body>

</soapenv:Envelope>


Itens Domínios/Tabelas

  • Tipo Endereço


/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarTipoEndereco>

         <listar>

            <tipoPessoa>F</tipoPessoa>

         </listar>

      </cad:listarTipoEndereco>

   </soapenv:Body>

</soapenv:Envelope>



  • Tipo Logradouro


tfs-basico-service/ParametrosService/Parametros


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="parametros.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <par:listarTipoLogradouro>

         <listar>

         </listar>

      </par:listarTipoLogradouro>

   </soapenv:Body>

</soapenv:Envelope>

1.3.6.        POST alterarEndereco – Correspondência

Entendimento: Alteraro o endereço comercial do cliente.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarEndereco>

         <alterar>

            <codigoCliente>73</codigoCliente>

            <codigoUnidade>1</codigoUnidade>

            <siglaTipoEndereco>CORRESPONDENCIA</siglaTipoEndereco>

            <siglaUf>AC</siglaUf>

            <nomeCidade>RIO BRANCO</nomeCidade>

            <nomeBairro>CONJUNTO PAULO CESAR DE OLIVEIRA</nomeBairro>

            <codigoCep>69919130</codigoCep>

            <nomeLogradouro>BOSQUE</nomeLogradouro>

            <numeroEndereco>12</numeroEndereco>

            <descricaoComplementoEndereco>AP 01</descricaoComplementoEndereco>

            <siglaTipoLogradouro>RUA</siglaTipoLogradouro>

            <idenTipoEndereco>false</idenTipoEndereco>

         </alterar>

      </cad:incluirEndereco>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código Cliente retornado após consulta listarEndereco

codigoUnidade

NUMERICO

10

SIM

Código da Unidade retornado na consulta

siglaTipoEndereco

CHAR

15

SIM

Tipo retornado na consulta: CORRESPONDENCIA

*consulta tipo item (i)

siglaUf

CHAR

2

NÃO

Unidade da Federação do endereço retornado.


nomeCidade

CHAR

72

NÃO

Cidade do Endereço

nomeBairro

CHAR

72

NÃO

Bairro do Endereço

codigoCep

NUMERO

8

SIM

CEP do Endereço

nomeLogradouro

CHAR

72

NÃO

Logradouro do Endereço

numeroEndereco

NUMERO

10

NÃO

Número do endereço

descricaoComplementoEndereco

CHAR

10

NÃO

Complemento do endereço

siglaTipoLogradouro

CHAR

15

NÃO

Tipo do endereço. Ex: RUA

*consulta tipo item (ii)

idenTipoEndereco

BOOLEAN

true/false

SIM

Identifica se é principal ou não.

Regra: caso endereço RESIDENCIAL for true como principal, CORRESPONDENCIA será false


Consulta Endereço

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarEndereco>

         <listar>

            <codigoCliente>73</codigoCliente>

            <siglaTipoEndereco>CORRESPONDENCIA</siglaTipoEndereco>

         </listar>

      </cad:listarEndereco>

   </soapenv:Body>

</soapenv:Envelope>


Itens Domínios/Tabelas

  • Tipo Endereço


/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarTipoEndereco>

         <listar>

            <tipoPessoa>F</tipoPessoa>

         </listar>

      </cad:listarTipoEndereco>

   </soapenv:Body>

</soapenv:Envelope>



  • Tipo Logradouro


tfs-basico-service/ParametrosService/Parametros


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="parametros.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <par:listarTipoLogradouro>

         <listar>

         </listar>

      </par:listarTipoLogradouro>

   </soapenv:Body>

</soapenv:Envelope>


1.3.7.    POST alterarFormaContato - Telefone

Entendimento: Alteração da forma de contato do cliente que contém Telefone. Ex.: Celular, Whatsapp.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarFormaContato>

         <alterar>

            <numeroSequencial>5</numeroSequencial>

            <codigoCliente>73</codigoCliente>

            <codigoTipoContato>F</codigoTipoContato>

            <tefoneCompleto>5199998877</tefoneCompleto>

         </alterar>

      </cad:alterarFormaContato>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

numeroSequencial

NUMERO

10

SIM

Sequencial do registro do cliente retornado na consulta listarFormaContato

codigoCliente

NUMÉRICO

8

SIM

Código Cliente retornado na consulta

codigoTipoContato

NUMERICO

1

SIM

Tipo Contato retornado na consulta

tefoneCompleto

NUMERICO

14

SIM

Número do Telefone do contato retorndo na consulta.

Consulta Formas de Contato

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarFormaContato>

         <listar>

            <codigoCliente>73</codigoCliente>

         </listar>

      </cad:listarFormaContato>

   </soapenv:Body>

</soapenv:Envelope>


1.3.8.    POST alterarFormaContato – E-mail

Entendimento: Alteração da forma de contato do cliente que contém E-mail. Ex.: Skype, Slack.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarFormaContato>

         <alterar>

            <numeroSequencial>5</numeroSequencial>

            <codigoCliente>73</codigoCliente>

            <codigoTipoContato>S</codigoTipoContato>

            <descricaoEmail>joao@email.com</descricaoEmail>

         </alterar>

      </cad:alterarFormaContato>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

numeroSequencial

NUMERO

10

SIM

Sequencial do registro do cliente retornado na consulta listarFormaContato

codigoCliente

NUMÉRICO

8

SIM

Código Cliente retornado na consulta

codigoTipoContato

NUMERICO

1

SIM

Tipo Contato retornado na consulta

descricaoEmail

NUMERICO

14

SIM

Número do Telefone do contato retorndo na consulta.


Consulta Formas de Contato

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarFormaContato>

         <listar>

            <codigoCliente>73</codigoCliente>

         </listar>

      </cad:listarFormaContato>

   </soapenv:Body>

</soapenv:Envelope>


1.3.9.        POST alterarGrupoPessoa

Entendimento: Alterar informações do vículo do cliente a um grupo econômico.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarGrupoPessoa>

         <alterar>

            <codigoCliente>73</codigoCliente>

            <numeroCicBasico>500391970</numeroCicBasico>

            <numeroGrupoEconomico>1</numeroGrupoEconomico>

            <percentualParticipacao>90</percentualParticipacao>

            <dataSituacao>2000-01-01</dataSituacao>

            <controleAcionista>false</controleAcionista>

            <indicadorAdministrativo>true</indicadorAdministrativo>

            <siglaTipoRelacionamento>G</siglaTipoRelacionamento>

            <!--siglaRelacionamento>HIPERMERCADO</siglaRelacionamento:-->

         </alterar>

      </cad:alterarGrupoPessoa>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMÉRICO

8

SIM

Código Cliente retornado após listarGrupoPessoa

numeroCicBasico

NUMERO

9

SIM

CPF Básico do Cliente

numeroGrupoEconomico

NUMERO

6

SIM

Número de identificação do grupo econômico

*Listar o grupo através do serviço item (i)

percentualParticipacao

NUMERO

3

SIM

Percentual de participação do cliente no grupo econômico

dataSituacao

DATA

8

SIM

Data da Associação ao Grupo

controleAcionista

BOLLEAN

true/false

SIM

Se detêm Controle Acionário

indicadorAdministrativo

BOLLEAN

true/false

SIM

Se detêm Controle Administração

siglaTipoRelacionamento

CHAR

1

SIM

Fixo G


Consulta Grupo Viculado a Pessoa

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarGrupoPessoa>

         <listar>

            <codigoCliente>73</codigoCliente>

         </listar>

      </cad:listarGrupoPessoa>

   </soapenv:Body>

</soapenv:Envelope>


1.3.10.    POST alterarAtividadeCliente

Entendimento: Alterar informações de vínculo do cliente a uma profissão/atividade

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarAtividadeCliente>

         <alterar>

            <codigoCliente>73</codigoCliente>

            <codigoRamoAtividade>3999</codigoRamoAtividade>

            <atividadePrincipal>true</atividadePrincipal>

         </alterar>

      </cad:alterarAtividadeCliente>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMÉRICO

8

SIM

Código Cliente retornado após consulta listarAtividadeCliente

codigoRamoAtividade

NUMERO

10

SIM

Código da profissão ou atividade

*chamar o serviço item (i) e enviar o código conforme a atividade pesquisada.

atividadePrincipal

BOOLEAN

true/false

Sim

Se é Atividade principal


Consulta Atividade do Cliente

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarAtividadeCliente>

         <listar>

            <codigoCliente>73</codigoCliente>

         </listar>

      </cad:listarAtividadeCliente>

   </soapenv:Body>

</soapenv:Envelope>

Itens/Domínios

  • Listar Ramos de Atividades


/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="parametros.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <par:listarRamoAtividades>

         <listar>

           <nomeRamoAtividade>Transporte</nomeRamoAtividade>

           <!--codigoRamoAtividade>3899</codigoRamoAtividade:-->

         </listar>

      </par:listarRamoAtividades>

   </soapenv:Body>

</soapenv:Envelope>

1.3.11.    POST alterarEmprego

Entendimento: Alterar informações do emprego do cliente.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarEmprego>

         <alterar>

            <codigoCliente>73</codigoCliente>

            <codigoUnidade>1</codigoUnidade>

            <numeroSequencial>1</numeroSequencial>

            <tipoOcupacao>ASSALARIADO</tipoOcupacao>

            <indicadorEmpregoAtual>ATUAL</indicadorEmpregoAtual> 

            <dataAdmissao>2020-03-06</dataAdmissao>

            <cicEmpresa>75938477000111</cicEmpresa>

            <nomeEmpresa>DIMENSA S.A.</nomeEmpresa>

            <valorSalarioMensal>10200.00</valorSalarioMensal>

            <descricaoCargo>GERENTE</descricaoCargo>

            <profissao>

               <codigoCbo>083</codigoCbo>

            </profissao>            

         </alterar>

      </cad:alterarEmprego>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMÉRICO

8

SIM

Código Cliente retornado após consulta  listarEmprego

codigoUnidade

NUMERICO

10

SIM

Código da Unidade retornada na consulta

numeroSequencial

NUMERO

10

SIM

Sequencial da listagem de emprego retornado na consulta

tipoOcupacao

CHAR

lista

SIM

Tipo da ocupação retornado na consulta. Ex: ASSALARIADO

* lista item (i) abaixo

indicadorEmpregoAtual

CHAR

10

SIM

Situação de Emprego retornado.

* lista: ATUAL, ANTERIOR ou ADICIONAL

dataAdmissao

DATA

8

NÃO

Data de Admissão no emprego retornada

cicEmpresa

NUMERO

14

NÃO

CNPJ da empresa retornado

nomeEmpresa

CHAR

45

NÃO

Nome da Empresa retornado

valorSalarioMensal

NUMERO

18,2

Não

Salario Mensal do Cliente

descricaoCargo

CHAR

35

NÃO

Cargo do Cliente. Ex: GERENTE

*texto livre, não há validação

profissao

Lista




codigoCbo

NUMERO

7

NÃO

Código CBO da profissão do cliente

*lista serviço item  (ii)


Consulta Empregos do Cliente

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarEmprego>

         <listar>

            <codigoCliente>73</codigoCliente>

         </listar>

      </cad:listarEmprego>

   </soapenv:Body>

</soapenv:Envelope>


 Itens/Domínios

  • Lista Domínios Tipo Ocupação


 <xs:simpleType name="dominioTipoOcupacao">

    <xs:restriction base="xs:string">

      <xs:enumeration value="APOSENTADO_PENSIONISTA"/>

      <xs:enumeration value="ASSALARIADO"/>

      <xs:enumeration value="AUTONOMO"/>

      <xs:enumeration value="OUTROS"/>

      <xs:enumeration value="PROFISSIONAL_LIBERAL"/>

      <xs:enumeration value="SOCIO_PROPRIETARIO"/>

    </xs:restriction>

  </xs:simpleType>




Itens/Domínios

  • Lista Domínios Tipo Ocupação ou parte dela

Pode passar uma descrição ou código CBO


/tfs-basico-service/CadastroService/Parametros


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:par="parametros.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <par:listarCnaes>

         <listar>

            <descricao>Transporte</descricao>

            <!--codigoCnae>H4930202</codigoCnae-->

         </listar>

      </par:listarCnaes>

   </soapenv:Body>

</soapenv:Envelope>


1.3.12.    POST alterarOutraRenda

Entendimento: Alterar informações de outras rendas do cliente do tipo “Outras”.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarOutraRenda>

         <alterar>

            <codigoCliente>{{cliente}}</codigoCliente>

            <sequencial>1</sequencial>

            <descricaoOutraProveniencia>ALUGUEL</descricaoOutraProveniencia>

            <valorOutrasRendas>3000.00</valorOutrasRendas>

            <rendaConjunta>false</rendaConjunta>

            <dominioTipoRenda>ANUAL</dominioTipoRenda>

            <dataDesde>2021-05-09</dataDesde>

            <tipoRendaOutros>

               <codigoTipoRenda>16</codigoTipoRenda>

               <descricaoTipoRenda>Frete</descricaoTipoRenda>

            </tipoRendaOutros>

         </alterar>

      </cad:alterarOutraRenda>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMÉRICO

8

SIM

Código Cliente retornado após consulta listarOutraRenda

sequencial

NUMÉRICO

10

SIM

Número sequencial retornado na consulta

descricaoOutraProveniencia

CHAR

255

SIM

Descrição Outra Renda retorando

Se descricaoOutraProveniencia for diferente de OUTRAS, informar false e não informar campos não obrigatórios abaixo.

Se descricaoOutraProveniencia igual a OUTRAS, informar domínio e demais campos não obrigatórios abaixo.

*lista domínio item (i)

valorOutrasRendas

NUMERO

18,2

SIM

Valor Total da Renda conforme descrição acima

rendaConjunta

BOLLEAN

true/false

SIM

Retorno da consulta. Se false, renda do titular do cadastro, se true, renda do Conjuge.

dominioTipoRenda

CHAR

10

NÃO

Periodicidade da Renda se descricaoOutraProveniencia for OUTRAS.

*Domínios aceitos:

ANUAL, MENSAL, BIMESTRAL, TRIMESTRAL, SEMESTRAL

dataDesde

DATA


NÃO

Data desde quando recebe outra renda se descricaoOutraProveniencia for OUTRAS.

tipoRendaOutros

Lista




codigoTipoRenda

NUMÉRICO

10

NÃO

Código Tipo Renda se descricaoOutraProveniencia for OUTRAS.

*Lista código domínio item (ii) abaixo

descricaoTipoRenda

CHAR

150

NÃO

Descrição do Tipo de Renda Extra se descricaoOutraProveniencia for OUTRAS.

*campo opcional, pode informar somente codigoTipoRenda, Lista domínio item (ii) abaixo


Consulta Outra Renda

/tfs-basico-service/CadastroService/Parametros


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarOutraRenda>

         <listar>

            <codigoCliente>73</codigoCliente>

         </listar>

      </cad:listarOutraRenda>

   </soapenv:Body>

</soapenv:Envelope>


Itens/Domínios

  • Domínio Outra Proveniência


<xs:simpleType name="dominioOutraRenda">

    <xs:restriction base="xs:string">

      <xs:enumeration value="ALUGUEL"/>

      <xs:enumeration value="APOSENTADORIA"/>

      <xs:enumeration value="NAO_POSSUI"/>

      <xs:enumeration value="PENSAO_PROVENDOS"/>

      <xs:enumeration value="OUTRAS"/>

      <xs:enumeration value="OUTRO_EMPREGO"/>

    </xs:restriction>

  </xs:simpleType>



  • Domínio Código Tipo Renda


/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarTipoRenda>

      </cad:listarTipoRenda>

   </soapenv:Body>

</soapenv:Envelope>


1.3.13.    POST alterarReferência

Entendimento: Alterar informações da referência do cliente.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarReferencia>

         <alterar>

            <codigoBem>4</codigoBem>

            <numeroSequencia>2</numeroSequencia>

            <codigoCliente>73</codigoCliente>

            <codigoUnidade>1</codigoUnidade>

            <tipoReferencia>PESSOAL</tipoReferencia>

            <tipoRelacionamento>Amigo(a)</tipoRelacionamento>

            <nomeFonte>JOAQUIM DE SOUZA</nomeFonte>

            <descricaoComentario>Amigo do Manoel</descricaoComentario>

            <telefoneCompleto>5199987722</telefoneCompleto>

         </alterar>

      </cad:alterarReferencia>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoBem

NUMÉRICO

8

SIM

Código Cliente retornado após consulta listarReferencia

numeroSequencia

NUMÉRICO

8

SIM

Código sequencia da referência retornada na consulta

codigoCliente

NUMÉRICO

8

SIM

Código Cliente retornado na consulta

codigoUnidade

NUMÉRICO

4

SIM

Código da unidade da pessoa retornando na consulta

tipoReferencia

CHAR

8

SIM

Tipo de Referência retornado na consulta.

*Lista: PESSOAL ou BANCARIA

tipoRelacionamento

CHAR

20

SIM

Tipo de Relacionamento.

*domínio item (i)

nomeFonte

CHAR

55

Sim

Nome da referência

telefoneCompleto

NUMÉRICO

14

NÃO

Número telefone completo com DDD da referência

descricaoComentario

CHAR

1000

Não

Comentário sobre a referência


Consulta Referências do Cliente

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarReferencia>

         <listar>

            <codigoCliente>73</codigoCliente>

            <!--tipoReferencia>PESSOAL</tipoReferencia:-->

         </listar>

      </cad:listarReferencia>

   </soapenv:Body>

</soapenv:Envelope>


Itens/Domínios

  • Tipo Relacionamento


/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarTipoRelacionamento>

         <listar>

            <!--tipoRelacioanemto>P</tipoRelacioanemto:P=Parente:-->

         </listar>

      </cad:listarTipoRelacionamento>

   </soapenv:Body>

</soapenv:Envelope>


1.3.14.    POST alterarPessoaObservacao

Entendimento: Alterar informações de observações sobre o cliente.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarPessoaObservacao>

         <alterar>

            <codigoCliente>73</codigoCliente>

            <sequenciaHistorico>2</sequenciaHistorico>

            <dataInclusaoHistorico>2021-09-14</dataInclusaoHistorico>

            <descricaoObservacao>Cadastro incluído via serviço - Teste Alteração</descricaoObservacao>

         </alterar>

      </cad:alterarPessoaObservacao>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMÉRICO

8

SIM

Código Cliente retornado após consulta listarPessoaObservacao

sequenciaHistorico

NUMÉRICO

8

SIM

Código sequencial da observação retornado na consulta

dataInclusaoHistorico

DATA

8

SIM

Data de inclusão da observação se retornado ou informar para alterar

descricaoObservacao

CHAR

2000

NÃO

Observação sobre o cliente que deseja alterar/complementar


Consulta Observação do Cliente

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarPessoaObservacao>

         <listar>

            <codigoCliente>73</codigoCliente>

         </listar>

      </cad:listarPessoaObservacao>

   </soapenv:Body>

</soapenv:Envelope>


1.3.15. POST alterarHistoricoParteRelacionada

Entendimento: Alteração da forma de contato do cliente

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarHistoricoParteRelacionada>

         <alterar>

            <numeroSequencial>2</numeroSequencial>

            <codigoCliente>73</codigoCliente>

            <identificadorParteRelacionada>false</identificadorParteRelacionada>

            <dataInicioRelacionamento>2022-03-09</dataInicioRelacionamento>

            <dataFimRelacionamento>2022-06-10</dataFimRelacionamento>

         </alterar>

      </cad:alterarHistoricoParteRelacionada>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

numeroSequencial

NUMERICO

8

SIM

Número sequencial retornado na consulta listarHistoricoParteRelacionada

codigoCliente

NUMERICO

8

SIM

Código do cliente retornado na consulta

identificadorParteRelacionada

BOOLEAN

true/false

SIM

Informar retorno da consulta

dataInicioRelacionamento

DATA

8

SIM

Data início retornada consulat

dataFimRelacionamento

DATA

8

SIM

Informar Data de Fim Relacionamento


Consulta Parte Relacionanda do Cliente

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarHistoricoParteRelacionada>

         <listar>

            <!--numeroSequencial>?</numeroSequencial:-->

            <codigoCliente>{{cliente}}</codigoCliente>

         </listar>

      </cad:listarHistoricoParteRelacionada>

   </soapenv:Body>

</soapenv:Envelope>


1.3.16.    POST alterarBens – Imóvel

Entendimento: Alterar informações dos imóveis do cliente.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarBens>

         <alterar>

            <codigoClienteUnico>73</codigoClienteUnico>

            <codigoBem>1</codigoBem>

            <indicadorLivreOuOnerado>L</indicadorLivreOuOnerado>

            <valorOnus>0</valorOnus>

            <valorMercado>500000.00</valorMercado>

            <descricaoBem>IMOVEIS URBANOS</descricaoBem>

            <siglaUf>RS</siglaUf>

            <nomeBairro>JARDIM BOTANICO</nomeBairro>

            <nomeCidade>PORTO ALEGRE</nomeCidade>

            <codigoTipoBem>2</codigoTipoBem>

         </alterar>

      </cad:alterarBens>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoClienteUnico

NUMÉRICO

8

SIM

Código Cliente retornado após consulta  listarBens

codigoBem

NUMÉRICO

8

SIM

Código sequencial do Bem da pessoa retornado na consulta.

indicadorLivreOuOnerado

BOOLEAN

true/false

SIM

Retorno da consulta. Permite alterar se true possui ônus, informar campo valorOnus, se false, não informar valorOnus

valorOnus

NUMERO

18,2

NÃO

Valor Saldo Devedor Hipoteca/Financiamento

valorMercado

NUMERO

18,2

SIM

Valor de mercado do Bem

descricaoBem

CHAR

35

SIM

Descrição do Bem

siglaUf

CHAR

2

NÃO

UF de localização do bem

nomeBairro

CHAR

72

NÃO

Bairro de localização do bem

nomeCidade

CHAR

72

NÃO

Cidade de localização do bem

codigoTipoBem

NUMÉRICO

4

SIM

Código do tipo de bem

 *lista item (i)


Consulta Bens do Cliente

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarBens>

         <listar>

            <codigoClienteUnico>73</codigoClienteUnico>

            <codigoBem>1</codigoBem> --código do bem tipo imóvel retornado na consulta listarBens

         </listar>

      </cad:listarBens>

   </soapenv:Body>

</soapenv:Envelope>


Itens/Domínios

  • Código Tipo Bem Imóvel


/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarTipoBemImovel>

         <pageable>

         </pageable>

      </cad:listarTipoBemImovel>

   </soapenv:Body>

</soapenv:Envelope>


1.3.17.    POST alterarImovel

Entendimento: Alteração de informações do imóvel do cliente. Este serviço é um complemento ao incluirBens (Tipo Imóveis), como dados de área, registro e escritura, serviço opcional.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarImovel>

         <incluir>

            <codigoClienteUnico>73</codigoClienteUnico>

            <codigoBem>5</codigoBem>

            <areaTerreno>360</areaTerreno>

            <numeroRegistroImovel>777777</numeroRegistroImovel>

            <numeroEscritura>888888</numeroEscritura>

         </alterar>

      </cad:alterarImovel>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoClienteUnico

NUMÉRICO

8

SIM

Código Cliente retornado após listarImovel

codigoBem

NUMÉRICO

8

SIM

Código sequencial do Bem retornado na consulta

areaTerreno

NUMERO

18,2

NÃO

Área do Terreno do Imóvel

numeroRegistroImovel

NUMERO

15

NÃO

Número de registro do Imóvel

numeroEscritura

NUMERO

10

NÃO

Número da escritura do Imóvel


Consulta Imóveis do Cliente

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarImovel>

         <listar>

            <codigoClienteUnico>73</codigoClienteUnico>

         </listar>

      </cad:listarImovel>

   </soapenv:Body>

</soapenv:Envelope>


1.3.18.    POST alterarBens - Veículo

Entendimento: Inclusão dos veículos do cliente

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:alterarBens>

         <alterar>

            <codigoClienteUnico>73</codigoClienteUnico>

            <codigoBem>2</codigoBem>

            <indicadorLivreOuOnerado>L</indicadorLivreOuOnerado>

            <valorOnus>0</valorOnus>

            <valorMercado>200000.00</valorMercado>

            <descricaoBem>AUTOMÓVEL PASSEIO</descricaoBem>

            <siglaUf>RS</siglaUf>

            <nomeBairro>JARDIM BOTANICO</nomeBairro>

            <nomeCidade>PORTO ALEGRE</nomeCidade>

            <codigoTipoBem>5</codigoTipoBem>

         </alterar>

      </cad:alterarBens>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoClienteUnico

NUMÉRICO

8

SIM

Código Cliente retornado após consulta listarBens

codigoBem

NUMÉRICO

8

SIM

Código sequencia do Bem retornando na consulta

indicadorLivreOuOnerado

BOOLEAN

true/false

SIM

Se true possui ônus, informar campo valorOnus

Se false, não informar valorOnus

valorOnus

NUMERO

18,2

NÃO

Valor Saldo Devedor Alienação/Financiamento

valorMercado

NUMERO

18,2

SIM

Valor de mercado do Bem

descricaoBem

CHAR

35

SIM

Descrição do Bem

siglaUf

CHAR

2

NÃO

UF de localização do bem

nomeBairro

CHAR

72

NÃO

Bairro de localização do bem

nomeCidade

CHAR

72

NÃO

Cidade de localização do bem

codigoTipoBem

NUMÉRICO

4

SIM

Código do tipo de bem retornado

*lista item (i)


Consulta Bens do Cliente

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarBens>

         <listar>

            <codigoClienteUnico>73</codigoClienteUnico>

         </listar>

      </cad:listarBens>

   </soapenv:Body>

</soapenv:Envelope>

Itens/Domínios

  • Código Tipo Bem Veículo


/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarTipoBemVeiculo>

         <pageable>

            <page>1</page>

            <size>100</size>

         </pageable>

      </cad:listarTipoBemVeiculo>

   </soapenv:Body>

</soapenv:Envelope>


1.3.19.    POST alterarVeiculo

Entendimento: Alteração de informações do veículo do cliente. Este serviço é um complemento ao incluirBens, com dados complementares do veículo, serviço opcional.

Exemplo XML enviado pela Dimensa (postman Collection):


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:incluirVeiculo>

         <incluir>

            <bens>

               <codigoClienteUnico>{{cliente}}</codigoClienteUnico>

               <codigoBem>2</codigoBem>

               <indicadorLivreOuOnerado>true</indicadorLivreOuOnerado>

               <descricaoBem>VW ID.4</descricaoBem>

            </bens>

            <descricaoMarca>VOLKSWAGEN</descricaoMarca>

            <descricaoModelo>ID.4</descricaoModelo>

            <numeroAnoFabricacao>2021</numeroAnoFabricacao>

            <valorVeiculo>200000.00</valorVeiculo>

            <numeroRenavan>POA9999111</numeroRenavan>

            <numeroChassi>B244449999C</numeroChassi>

            <numeroAnoModelo>2022</numeroAnoModelo>

            <numeroPlacaVeiculo>RSA2J99</numeroPlacaVeiculo>

         </incluir>

      </cad:incluirVeiculo>

   </soapenv:Body>

</soapenv:Envelope>



Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoClienteUnico

NUMÉRICO

8

SIM

Código Cliente retornado após incluir Pessoa

codigoBem

NUMÉRICO

8

SIM

Código sequencia do Bem retornado na consulta

descricaoMarca

CHAR

15

NÃO

Marca do Veículo

*texto livre

descricaoModelo

CHAR

30

NÃO

Modelo do Veículo

*texto livre

numeroAnoFabricacao

NUMERO

4

NÃO

Ano de Fabricação do Veículo

valorVeiculo

NUMERO

18,2

NÃO

Valor do Veículo

numeroRenavan

CHAR

15

NÃO

Renavan do Veículo

numeroChassi

CHAR

20

NÃO

Chassi do Veículo

numeroAnoModelo

NUMERO

4

NÃO

Ano de modelo do Veículo

numeroPlacaVeiculo

CHAR

7

NÃO

Placa do Veículo

descricaoPotencia

CHAR

7

NÃO

Placa do Veículo


Consulta Veículos do Cliente

/tfs-basico-service/CadastroService/Cadastro


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">

   <soapenv:Header/>

   <soapenv:Body>

      <cad:listarVeiculo>

         <listar>

            <codigoClienteUnico>{{cliente}}</codigoClienteUnico>

            <codigoBem>7</codigoBem> --código do bem tipo veículo retornado na consulta listarBens

         </listar>

      </cad:listarVeiculo>

   </soapenv:Body>

</soapenv:Envelope>



  • Sem rótulos