Árvore de páginas

Versões comparadas

Chave

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

...

10.1.2.20:8080/tfs-basico-service/CadastroService/Cadastro

1.5.      Excluir PF

* caso necessário buscar os dados do cliente pode chamar o serviço listarPessoa conforme item (i) passando CPF, código ou nome e tipo de pessoa F.

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:listarPessoa>

         <listar>

            <!--codigoCliente>{{cliente}}</codigoCliente:-->

            <!--nomePessoa>?</nomePessoa:-->

            <numeroCic>34417939004</numeroCic>

            <tipoPessoa>F</tipoPessoa>

         </listar>

      </cad:listarPessoa>

   </soapenv:Body>

</soapenv:Envelope>

1.5.1.         POST excluirParentescos

Entendimento: Excluir vínculos de Parentescos com o cliente PF.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirParentescos>

         <lista>

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

            <siglaRelacionamento>CONJUGE</siglaRelacionamento>

         </lista>

      </cad:excluirParentescos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

siglaRelacionamento

CHAR

20

SIM

Sigla do relacionamento. Ex: CONJUGE

*informar sigla do retorno da consulta item (i)

Item/Consulta

  • Lista 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>{{cliente}}</codigoCliente>

         </listar>

      </cad:listarParentesco>

   </soapenv:Body>

</soapenv:Envelope>

1.5.2.         POST excluirEnderecos-Residencial

Entendimento: Excluir endereço residencial do cliente PF.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirEnderecos>

         <lista>

            <codigoUnidade>1</codigoUnidade>

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

            <siglaTipoEndereco>RESIDENCIAL</siglaTipoEndereco>

         </lista>

      </cad:excluirEnderecos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

...

Campo

...

Tipo

...

Tamanho

...

Obrigatório

...

Observação

...

codigoUnidade

...

NUMERICO

...

4

...

SIM

...

Código da Unidade

...

codigoCliente

...

NUMERICO

...

8

...

SIM

...

Código do cliente que deseja excluir

...

siglaTipoEndereco

...

CHAR

...

15

...

SIM

...

Tipo do endereço. Ex: RESIDENCIAL

*informar sigla do tipo retorno da consulta item (i)

Anexo exemplo do json dos serviços.

View file
nameCadastro de Clientes - POST.postman_collection.json
height250

Consulta

  • Listar Endereços

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>{{cliente}}</codigoCliente>

            <!--numeroCic></numeroCic:-->

         </listar>

      </cad:listarEndereco>

   </soapenv:Body>

</soapenv:Envelope>

1.5.3.         POST excluirEnderecos-Correspondência

Entendimento: Excluir endereço de correspondência do cliente PF.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirEnderecos>

         <lista>

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

            <codigoUnidade>1</codigoUnidade>

            <siglaTipoEndereco>CORRESPONDENCIA</siglaTipoEndereco>

         </lista>

      </cad:excluirEnderecos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoUnidade

NUMERICO

4

SIM

Código da Unidade

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

siglaTipoEndereco

CHAR

15

SIM

Tipo do endereço. Ex: CORRESPONDENCIA

*informar sigla do tipo retorno da consulta item (i)

Consulta

  • Listar Endereços

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>{{cliente}}</codigoCliente>

            <!--numeroCic></numeroCic:-->

         </listar>

      </cad:listarEndereco>

   </soapenv:Body>

</soapenv:Envelope>

1.5.4.         POST excluirAtividadeClientes

Entendimento: Excluir atividade/profissão do cliente PF.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirAtividadeClientes>

         <lista>

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

            <codigoRamoAtividade>3702</codigoRamoAtividade>

            <!--codigoCnae>?</codigoCnae:-->

            <!--atividadePrincipal>252</atividadePrincipal:-->

         </lista>

      </cad:excluirAtividadeClientes>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

codigoRamoAtividade

NUMERO

10

SIM

Código da profissão ou atividade *informar o código do ramo retorno da consulta item (i)

Consulta

  • Listar Ramos Atividades Clientes

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>{{cliente}}</codigoCliente>

         </listar>

      </cad:listarAtividadeCliente>

   </soapenv:Body>

</soapenv:Envelope>

1.5.5.         POST excluirEmpregos

