English
Español
Integrações com outros sistemas > Web services > Web services disponíveis no Gestão Empresarial > Com.senior.g5.co.mct.imp.escrituracao.lancamentos.imobiliarias.unidadeimobiliariavendida
Web service Com.senior.g5.co.mct.imp.escrituracao.lancamentos.imobiliarias.unidadeimobiliariavendida
Este web service permite inserir ou excluir as unidades imobiliárias vendidas.
Na inserção o número de lançamento é opcional, nessa situação, o valor é gerado sequencialmente pelo sistema.
Para a exclusão, pode ser informado o número do contrato ao invés do número do lançamento. Nesse caso, todas as unidades imobiliárias vendidas com esse número de contrato serão excluídas.
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.
Campos que representam valores monetários, quantidade e percentual e estão declarados como String
- 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
Exemplo:
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.
Campos que representam valores monetários, quantidade e percentual e não estão declarados como String
- 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
Exemplo:
- 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_mct_imp_escrituracao_lancamentos_imobiliarias_unidadeimobiliariavendida?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mct_imp_escrituracao_lancamentos_imobiliarias_unidadeimobiliariavendida?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_mct_imp_escrituracao_lancamentos_imobiliarias_unidadeimobiliariavendida?wsdl
Portas
Inserir
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Requisição:
<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>
<UnidadeImobiliariaVendida>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<lctUiv>Integer</lctUiv>
<datVen>DateTime</datVen>
<codTns>String</codTns>
<codImo>String</codImo>
<codCli>Integer</codCli>
<tipOpe>Integer</tipOpe>
<numCtr>String</numCtr>
<vlrVen>Double</vlrVen>
<infCom>String</infCom>
<dispositivo>
<codDfs>Integer</codDfs>
</dispositivo>
</UnidadeImobiliariaVendida>
</parameters>
</ser:Inserir>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| unidadeImobiliariaVendida | Set | Opcional | Unidade Imobiliária Vendida |
| unidadeImobiliariaVendida.codEmp | Integer | Opcional | (Obrigatório) - Number(004) - Código da empresa |
| unidadeImobiliariaVendida.codFil | Integer | Opcional | (Obrigatório) - Number(005) - Código da filial |
| unidadeImobiliariaVendida.lctUiv | Integer | Opcional | (Opcional) - Number(009) - Número do lançamento do imóvel |
| unidadeImobiliariaVendida.datVen | DateTime | Opcional | (Obrigatório) - Date(DD/MM/YYYY) - Data da operação de venda da unidade imobiliária. |
| unidadeImobiliariaVendida.codTns | String | Opcional | (Obrigatório) - String(005) - Código da transação da receita do período |
| unidadeImobiliariaVendida.codImo | String | Opcional | (Obrigatório) - String(020) - Código da unidade imobiliária |
| unidadeImobiliariaVendida.codCli | Integer | Opcional | (Obrigatório) - Number(009) - Código do Cliente |
| unidadeImobiliariaVendida.tipOpe | Integer | Opcional | (Obrigatório) - Number(001) - Tipo de operação da venda - [ 1=Venda a Vista de Unidade Concluída;2=Venda a Prazo de Unidade Concluída;3=Venda a Vista de Unidade em Construção;4=Venda a Prazo de Unidade em Construção;5=Outras ] |
| unidadeImobiliariaVendida.numCtr | String | Opcional | (Opcional) - String(090) - Número do contrato da contrato que formaliza a venda |
| unidadeImobiliariaVendida.vlrVen | Double | Opcional | (Opcional) - Number(015,2) - Valor da venda |
| unidadeImobiliariaVendida.infCom | String | Opcional | (Opcional) - String(250) - Informações complementares da unidade imobiliária vendida |
| dispositivo | Set | Opcional | Unidade Imobiliária Vendida - Dispositivos Fiscais |
| dispositivo.codDfs | Integer | Opcional | (Opcional) - Number(006) - Código do dispositivo fiscal |
Resposta:
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>
<codFil>Integer</codFil>
<lctUiv>Integer</lctUiv>
<tipRet>Integer</tipRet>
<msgRet>String</msgRet>
</Retorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:InserirResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Preenchimento | Ajuda |
|---|---|---|---|
| retorno | Set | Opcional | Unidade Imobiliária Vendida |
| retorno.codEmp | Integer | Opcional | Number(004) - Código da empresa |
| retorno.codFil | Integer | Opcional | Number(005) - Código da filial |
| retorno.lctUiv | Integer | Opcional | Number(009) - Número do lançamento do imóvel |
| retorno.numCtr | String | Opcional | String(090) - Número do contrato que formaliza a venda |
| retorno.tipRet | Integer | Opcional | Number(004) - Tipo de Retorno de Processamento: 1 = Processado com sucesso, 2 = Ocorreram erros |
| retorno.msgRet | String | Opcional | String(1000) - Mensagem de Retorno de Processamento |
| erroExecucao | String | Opcional | 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" |
Excluir
Necessita autenticação: Sim.
Situação da versão: Atual.
Versão: 1.
Requisição:
<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>
<UnidadeImobiliariaVendida>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<lctUiv>Integer</lctUiv>
<numCtr>String</numCtr>
</UnidadeImobiliariaVendida>
</parameters>
</ser:Excluir>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| unidadeImobiliariaVendida | Set | Excluir Unidades Imobiliárias Vendidas |
| unidadeImobiliariaVendida.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
| unidadeImobiliariaVendida.codFil | Integer | (Obrigatório) - Number(005) - Código da filial |
| unidadeImobiliariaVendida.lctUiv | Integer | (Opcional) - Number(009) - Número do lançamento do imóvel |
| unidadeImobiliariaVendida.numCtr | String | (Opcional) - String(090) - Número do contrato que formaliza a venda |
Resposta:
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>
<codFil>Integer</codFil>
<lctUiv>Integer</lctUiv>
<numCtr>String</numCtr>
<tipRet>Integer</tipRet>
<msgRet>String</msgRet>
</Retorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExcluirResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| retorno | Set | Unidade Imobiliária Vendida |
| retorno.codEmp | Integer | Number(004) - Código da empresa |
| retorno.codFil | Integer | Number(005) - Código da filial |
| retorno.lctUiv | Integer | Number(009) - Número do lançamento do imóvel |
| retorno.numCtr | String | String(090) - Número do contrato que formaliza a venda |
| retorno.tipRet | Integer | Number(004) - Tipo de Retorno de Processamento: 1 = Excluído 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" |
English
Español
