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.locacaointermediacao
Web service Com.senior.g5.co.mct.imp.escrituracao.lancamentos.imobiliarias.locacaointermediacao
Este web service permite a inclusão ou a exclusão de Locações/Intermediações.
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_locacaointermediacao?wsdl`
- Assíncrono: `http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mct_imp_escrituracao_lancamentos_imobiliarias_locacaointermediacao?wsdl`
- Agendado: `http://example.com/g5-senior-services/sapiens_Schedulecom_senior_g5_co_mct_imp_escrituracao_lancamentos_imobiliarias_locacaointermediacao?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>
<LocacaoIntermediacao>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<numLct>Integer</numLct>
<datLct>DateTime</datLct>
<tipOpe>Integer</tipOpe>
<codImo>String</codImo>
<datCtr>DateTime</datCtr>
<numCtr>String</numCtr>
<codFor>Integer</codFor>
<cnpFor>Double</cnpFor>
<nomFor>String</nomFor>
<codCli>Integer</codCli>
<cnpCli>Double</cnpCli>
<nomCli>String</nomCli>
<vlrLct>Double</vlrLct>
<vlrCom>Double</vlrCom>
<vlrIre>Double</vlrIre>
</LocacaoIntermediacao>
</parameters>
</ser:Inserir>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| locacaoIntermediacao | Set | Requisição de inserção |
| locacaoIntermediacao.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
| locacaoIntermediacao.codFil | Integer | (Obrigatório) - Number (004) - Código da filial |
| locacaoIntermediacao.numLct | Integer | (Opcional) - Number(009) - Número do lançamento (geração automática da numeração) |
| locacaoIntermediacao.datLct | DateTime | (Obrigatório) - Date(DD/MM/YYYY) - Data lançamento |
| locacaoIntermediacao.tipOpe | Integer | (Obrigatório) - Number(001) - Tipo operação |
| locacaoIntermediacao.codImo | String | (Obrigatório) - String(020) - Código da unidade imobiliária |
| locacaoIntermediacao.datCtr | DateTime | (Opcional) - Date(DD/MM/YYYY) - Data do contrato |
| locacaoIntermediacao.numCtr | String | (Opcional) - String(090) - Número do contrato |
| locacaoIntermediacao.codFor | Integer | (Opcional) - Number(009) - Código do fornecedor |
| locacaoIntermediacao.cnpFor | Double | (Opcional) - Number(014) - CNPJ do fornecedor (Obrigatório quando não informado "codFor") |
| locacaoIntermediacao.nomFor | String | (Opcional) - String(150) - Nome do fornecedor (Obrigatório quando não informado "codFor") |
| locacaoIntermediacao.codCli | Integer | (Opcional) - Number(009) - Código do cliente |
| locacaoIntermediacao.cnpCli | Double | (Opcional) - Number(014) - CNPJ do cliente (Obrigatório quando não informado "codCli") |
| locacaoIntermediacao.nomCli | String | (Opcional) - String(150) - Nome do cliente (Obrigatório quando não informado "codCli") |
| locacaoIntermediacao.vlrLct | Double | (Opcional) - Number(15,2) - Valor lançamento |
| locacaoIntermediacao.vlrCom | Double | (Opcional) - Number(15,2) - Valor comissão |
| locacaoIntermediacao.vlrIre | Double | (Opcional) - Number(15,2) - Valor imposto retido> |
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>
<numLct>Integer</numLct>
<tipRet>Integer</tipRet>
<msgRet>String</msgRet>
</Retorno>
<erroExecucao>String</erroExecucao>
</result>
</ser:InserirResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Tipo | Descrição |
|---|---|---|
| retorno | Set | Retorno da inserção |
| retorno.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
| retorno.codFil | Integer | (Obrigatório) - Number(005) - Código da filial |
| retorno.numLct | Integer | (Obrigatório) - Number(009) - Número do lançamento gerado |
| retorno.tipRet | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| retorno.msgRet | String | (Obrigatório) - 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" |
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>
<LocacaoIntermediacao>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<numLct>Integer</numLct>
<numCtr>String</numCtr>
</LocacaoIntermediacao>
</parameters>
</ser:Excluir>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Tipo | Descrição |
|---|---|---|
| locacaoIntermediacao | Set | Requisição de exclusão |
| locacaoIntermediacao.codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
| locacaoIntermediacao.codFil | Integer | (Obrigatório) - Number (004) - Código da filial |
| locacaoIntermediacao.numLct | Integer | (Opcional) - Number(009) - Número do lançamento (quando não informado irá buscar pelo "numCtr") |
| locacaoIntermediacao.numCtr | String | (Opcional) - String(090) - Número do contrato (quando informado apenas "numCtr" e possui várias registros irá retornar mensagem que não conseguiu excluir devido existência de várias registros) |
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>
<numLct>Integer</numLct>
<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 | Retorno da exclusão |
| retorno.codEmp | Integer | Number(004) - Código da empresa |
| retorno.codFil | Integer | (Obrigatório) - Number (004) - Código da filial |
| retorno.numLct | Integer | (Opcional) - Number(009) - Número do lançamento |
| retorno.numCtr | String | (Opcional) - String(090) - Número do contrato |
| retorno.tipRet | Integer | (Obrigatório) - Número(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| retorno.msgRet | String | (Obrigatório) - 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