Entendimento: Excluir emprego do cliente PF.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirEmpregos>

         <lista>

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

            <codigoUnidade>1</codigoUnidade>

            <numeroSequencial>1</numeroSequencial>

         </lista>

      </cad:excluirEmpregos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

codigoUnidade

NUMERICO

4

SIM

Código da Unidade

numeroSequencial

NUMERO

10

SIM

Sequencial da atividade retornada na consulta item (i)

Consulta

  • Listar Endereços 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>{{cliente}}</codigoCliente>

         </listar>

      </cad:listarEmprego>

   </soapenv:Body>

</soapenv:Envelope>

1.5.6.         POST excluirOutrasRendas

Entendimento: Excluir outras rendas do cliente PF

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirOutrasRendas>

         <lista>

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

             <sequencial>1</sequencial>

         </lista>

      </cad:excluirOutrasRendas>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

sequencial

NUMERO

10

SIM

Sequencial da outra renda retornada na consulta item (i)

Consulta

  • Listar Outras Rendas 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:listarOutraRenda>

         <listar>

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

         </listar>

      </cad:listarOutraRenda>

   </soapenv:Body>

</soapenv:Envelope>

1.5.7.         POST excluirFormasContatos

Entendimento: Excluir formas de contato do cliente PF

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirFormasContatos>

         <lista>

            <numeroSequencial>1</numeroSequencial>

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

            <codigoTipoContato>F</codigoTipoContato>

         </lista>

      </cad:excluirFormasContatos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

numeroSequencial

NUMERO

10

SIM

Sequencial do contato retornado na consulta item (i)

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

codigoTipoContato

NUMERO

3

SIM

Codigo do tipo de contato retornado na consulta item (i) para o mesmo sequencial

Consulta

  • Listar Contatos 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:listarFormaContato>

         <listar>

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

         </listar>

      </cad:listarFormaContato>

   </soapenv:Body>

</soapenv:Envelope>

1.5.8.         POST excluirGruposPessoas

Entendimento: Excluir vínculo a um grupo econômico do cliente PF.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirGruposPessoas>

         <lista>

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

            <numeroGrupoEconomico>1</numeroGrupoEconomico>

            <numeroCicBasico>17128318950</numeroCicBasico>

         </lista>

      </cad:excluirGruposPessoas>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

numeroGrupoEconomico

NUMERO

6

SIM

Número de identificação do grupo econômico retornado na consulta item (i)

numeroCicBasico

NUMERO

11

SIM

CPF do Cliente retornado na consulta item (i)

Consulta

  • Listar Grupos Econômico Cliente Participa

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>{{cliente}}</codigoCliente>

            <!--numeroCicBasico></numeroCicBasico:-->

         </listar>

      </cad:listarGrupoPessoa>

   </soapenv:Body>

</soapenv:Envelope>

1.5.9.         POST excluirBens

Entendimento: Excluir bens do cliente PF

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirBens>

         <lista>

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

            <codigoBem>1</codigoBem>

            <codigoTipoBem>5</codigoTipoBem>

         </lista>

      </cad:excluirBens>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoClienteUnico

NUMERICO

8

SIM

Código do cliente que deseja excluir

codigoBem

NUMERICO

8

SIM

Código do bem retornando na consulta item (i)

codigoTipoBem

NUMERICO

4

SIM

Código do tipo de bem retornando na consulta item (i) para o mesmo bem

Consulta

  • Listar 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>{{cliente}}</codigoClienteUnico>

         </listar>

      </cad:listarBens>

   </soapenv:Body>

</soapenv:Envelope>

1.5.10.     POST excluirVeiculos

Entendimento: Excluir veículos do cliente PF

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirVeiculos>

         <lista>

            <bens>

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

               <codigoBem>1</codigoBem>

               <codigoTipoBem>5</codigoTipoBem>

            </bens>

         </lista>

      </cad:excluirVeiculos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoClienteUnico

NUMERICO

8

SIM

Código do cliente que deseja excluir

codigoBem

NUMERICO

8

SIM

Código do bem retornando na consulta item (i)

codigoTipoBem

NUMERICO

4

SIM

Código do tipo de bem retornando na consulta item (i) para o mesmo bem

Consulta

  • Listar Bens 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>

         </listar>

      </cad:listarVeiculo>

   </soapenv:Body>

</soapenv:Envelope>

1.5.11.     POST excluirImoveis

