Histórico da Página
...
10.1.2.20:8080/tfs-basico-service/CadastroService/Cadastro
1.
...
1.4.1. POST alterarPessoa
Entendimento: Alteração do cliente PJ.
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:incluirPessoa>
<incluir>
<codigoUnidadeResponsavel>1</codigoUnidadeResponsavel>
<tipoPessoa>J</tipoPessoa>
<codigoCliente>1</codigoCliente>
<nomePessoa>EMPRESA DO JOAO LTDA</nomePessoa>
<numeroCic>48885104000157</numeroCic>
<dataClienteDesde>2019-08-21</dataClienteDesde>
<segmento>1</segmento>
<!--codigoPortaBnds>2</codigoPortaBnds:-->
<codigoPorte>2</codigoPorte>
<nomeContato>MARCOS SOUZA</nomeContato>
<tipoLigacao>NAO_LIGADO</tipoLigacao>
<!--indicadorNivelRelacionamento>false</indicadorNivelRelacionamento:-->
<!--indicadorAtualizacaoCliente>false</indicadorAtualizacaoCliente:-->
<!--identificadorHomonimo>false</identificadorHomonimo:-->
<!--envioInterfaceAlteracaoDados>false</envioInterfaceAlteracaoDados:-->
<identificadorGrupoEconomico>false</identificadorGrupoEconomico>
<indicadorIsencaoIof>false</indicadorIsencaoIof>
<unidadePessoa>
<codigoUnidade>1</codigoUnidade>
<codigoGerente>1</codigoGerente>
<dataConstituicao>2021-12-31</dataConstituicao>
<identificadorSituacao>ATIVO</identificadorSituacao>
<numeroInscricaoEstatudal>1234567</numeroInscricaoEstatudal>
</unidadePessoa>
<pessoaJuridica>
<valorPatrimonioLiquido>500000.00</valorPatrimonioLiquido>
<!--dataUltimoBalancete>2018-12-31</dataUltimoBalancete:-->
<identificadorTipoBalanco>REAL</identificadorTipoBalanco>
<!--identificadorHomonimo>false</identificadorHomonimo:-->
<valorFaturamentoAnual>1000000.00</valorFaturamentoAnual>
<dataClienteDesde>2022-02-22</dataClienteDesde>
<!--codigoNaturezaBndes>11031</codigoNaturezaBndes:-->
<!--codigoPortaBnds>2</codigoPortaBnds:-->
<!--numeroSetor>?</numeroSetor:-->
<codigoPorte>2</codigoPorte>
<!--indicadorNivelRelacionamento>false</indicadorNivelRelacionamento:-->
<!--indicadorAtualizacaoCliente>false</indicadorAtualizacaoCliente:-->
</pessoaJuridica>
</incluir>
</cad:incluirPessoa>
</soapenv:Body>
</soapenv:Envelope>
Campos identificados no XML de Exemplo:
...
Campo
...
Tipo
...
Tamanho
...
Obrigatório
...
Observação
...
codigoUnidadeResponsavel
...
NUMÉRICO
...
10
...
SIM
...
Código da unidade operacional retornado na consulta buscarPessoa
*Lista de unidades item (i) campo codigoUnidadeFisica
...
tipoPessoa
...
CHAR
...
1
...
SIM
...
Domínio: J
...
codigoCliente
...
NUMERICO
...
8
...
SIM
...
Código do cliente retornado na consulta
...
nomePessoa
...
CHAR
...
55
...
SIM
...
Nome do Cliente
...
numeroCic
...
NUMERICO
...
14
...
SIM
...
Número do CNPJ
...
dataClienteDesde
...
DATA
...
8
...
SIM
...
Data de Cadastro do Cliente
...
segmento
...
NUMÉRICO
...
10
...
NÃO
...
Código Segmento da Empresa
*Lista item (ii) usar codigoSegmento
...
codigoPorte
...
CHAR
...
20
...
NÃO
...
Porte da Empresa
*Lista item (iii) usar codigoPorte
...
nomeContato
...
CHAR
...
40
...
NÃO
...
Pessoa de contato na empresa
...
tipoLigacao
...
CHAR
...
10
...
NÃO
...
Ligação com a instituição. Valores: LIGADO, NAO_LIGADO
...
identificadorGrupoEconomico
...
BOOLEAN
...
true/false
...
NÃO
...
Se participa de grupo econômico
...
indicadorIsencaoIof
...
BOOLEAN
...
true/false
...
NÃO
...
Identifica se cliente é isento de IOF
...
unidadePessoa
...
Lista
...
codigoUnidade
...
NUMÉRICO
...
10
...
SIM
...
Código unidade informada campo codigoUnidadeResponsavel
...
codigoGerente
...
NUMÉRICO
...
7
...
NÃO
...
Código Gerente da unidade ou setor da instituição
*Lista item (iv)
...
dataConstituicao
...
DATA
...
8
...
SIM
...
Data de Constituição da empresa
...
identificadorSituacao
...
CHAR
...
20
...
SIM
...
Situação da empresa. Ex: ATIVO
*Domínio item (v)
...
numeroInscricaoEstatudal
...
NUMÉRICO
...
20
...
NÃO
...
Inscrição Estadual da empresa
...
pessoaJuridica
...
Lista
...
valorPatrimonioLiquido
...
NUMERICO
...
18,2
...
NÃO
...
Patrimônio Líquido da empresa
...
identificadorTipoBalanco
...
CHAR
...
10
...
NÃO
...
Tipo de Lucro
Valores aceitos: REAL, PRESUMIDO
...
valorFaturamentoAnual
...
NUMERICO
...
18,2
...
NÃO
...
Valor do Faturamento Anual da empresa
Consulta 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:buscarPessoa>
<codigoCliente>85</codigoCliente>
</cad:buscarPessoa>
</soapenv:Body>
</soapenv:Envelope>
Listas/Domínios
- Unidade
/tfs-basico-service/ParametrosService/Parametros
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:listarUnidadeOperacional xmlns:ns2="parametros.basico.tfs.totvs.com">
<listar>
<codigoEmpresa>1</codigoEmpresa>
</listar>
</ns2:listarUnidadeOperacional>
</soap:Body>
</soap:Envelope>
- Segmento
/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:listarSegmento>
<listar>
<tipoPessoa>J</tipoPessoa>
</listar>
</cad:listarSegmento>
</soapenv:Body>
</soapenv:Envelope>
- Porte
/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:listarPorteClientes>
<listar>
</listar>
</par:listarPorteClientes>
</soapenv:Body>
</soapenv:Envelope>
- 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>
1.4.2. POST alterarEndereco - Empresa
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>85</codigoCliente>
<codigoUnidade>1</codigoUnidade>
<siglaTipoEndereco>EMPRESA</siglaTipoEndereco>
<siglaUf>AC</siglaUf>
<nomeCidade>RIO BRANCO</nomeCidade>
<nomeBairro>CENTRO</nomeBairro>
<codigoCep>69919130</codigoCep>
<nomeLogradouro>BOSQUE</nomeLogradouro>
<numeroEndereco>12</numeroEndereco>
<descricaoComplementoEndereco>SALA 01</descricaoComplementoEndereco>
<enderecoEmail>empresa.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>85</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.4.3. 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>85</codigoCliente>
<codigoUnidade>1</codigoUnidade>
<siglaTipoEndereco>CORRESPONDENCIA</siglaTipoEndereco>
<siglaUf>AC</siglaUf>
<nomeCidade>RIO BRANCO</nomeCidade>
<nomeBairro>CENTRO</nomeBairro>
<codigoCep>69919130</codigoCep>
<nomeLogradouro>BOSQUE</nomeLogradouro>
<numeroEndereco>12</numeroEndereco>
<descricaoComplementoEndereco>SALA 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>85</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.4.4. 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>85</codigoCliente>
</listar>
</cad:listarFormaContato>
</soapenv:Body>
</soapenv:Envelope>
1.4.5. 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>85</codigoCliente>
<codigoTipoContato>S</codigoTipoContato>
<descricaoEmail>joao.empresa@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.4.6. 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>85</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.4.7. 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>85</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>85</codigoCliente>
</listar>
</cad:listarAtividadeCliente>
</soapenv:Body>
</soapenv:Envelope>
Itens/Domínios
- Listar Ramo de Atividade
/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.4.8. POST alterarSocio
Entendimento: Alterar informações dos Sócios da empresa.
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:alterarSocio>
<alterar>
<codigoCliente>85</codigoCliente>
<numeroSequencial>1</numeroSequencial>
<numeroCicSocio>68632104012</numeroCicSocio>
<nomePessoa>JOAO DA SILVA</nomePessoa>
<todasContas>true</todasContas>
<representanteLegal>false</representanteLegal>
<nacionalidade>BRASILEIRA</nacionalidade>
<numeroDocumento>999888555</numeroDocumento>
<percentualParticipacaoCapitalTotal>100</percentualParticipacaoCapitalTotal>
<dataAdministrativaDesdobramento>2000-01-01</dataAdministrativaDesdobramento>
<poderRepresentacao>true</poderRepresentacao>
<poderRepresentacaoConjunto>false</poderRepresentacaoConjunto>
<identificadorSituacao>A</identificadorSituacao>
</alterar>
</cad:alterarSocio>
</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 listarSocio |
codigoUnidade | NUMERICO | 10 | SIM | Unidade retornar na consulta |
numeroSequencia | NUMÉRICO | 8 | SIM | Código sequencia retornado na consulta |
numeroCicSocio | NUMERICO | 14 | NÃO | CPF ou CNPJ do Sócio retornado |
nomePessoa | CHAR | 55 | SIM | Nome ou Razão Social do Sócio |
todasContas | BOOLEAN | true/false | SIM | Enviar true |
representanteLegal | BOOLEAN | true/false | SIM | true se for representante legal ou false se não for |
Nacionalidade | CHAR | 15 | NÃO | Nacionalidade do Sócio da empresa. Ex: BRASIL *texto livre |
numeroDocumento | NUMERICO | 15 | NÃO | Número do documento do sócio |
percentualParticipacaoCapitalTotal | NUMERICO | 5,2 | NÃO | Percentual de participação do sócio na empresa |
dataAdministrativaDesdobramento | DATA | 8 | NÃO | Data entrada sócio |
Consulta Sócios da Empresa
/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>85</codigoCliente>
</listar>
</cad:listarSocio>
</soapenv:Body>
</soapenv:Envelope>
1.4.9. POST alterarReferência - Comercial
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:incluirReferencia>
<incluir>
<codigoCliente>85</codigoCliente>
<codigoBem>1</codigoBem>
<numeroSequencia>1</numeroSequencia>
<tipoReferencia>COMERCIAL</tipoReferencia>
<codigoUnidade>1</codigoUnidade>
<nomeFonte>EMPRESA DO PAULO</nomeFonte>
<numeroDdd>55</numeroDdd>
<numeroTelefone>33446677</numeroTelefone>
<numeroRamal>110</numeroRamal>
<numeroDddCelular>55</numeroDddCelular>
<numeroTelefoneCelular>99992233</numeroTelefoneCelular>
<nomeContato>PAULO</nomeContato>
<enderecoEmail>teste@teste.com.br</enderecoEmail>
</incluir>
</cad:incluirReferencia>
</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 listarReferencia |
codigoBem | NUMÉRICO | 8 | SIM | Código do bem retornado na consulta |
numeroSequencia | NUMÉRICO | 8 | SIM | Código sequencial da referência retornado na consulta |
tipoReferencia | CHAR | 8 | SIM | Tipo de Referência retornado na consulta. Ex: COMERCIAL |
codigoUnidade | NUMERICO | 10 | SIM | Código da unidade retornado |
nomeFonte | CHAR | 55 | SIM | Nome da referência |
numeroDdd | NUMERO | 3 | NÃO | DDD do Telefone |
numeroTelefone | NUMERO | 9 | NÃO | Número do Telefone |
numeroRamal | NUMERO | 4 | NÃO | Número do Ramal |
numeroDddCelular | NUMERO | 3 | NÃO | DDD do Celular |
numeroTelefoneCelular | NUMERO | 9 | NÃO | Número do Celular |
nomeContato | CHAR | 55 | NÃO | Nome do Contato na empresa |
enderecoEmail | CHAR | 100 | NÃO | Endereço de e-mail do cliente |
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>85</codigoCliente>
<tipoReferencia>COMERCIAL</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.4.10. 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>85</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>85</codigoCliente>
</listar>
</cad:listarPessoaObservacao>
</soapenv:Body>
</soapenv:Envelope>
1.4.11. 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>85</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>85</codigoCliente>
</listar>
</cad:listarHistoricoParteRelacionada>
</soapenv:Body>
</soapenv:Envelope>
1.4.12. 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>85</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>85</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.4.13. 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>85</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>85</codigoClienteUnico>
</listar>
</cad:listarImovel>
</soapenv:Body>
</soapenv:Envelope>
1.4.14. 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>85</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>85</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.4.15. 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>85</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>85</codigoClienteUnico>
<codigoBem>7</codigoBem> --código do bem tipo veículo retornado na consulta listarBens
</listar>
</cad:listarVeiculo>
</soapenv:Body>
</soapenv:Envelope>
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.
...