5.1. POST Excluir Pessoa

Detalhamento das APIs POST para excluir informações de uma Pessoa Física.

Para buscar os dados do cliente pode chamar a API listarPessoa,  informando o CPF, e/ou código de cliente e/ou nome da pessoa 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>
            <!--Optional:-->
            <!--codigoCliente>{{cliente}}</codigoCliente:-->
            <!--nomePessoa>?</nomePessoa:-->
            <numeroCic>34417939004</numeroCic> 
            <tipoPessoa>F</tipoPessoa>
         </listar>
      </cad:listarPessoa>
   </soapenv:Body>
</soapenv:Envelope>

Também é possível caso possuir, consultar a pessoa a partir da API buscarPessoa pelo código do cliente e verificar os dados básico.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cad="cadastro.basico.tfs.totvs.com">
   <soapenv:Header/>
   <soapenv:Body>
      <cad:buscarPessoa>
         <codigoCliente>{{cliente}}</codigoCliente>
      </cad:buscarPessoa>
   </soapenv:Body>
</soapenv:Envelope>

Todas as APIs de exclusão utilizam o código do cliente para execução.

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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>