Entendimento: Excluir imóveis do cliente PF

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirImoveis>

         <lista>

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

            <codigoBem>1</codigoBem>

         </lista>

      </cad:excluirImoveis>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoClienteUnico

NUMERICO

8

SIM

Código do cliente que deseja excluir

codigoBem

NUMERICO

8

SIM

Código do bem retornando na consulta item (i)

Consulta

  • Listar Bens 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>{{cliente}}</codigoClienteUnico>

         </listar>

      </cad:listarImovel>

   </soapenv:Body>

</soapenv:Envelope>

1.5.12.     POST excluirReferencias

Entendimento: Excluir referências do cliente PF

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirReferencias>

         <lista>

            <codigoBem>3</codigoBem>

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

            <numeroSequencia>1</numeroSequencia>

            <tipoReferencia>PESSOAL</tipoReferencia>

         </lista>

      </cad:excluirReferencias>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoBem

NUMERICO

8

SIM

Código do bem retornando na consulta item (i)

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

numeroSequencia

NUMERICO

10

SIM

Código da referência retornando na consulta item (i) do mesmo bem

tipoReferencia

CHAR

10

SIM

Tipo de Referência. Ex: PESSOAL

* tipo referência retornado na consulta item (i)

Consulta

  • Listar Bens 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:listarReferencia>

         <listar>

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

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

         </listar>

      </cad:listarReferencia>

   </soapenv:Body>

</soapenv:Envelope>

1.5.13.     POST excluirCertidoesClientes

Entendimento: Excluir Certidões se houver. Ex. INSS.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirCertidoesClientes>

         <lista>

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

            <codigoCertidao>1</codigoCertidao>

         </lista>

      </cad:excluirCertidoesClientes>

   </soapenv:Body>

</soapenv:Envelope>

1.5.14.     POST excluirPessoaObservacaos

Entendimento: Excluir observações do cliente PF.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirPessoaObservacaos>

         <lista>

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

            <sequenciaHistorico>1</sequenciaHistorico>

         </lista>

      </cad:excluirPessoaObservacaos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

sequenciaHistorico

NUMERICO

5

SIM

Código da sequencia do histórico retornado na consulta item (i)

Consulta

  • Listar Observaões Cadastrais 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>{{cliente}}</codigoCliente>

         </listar>

      </cad:listarPessoaObservacao>

   </soapenv:Body>

</soapenv:Envelope>

1.5.15.     POST excluirSeguro

Entendimento: Excluir Seguros cadastrados do cliente.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirSeguro>

         <excluir>

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

             <codigoUnidade>1</codigoUnidade>

            <numeroSequencial>1</numeroSequencial>

         </excluir>

      </cad:excluirSeguro>

   </soapenv:Body>

</soapenv:Envelope>

1.5.16.     POST excluirParticipanteContas

Entendimento: Excluir os participantes PEP.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirParticipanteContas>

         <lista>

            <identificadorSituacao>A</identificadorSituacao>

            <siglaModulo>CC</siglaModulo>

            <siglaProduto>CPPF</siglaProduto>

            <indicadorTipoOperacao>C</indicadorTipoOperacao>

            <numeroOperacao>0000070006</numeroOperacao>

            <codigoUnidade>1</codigoUnidade>

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

            <codigoClienteParticipante>{{cliente}}</codigoClienteParticipante>

         </lista>

      </cad:excluirParticipanteContas>

   </soapenv:Body>

</soapenv:Envelope>

1.5.17.     POST excluirPessoa

Entendimento: Excluir cliente PF.

*Este serviço deve ser o último caso o cliente possuir outros registos acima.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirPessoa>

         <lista>

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

            <codigoUnidadeResponsavel>1</codigoUnidadeResponsavel>

            <nomePessoa>JOAO DA SILVA</nomePessoa>

         </lista>

      </cad:excluirPessoa>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir * caso necessário buscar os dados do cliente pode chamar o serviço listarPessoa conforme item (i) por código, nome ou CPF.

codigoUnidadeResponsavel

NUMERICO

4

SIM

Código da Unidade do Cliente

nomePessoa

CHAR

55

SIM

Nome do Cliente

