Web service Com.senior.g5.co.ger.cad.controladoria.tributos.unidadeimobiliaria
Este web service permite incluir, alterar ou excluir as unidades imobiliárias.
Tipo de execução
Para cada tipo de execução, existem diferentes parâmetros que podem ser comuns a todas as portas.
Autenticação
Caso seja utilizada alguma forma de autenticação para integração de informações através de web services, é necessário identificar o tipo no parâmetro <encryption>, conforme seus valores possíveis.
Campos numéricos
Orientação válida para qualquer campo de web service que possui objetivo de receber valores, independentemente do seu tipo ser Integer, Double e String. Estas orientações devem ser seguidas nas requisições efetuadas via SOAP e em execuções efetuadas através do SGI, relatórios e regras LSP.
- Envio no formato ZZZZ,ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com vírgula, e não com ponto
- Obrigatória a utilização do zero a direita. Por exemplo, se o valor for 350,20, a requisição deve ser enviada com este exato valor. Se o valor enviado for enviado como 350,2, o sistema não irá interpretar a requisição adequadamente
number(005,2) = 350,20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
number(015,2): 35000,20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
number(008,4) = 3200,2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
- Envio no formato ZZZZ.ZZ
- É fundamental não enviar os campos numéricos com separador de milhar, pois ocorrerá erro ao executar a requisição
- Obrigatória a utilização do separador decimal com ponto, e não com vírgula
- number(005,2) = 350.20 - o sistema espera que o número digitado contenha até 3 casas antes da vírgula e obrigatoriamente duas após;
- number(015,2): 35000.20 - o sistema espera que o número digitado contenha até 13 casas antes da vírgula e obrigatoriamente duas após;
- number(008,4) = 3200.2074 - o sistema espera que o número digitado contenha até 4 casas antes da vírgula e obrigatoriamente duas após.
WSDL
- Síncrono: http://example.com/g5-senior-services/sapiens_Synccom_senior_g5_co_ger_cad_controladoria_tributos_unidadeimobiliaria?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_cad_controladoria_tributos_unidadeimobiliaria?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_ger_cad_controladoria_tributos_unidadeimobiliaria?wsdl
Portas
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 2.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Inserir> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <UnidadeImobiliaria> <codEmp>Integer</codEmp> <codImo>String</codImo> <nomImo>String</nomImo> <tipUni>Integer</tipUni> <desImo>String</desImo> <natImo>Integer</natImo> <tipImo>String</tipImo> <tipImv>Integer</tipImv> <cepImo>Integer</cepImo> <endImo>String</endImo> <numEnd>String</numEnd> <cplEnd>String</cplEnd> <baiImo>String</baiImo> <cidImo>String</cidImo> <sigUfs>String</sigUfs> <codPai>String</codPai> <regTri>String</regTri> <codPri>String</codPri> <codPrc>String</codPrc> <areUco>Double</areUco> <areTco>Double</areTco> <areTer>Double</areTer> <qtdGar>Integer</qtdGar> <qtdDor>Integer</qtdDor> <qtdBan>Integer</qtdBan> <sitImo>String</sitImo> </UnidadeImobiliaria> </parameters> </ser:Inserir> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Preenchimento | Ajuda |
---|---|---|---|
unidadeImobiliaria | Set | Opcional | Unidade Imobiliária |
unidadeImobiliaria.codEmp | Integer | Opcional | Number(004) - Código da empresa |
unidadeImobiliaria.codImo | String | Opcional | String(020) - Código da unidade imobiliária |
unidadeImobiliaria.nomImo | String | Opcional | String(100) - Nome da unidade imobiliária |
unidadeImobiliaria.tipUni | Integer | Opcional | Number(002) - Indica o tipo da unidade imobiliária - [ 01=Terreno Adquirido para Venda;02=Terreno Decorrente de Loteamento;03=Lote Oriundo de Desmembramento de Terreno;04=Unidade Resultante de Incorporação Imobiliária;05=Prédio Construído/Em Construção para Venda;06=Outras ] |
unidadeImobiliaria.desImo | String | Opcional | String(250) - Descrição resumida sobre as informações relevantes da unidade imobiliária |
unidadeImobiliaria.natImo | Integer | Opcional | Number(001) - Indica a natureza do empreendimento - [ 1=Consórcio;2=SCP;3=Incorporação em Condomínio;4=Outras ] |
unidadeImobiliaria.tipImo | String | Opcional | String(001) - Tipo do imóvel (DIMOB) - [ U=Imóvel Urbano;R=Imóvel Rural ] |
unidadeImobiliaria.tipImv | Integer | Opcional | Number(002) - Tipo imóvel - [ 01=Terreno;02=Residencial horizontal;03=Residencial vertical;04=Comercial horizontal;05=Comercial vertical;06=Barracão/Telheiro;07=Oficina;08=Posto de serviço;09=Armazém/Depósito;10=Indústria;11=Edifício de garagens - Prédio Vertical;12=Templo;13=Clube;14=Ginásio ou estádio esportivos;15=Hipódromo;16=Estação ferroviária;17=Estação rodoviária;18=Estação metroviária;19=Aeroporto;20=Central de abastecimento;21=Mercado municipal;22=Teatro;23=Cinema;24=Museu;25=Parque de diversão;26=Parque zoológico;27=Reservatório ] |
unidadeImobiliaria.cepImo | Integer | Opcional | Number(008) - CEP do imóvel |
unidadeImobiliaria.endImo | String | Opcional | String(100) - Endereço do imóvel |
unidadeImobiliaria.numEnd | String | Opcional | String(060) - Número do endereço de entrega do cliente |
unidadeImobiliaria.cplEnd | String | Opcional | String(200) - Complemento do endereço do imóvel |
unidadeImobiliaria.baiImo | String | Opcional | String(075) - Bairro do imóvel |
unidadeImobiliaria.cidImo | String | Opcional | String(060) - Cidade do imóvel |
unidadeImobiliaria.sigUfs | String | Opcional | String(002) - Sigla do estado do imóvel |
unidadeImobiliaria.codPai | String | Opcional | String(004) - Código do país do imóvel |
unidadeImobiliaria.regTri | String | Opcional | String(001) - Indica o regime tributário aplicável sobre o imóvel - [ C=Regime Cumulativo;U=Regime Não Cumulativo;N=Nenhum ] |
unidadeImobiliaria.codPri | String | Opcional | String(004) - Código da tabela de presunção IRPJ |
unidadeImobiliaria.codPrc | String | Opcional | String(004) - Código da tabela de presunção CSLL |
unidadeImobiliaria.areUco | Double | Opcional | Number(015,2) - Área útil construída |
unidadeImobiliaria.areTco | Double | Opcional | Number(015,2) - Área total construída |
unidadeImobiliaria.areTer | Double | Opcional | Number(015,2) - Área terreno |
unidadeImobiliaria.qtdGar | Integer | Opcional | Number(003) - Quantidade garagem |
unidadeImobiliaria.qtdDor | Integer | Opcional | Number(003) - Quantidade dormitórios |
unidadeImobiliaria.qtdBan | Integer | Opcional | Number(003) - Quantidade banheiros |
unidadeImobiliaria.sitImo | String | Opcional | String(001) - Situação do imóvel - [ A=Ativo;I=Inativo ] |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:InserirResponse> <result> <Retorno> <codEmp>Integer</codEmp> <codImo>String</codImo> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </Retorno> <erroExecucao>String</erroExecucao> </result> </ser:InserirResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
retorno | Set | Unidade Imobiliária |
retorno.codEmp | Integer | Number(004) - Código da empresa |
retorno.codImo | String | String(020) - Código da unidade imobiliária |
retorno.tipRet | Integer | Number(004) - Tipo de Retorno de Processamento: 1 = Processado com sucesso, 2 = Ocorreram erros |
retorno.msgRet | String | String(1000) - Mensagem de Retorno de Processamento |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Inserir> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <UnidadeImobiliaria> <codEmp>Integer</codEmp> <codImo>String</codImo> <nomImo>String</nomImo> <tipUni>Integer</tipUni> <desImo>String</desImo> <natImo>Integer</natImo> <tipImo>String</tipImo> <cepImo>Integer</cepImo> <endImo>String</endImo> <numEnd>String</numEnd> <cplEnd>String</cplEnd> <baiImo>String</baiImo> <cidImo>String</cidImo> <sigUfs>String</sigUfs> <codPai>String</codPai> <regTri>String</regTri> <codPri>String</codPri> <codPrc>String</codPrc> <sitImo>String</sitImo> </UnidadeImobiliaria> </parameters> </ser:Inserir> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
unidadeImobiliaria | Set | Unidade Imobiliária |
unidadeImobiliaria.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
unidadeImobiliaria.codImo | String | (Obrigatório) - String(020) - Código da unidade imobiliária |
unidadeImobiliaria.nomImo | String | (Opcional) - String(100) - Nome da unidade imobiliária |
unidadeImobiliaria.tipUni | Integer | (Opcional) - Number(002) - Indica o tipo da unidade imobiliária - [ 01=Terreno Adquirido para Venda;02=Terreno Decorrente de Loteamento;03=Lote Oriundo de Desmembramento de Terreno;04=Unidade Resultante de Incorporação Imobiliária;05=Prédio Construído/Em Construção para Venda;06=Outras ] |
unidadeImobiliaria.desImo | String | (Opcional) - String(250) - Descrição resumida sobre as informações relevantes da unidade imobiliária |
unidadeImobiliaria.natImo | Integer | (Opcional) - Number(001) - Indica a natureza do empreendimento - [ 1=Consórcio;2=SCP;3=Incorporação em Condomínio;4=Outras ] |
unidadeImobiliaria.tipImo | String | (Opcional) - String(001) - Tipo do imovél - [ U=Imóvel Urbano;R=Imóvel Rural ] |
unidadeImobiliaria.cepImo | Integer | (Opcional) - Number(008) - CEP do imóvel |
unidadeImobiliaria.endImo | String | (Opcional) - String(100) - Endereço do imóvel |
unidadeImobiliaria.numEnd | String | (Opcional) - String(060) - Número do endereço de entrega do cliente |
unidadeImobiliaria.cplEnd | String | (Opcional) - String(200) - Complemento do endereço do imóvel |
unidadeImobiliaria.baiImo | String | (Opcional) - String(075) - Bairro do imóvel |
unidadeImobiliaria.cidImo | String | (Opcional) - String(060) - Cidade do imóvel |
unidadeImobiliaria.sigUfs | String | (Opcional) - String(002) - Sigla do estado do imóvel |
unidadeImobiliaria.codPai | String | (Opcional) - String(004) - Código do país do imóvel |
unidadeImobiliaria.regTri | String | (Opcional) - String(001) - Indica o regime tributário aplicável sobre o imóvel - [ C=Regime Cumulativo;U=Regime Não Cumulativo;N=Nenhum ] |
unidadeImobiliaria.codPri | String | (Opcional) - String(004) - Código da tabela de presunção IRPJ |
unidadeImobiliaria.codPrc | String | (Opcional) - String(004) - Código da tabela de presunção CSLL |
unidadeImobiliaria.sitImo | String | (Opcional) - String(001) - Situação do imóvel - [ A=Ativo;I=Inativo ] |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:InserirResponse> <result> <Retorno> <codEmp>Integer</codEmp> <codImo>String</codImo> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </Retorno> <erroExecucao>String</erroExecucao> </result> </ser:InserirResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
retorno | Set | Unidade Imobiliária |
retorno. | Integer | Number(004) - Código da empresa |
retorno. | String | String(020) - Código da unidade imobiliária |
retorno. | Integer | Number(004) - Tipo de Retorno de Processamento: 1 = Processado com sucesso, 2 = Ocorreram erros |
retorno. | String | String(1000) - Mensagem de Retorno de Processamento |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 2.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Alterar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <UnidadeImobiliaria> <codEmp>Integer</codEmp> <codImo>String</codImo> <nomImo>String</nomImo> <tipUni>Integer</tipUni> <desImo>String</desImo> <natImo>Integer</natImo> <tipImo>String</tipImo> <tipImv>Integer</tipImv> <cepImo>Integer</cepImo> <endImo>String</endImo> <numEnd>String</numEnd> <cplEnd>String</cplEnd> <baiImo>String</baiImo> <cidImo>String</cidImo> <sigUfs>String</sigUfs> <codPai>String</codPai> <regTri>String</regTri> <codPri>String</codPri> <codPrc>String</codPrc> <areUco>Double</areUco> <areTco>Double</areTco> <areTer>Double</areTer> <qtdGar>Integer</qtdGar> <qtdDor>Integer</qtdDor> <qtdBan>Integer</qtdBan> <sitImo>String</sitImo> </UnidadeImobiliaria> </parameters> </ser:Alterar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
unidadeImobiliaria | Set | Unidade Imobiliária |
unidadeImobiliaria.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
unidadeImobiliaria.codImo | String | (Obrigatório) - String(020) - Código da unidade imobiliária |
unidadeImobiliaria.nomImo | String | (Opcional) - String(100) - Nome da unidade imobiliária |
unidadeImobiliaria.tipUni | Integer | (Opcional) - Number(002) - Indica o tipo da unidade imobiliária - [ 01=Terreno Adquirido para Venda;02=Terreno Decorrente de Loteamento;03=Lote Oriundo de Desmembramento de Terreno;04=Unidade Resultante de Incorporação Imobiliária;05=Prédio Construído/Em Construção para Venda;06=Outras ] |
unidadeImobiliaria.desImo | String | (Opcional) - String(250) - Descrição resumida sobre as informações relevantes da unidade imobiliária |
unidadeImobiliaria.natImo | Integer | (Opcional) - Number(001) - Indica a natureza do empreendimento - [ 1=Consórcio;2=SCP;3=Incorporação em Condomínio;4=Outras ] |
unidadeImobiliaria.tipImo | String | (Opcional) - String(001) - Tipo do imovél - [ U=Imóvel Urbano;R=Imóvel Rural ] |
unidadeImobiliaria.tipImv | String | Number(002) - Tipo imóvel - [ 01=Terreno;02=Residencial horizontal;03=Residencial vertical;04=Comercial horizontal;05=Comercial vertical;06=Barracão/Telheiro;07=Oficina;08=Posto de serviço;09=Armazém/Depósito;10=Indústria;11=Edifício de garagens - Prédio Vertical;12=Templo;13=Clube;14=Ginásio ou estádio esportivos;15=Hipódromo;16=Estação ferroviária;17=Estação rodoviária;18=Estação metroviária;19=Aeroporto;20=Central de abastecimento;21=Mercado municipal;22=Teatro;23=Cinema;24=Museu;25=Parque de diversão;26=Parque zoológico;27=Reservatório ] |
unidadeImobiliaria.cepImo | Integer | (Opcional) - Number(008) - CEP do imóvel |
unidadeImobiliaria.endImo | String | (Opcional) - String(100) - Endereço do imóvel |
unidadeImobiliaria.numEnd | String | (Opcional) - String(060) - Número do endereço de entrega do cliente |
unidadeImobiliaria.cplEnd | String | (Opcional) - String(200) - Complemento do endereço do imóvel |
unidadeImobiliaria.baiImo | String | (Opcional) - String(075) - Bairro do imóvel |
unidadeImobiliaria.cidImo | String | (Opcional) - String(060) - Cidade do imóvel |
unidadeImobiliaria.sigUfs | String | (Opcional) - String(002) - Sigla do estado do imóvel |
unidadeImobiliaria.codPai | String | (Opcional) - String(004) - Código do país do imóvel |
unidadeImobiliaria.regTri | String | (Opcional) - String(001) - Indica o regime tributário aplicável sobre o imóvel - [ C=Regime Cumulativo;U=Regime Não Cumulativo;N=Nenhum ] |
unidadeImobiliaria.codPri | String | (Opcional) - String(004) - Código da tabela de presunção IRPJ |
unidadeImobiliaria.codPrc | String | (Opcional) - String(004) - Código da tabela de presunção CSLL |
unidadeImobiliaria.areUco | Double | Number(015,2) - Área útil construída |
unidadeImobiliaria.areTco | Double | Number(015,2) - Área total construída |
unidadeImobiliaria.areTer | Double | Number(015,2) - Área terreno |
unidadeImobiliaria.qtdGar | Integer | Number(003) - Quantidade garagem |
unidadeImobiliaria.qtdDor | Integer | Number(003) - Quantidade dormitórios |
unidadeImobiliaria.qtdBan | Integer | Number(003) - Quantidade banheiros |
unidadeImobiliaria.sitImo | String | (Opcional) - String(001) - Situação do imóvel - [ A=Ativo;I=Inativo ] |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:AlterarResponse> <result> <Retorno> <codEmp>Integer</codEmp> <codImo>String</codImo> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </Retorno> <erroExecucao>String</erroExecucao> </result> </ser:AlterarResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
retorno | Set | Unidade Imobiliária |
retorno. | Integer | Opcional | Number(004) - Código da empresa |
retorno. | String | String(020) - Código da unidade imobiliária |
retorno. | Integer | Number(004) - Tipo de Retorno de Processamento: 1 = Processado com sucesso, 2 = Ocorreram erros |
retorno. | String | String(1000) - Mensagem de Retorno de Processamento |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Excluir> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <UnidadeImobiliaria> <codEmp>Integer</codEmp> <codImo>String</codImo> </UnidadeImobiliaria> </parameters> </ser:Excluir> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
unidadeImobiliaria | Set | Unidade Imobiliária |
unidadeImobiliaria. | Integer | Number(004) - Código da empresa |
unidadeImobiliaria. | String | String(020) - Código da unidade imobiliária |
Observação
Envelope SOAP de resposta de requisições síncronas. Para requisições assíncronas ou agendamentos, a resposta é apenas uma String chamada "result" com o valor "OK", se foi executado com sucesso ou, caso contrário, a mensagem do erro ocorrido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExcluirResponse> <result> <Retorno> <codEmp>Integer</codEmp> <codImo>String</codImo> <tipRet>Integer</tipRet> <msgRet>String</msgRet> </Retorno> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
retorno | Set | Retorno |
retorno. | Integer | Number(004) - Código da empresa |
retorno. | String | String(020) - Código da unidade imobiliária |
retorno. | Integer | Number(004) - Tipo de Retorno de Processamento: 1 = Processado com sucesso, 2 = Ocorreram erros |
retorno. | String | String(1000) - Mensagem de Retorno de Processamento |
erroExecucao | String | Indica erros ocorridos no servidor ao executar o serviço, podendo conter os seguintes valores:Vazio ou nulo, indicando que a execução foi feita com sucessoA mensagem do erro ocorrido no servidorSó impede a gravação quando o retorno.tipRet for igual a "2" |