Consulta

  • Listar 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:listarPessoa>

         <listar>

            <!--codigoCliente>{{cliente}}</codigoCliente:-->

            <!--nomePessoa>?</nomePessoa:-->

            <numeroCic>34417939004</numeroCic>

            <tipoPessoa>F</tipoPessoa>

         </listar>

      </cad:listarPessoa>

   </soapenv:Body>

</soapenv:Envelope>

1.6.      Excluir PJ

* caso necessário buscar os dados do cliente pode chamar o serviço listarPessoa conforme item (i) passando CNPJ, código ou nome e tipo de pessoa J.

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:listarPessoa>

         <listar>

            <!--codigoCliente>{{cliente}}</codigoCliente:-->

            <!--nomePessoa>?</nomePessoa:-->

            <numeroCic>74196880000150</numeroCic>

            <tipoPessoa>J</tipoPessoa>

         </listar>

      </cad:listarPessoa>

   </soapenv:Body>

1.6.1.         POST excluirFormasContatos

Entendimento: Excluir formas de contato com o cliente PJ.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirFormasContatos>

         <lista>

            <numeroSequencial>5</numeroSequencial>

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

            <codigoTipoContato>F</codigoTipoContato>

         </lista>

      </cad:excluirFormasContatos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

numeroSequencial

NUMERO

10

SIM

Sequencial do contato retornado na consulta item (i)

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

codigoTipoContato

NUMERO

3

SIM

Codigo do tipo de contato retornado na consulta item (i) para o mesmo sequencial

Consulta

  • Listar Contatos 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:listarFormaContato>

         <listar>

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

         </listar>

      </cad:listarFormaContato>

   </soapenv:Body>

</soapenv:Envelope>

1.6.2.         POST excluirEnderecos

Entendimento: Excluir endereços do cliente PJ

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirEnderecos>

         <lista>

            <codigoUnidade>1</codigoUnidade>

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

            <siglaTipoEndereco>CORRESPONDENCIA</siglaTipoEndereco>

         </lista>

      </cad:excluirEnderecos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoUnidade

NUMERICO

4

SIM

Código da Unidade

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

siglaTipoEndereco

CHAR

15

SIM

Tipo do endereço. Ex: CORRESPONDENCIA

*sigla do tipo retorno da consulta item (i)

Consulta

  • Listar Endereços

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>{{cliente}}</codigoCliente>

            <!--numeroCic></numeroCic:-->

         </listar>

      </cad:listarEndereco>

   </soapenv:Body>

</soapenv:Envelope>

1.6.3.         POST excluirAtividadeClientes

Entendimento: Excluir o Ramo de Atividade do cliente PJ.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirAtividadeClientes>

         <lista>

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

            <codigoRamoAtividade>3001</codigoRamoAtividade>

         </lista>

      </cad:excluirAtividadeClientes>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

codigoRamoAtividade

NUMERO

10

SIM

Código da profissão ou atividade

*código do ramo retorno da consulta item (i)

Consulta

  • Listar Ramos Atividades Clientes

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>{{cliente}}</codigoCliente>

         </listar>

      </cad:listarAtividadeCliente>

   </soapenv:Body>

</soapenv:Envelope>

1.6.4.         POST excluirSocios

Entendimento: Excluir os sócios do cliente PJ.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirSocios>

         <lista>

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

            <numeroSequencial>1</numeroSequencial>

         </lista>

      </cad:excluirSocios>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

numeroSequencial

NUMERO

10

SIM

Sequencial do sócio retornada na consulta item (i)

Consulta

  • Listar Sócios 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:listarSocio>

         <listar>

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

            <!--Optional:-->

            <!--numeroCicSocio>?</numeroCicSocio:-->

         </listar>

      </cad:listarSocio>

   </soapenv:Body>

</soapenv:Envelope>

1.6.5.         POST excluirGruposPessoas

Entendimento: Excluir os sócios do cliente PJ.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirGruposPessoas>

         <lista>

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

            <numeroGrupoEconomico>1</numeroGrupoEconomico>

            <numeroCicBasico>04311417</numeroCicBasico>

         </lista>

      </cad:excluirGruposPessoas>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir

numeroGrupoEconomico

NUMERO

6

SIM

Número de identificação do grupo econômico retornado na consulta item (i)

numeroCicBasico

NUMERO

11

SIM

CPF do Cliente retornado na consulta item (i)

Consulta

  • Listar Grupos Econômico Cliente Participa

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>{{cliente}}</codigoCliente>

            <!--numeroCicBasico></numeroCicBasico:-->

         </listar>

      </cad:listarGrupoPessoa>

   </soapenv:Body>

</soapenv:Envelope>

1.6.6.         POST excluirPessoa

Entendimento: Excluir cliente PJ.

*Importante: este serviço deve ser o último a executar caso possuir demais dados acima para o mesmo cliente.

Exemplo XML (postman Collection):

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

   <soapenv:Header/>

   <soapenv:Body>

      <cad:excluirPessoa>

         <lista>

            <codigoCliente>40</codigoCliente>

            <codigoUnidadeResponsavel>1</codigoUnidadeResponsavel>

            <nomePessoa>EMPRESA DO MANEOEL LTDA</nomePessoa>

            <!--tipoPessoa>J</tipoPessoa:-->

            <!--numeroCic>04311417000126</numeroCic:-->

         </lista>

      </cad:excluirPessoa>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

codigoCliente

NUMERICO

8

SIM

Código do cliente que deseja excluir * caso necessário buscar os dados do cliente pode chamar o serviço listarPessoa conforme item (i) por código, nome ou CPF.

codigoUnidadeResponsavel

NUMERICO

4

SIM

Código da Unidade do Cliente

nomePessoa

CHAR

55

SIM

Nome do Cliente

Consulta

  • Listar 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:listarPessoa>

         <listar>

            <!--codigoCliente>{{cliente}}</codigoCliente:-->

            <!--nomePessoa>?</nomePessoa:-->

            <numeroCic>74196880000150</numeroCic>

            <tipoPessoa>J</tipoPessoa>

         </listar>

      </cad:listarPessoa>

   </soapenv:Body>

</soapenv:Envelope>

1.7.  Grupo Econômico

1.7.1.        POST incluirGrupoEconômico

Entendimento: Incluir Grupos Econômicos.

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:incluirGrupoEconomico>

         <incluir>

            <numeroGrupoEconomico>2</numeroGrupoEconomico>

            <siglaGrupoEconomico>GRUPO UM</siglaGrupoEconomico>

            <nomeGrupoEconomico>GRUPO UM</nomeGrupoEconomico>

            <codigoCep>90690100</codigoCep>

            <nomeBairro>JARDIM BOTANICO</nomeBairro>

            <nomeLocalidade>PORTO ALEGRE</nomeLocalidade>

            <siglaUf>RS</siglaUf>

            <nomeLogradouro>LIVERPOOL</nomeLogradouro>

            <numeroEndereco>100</numeroEndereco>

            <descricaoComplementoEndereco>SALA 1</descricaoComplementoEndereco>

            <siglaTipoLogradouro>R          </siglaTipoLogradouro>

            <tipoControleAcionario>PN</tipoControleAcionario>

            <!--codigoLocalidadeDne>?</codigoLocalidadeDne:-->

            <siglaPais>BR</siglaPais>

            <dataAtualizacao>2022-07-15</dataAtualizacao>

         </incluir>

      </cad:incluirGrupoEconomico>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

numeroGrupoEconomico

NUMERO

6

SIM

Numero do grupo econômico.

siglaGrupoEconomico

CHAR

15

SIM

Sigla do Grupo Econômico

nomeGrupoEconomico

CHAR

45

SIM

Codigo do tipo de contato retornado na consulta item (i) para o mesmo sequencial

codigoCep

NUMERO

8

NÃO

Código CEP

nomeBairro

CHAR

72

NÃO

Nome do Bairro

nomeLocalidade

CHAR

72

NÃO

Nome Localidade

siglaUf

CHAR

2

NÃO

Sigla da UF

nomeLogradouro

CHAR

72

NÃO

Nome da Rua

numeroEndereco

NUMERO

8

NÃO

Número do endereço

descricaoComplementoEndereco

CHAR

10

NÃO

Nome do Complemento

siglaTipoLogradouro

CHAR

15

NÃO

Sigla do tipo de logradouro.

*consulta item (i)

tipoControleAcionario

CHAR

4

SIM

Sigla do tipo de controle acionário.

*consulta item (ii) enviar o “value”

codigoLocalidadeDne

NUMERO

8

NÃO

Código localidade DNE (Correios)

siglaPais

CHAR

2

NÃO

Sigla do País

dataAtualizacao

DATE

8

SIM

Data da atualização do registro

Consulta

  • Listar 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>

  • Listar Tipo Controle Acionário

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:listarControleAcionario/>

   </soapenv:Body>

</soapenv:Envelope>

1.7.2.        POST alterarGrupoEconômico

Entendimento: Alterar Grupos Econômicos.

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:alterarGrupoEconomico>

         <incluir>

            <numeroGrupoEconomico>2</numeroGrupoEconomico>

            <siglaGrupoEconomico>GRUPO UM</siglaGrupoEconomico>

            <nomeGrupoEconomico>GRUPO UM</nomeGrupoEconomico>

            <codigoCep>90690100</codigoCep>

            <nomeBairro>JARDIM BOTANICO</nomeBairro>

            <nomeLocalidade>PORTO ALEGRE</nomeLocalidade>

            <siglaUf>RS</siglaUf>

            <nomeLogradouro>LIVERPOOL</nomeLogradouro>

            <numeroEndereco>100</numeroEndereco>

            <descricaoComplementoEndereco>SALA 1</descricaoComplementoEndereco>

            <siglaTipoLogradouro>R              </siglaTipoLogradouro>

            <tipoControleAcionario>PN</tipoControleAcionario>

            <!--codigoLocalidadeDne>?</codigoLocalidadeDne:-->

            <siglaPais>BR</siglaPais>

            <dataAtualizacao>2022-07-15</dataAtualizacao>

         </incluir>

      </cad:alterarGrupoEconomico>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

numeroGrupoEconomico

NUMERO

6

SIM

Numero do grupo econômico.

siglaGrupoEconomico

CHAR

15

SIM

Sigla do Grupo Econômico

nomeGrupoEconomico

CHAR

45

SIM

Codigo do tipo de contato retornado na consulta item (i) para o mesmo sequencial

codigoCep

NUMERO

8

NÃO

Código CEP

nomeBairro

CHAR

72

NÃO

Nome do Bairro

nomeLocalidade

CHAR

72

NÃO

Nome Localidade

siglaUf

CHAR

2

NÃO

Sigla da UF

nomeLogradouro

CHAR

72

NÃO

Nome da Rua

numeroEndereco

NUMERO

8

NÃO

Número do endereço

descricaoComplementoEndereco

CHAR

10

NÃO

Nome do Complemento

siglaTipoLogradouro

CHAR

15

NÃO/SIM

Sigla do tipo de logradouro.

*consulta item (i)

tipoControleAcionario

CHAR

4

SIM

Sigla do tipo de controle acionário.

*consulta item (ii) enviar o “value”

codigoLocalidadeDne

NUMERO

8

NÃO/SIM

Código localidade DNE (Correios)

siglaPais

CHAR

2

NÃO/SIM

Sigla do País

dataAtualizacao

DATE

8

SIM

Data da atualização do registro

Consulta

  • Listar 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>

  • Listar Tipo Controle Acionário

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:listarControleAcionario/>

   </soapenv:Body>

</soapenv:Envelope>

1.7.3.        POST excluirGrupoEconômico

Entendimento: Alterar Grupos Econômicos.

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:excluirGruposEconomicos>

         <lista>

            <numeroGrupoEconomico>2</numeroGrupoEconomico>

            <!--siglaGrupoEconomico>ABCD</siglaGrupoEconomico:-->

            <!--nomeGrupoEconomico>GRUPO ACBD</nomeGrupoEconomic:-->

         </lista>

      </cad:excluirGruposEconomicos>

   </soapenv:Body>

</soapenv:Envelope>

Campos identificados no XML de Exemplo:

Campo

Tipo

Tamanho

Obrigatório

Observação

numeroGrupoEconomico

NUMERO

6

SIM

Numero do grupo econômico. A busca do grupo pode ser obtida através da consulta (i)

siglaGrupoEconomico

CHAR

15

NÃO

Sigla do Grupo Econômico

nomeGrupoEconomico

CHAR

45

NÃO

Codigo do tipo de contato retornado na consulta item (i) para o mesmo sequencial

Consulta

  • Listar Grupo Econômico

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:listarGrupoEconomico>

         <listar>

         </listar>

      </cad:listarGrupoEconomico>

   </soapenv:Body>

</soapenv:Envelope>