Web service Com.senior.g5.co.ger.cad.favorecido
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.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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.
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
- 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_favorecido?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_cad_favorecido?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_ger_cad_favorecido?wsdl
Portas
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Cadastros - Finanças - Favorecidos
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 1
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:GravarFavorecido> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <dadosGeraisFavorecidos> <codFav>Double</codFav> <tipFav>String</tipFav> <nomFav>String</nomFav> <apeFav>String</apeFav> <eenFav>String</eenFav> <endFav>String</endFav> <numEnd>Integer</numEnd> <cplEnd>String</cplEnd> <cepFav>Integer</cepFav> <cepIni>Integer</cepIni> <baiFav>String</baiFav> <cidFav>String</cidFav> <sigUfs>String</sigUfs> <fonFav>String</fonFav> <faxFav>String</faxFav> <cxaPst>Integer</cxaPst> <intNet>String</intNet> <codBan>String</codBan> <codAge>String</codAge> <ccbFav>String</ccbFav> <tipTcc>Integer</tipTcc> <datCad>DateTime</datCad> <datAtu>DateTime</datAtu> <sitFav>String</sitFav> <contas> <seqBan>Integer</seqBan> <codBan>String</codBan> <tipTcc>Integer</tipTcc> <codAge>String</codAge> <ccbFav>String</ccbFav> </contas> </dadosGeraisFavorecidos> </parameters> </ser:GravarFavorecido> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
dadosGeraisFavorecidos | Set | |
dadosGeraisFavorecidos.codFav | Double | Número do CNPJ ou CPF do favorecido (Obrigatório) |
dadosGeraisFavorecidos.tipFav | String | Tipo favorecido (Obrigatório) |
dadosGeraisFavorecidos.nomFav | String | Nome do favorecido (Obrigatório) |
dadosGeraisFavorecidos.apeFav | String | Nome fantasia do favorecido |
dadosGeraisFavorecidos.eenFav | String | Código do endereço do favorecido |
dadosGeraisFavorecidos.endFav | String | Endereço do favorecido |
dadosGeraisFavorecidos.numEnd | Integer | Número do Endereço do Sacado |
dadosGeraisFavorecidos.cplEnd | String | Complemento do endereço do favorecido (sala, andar, etc.) |
dadosGeraisFavorecidos.cepFav | Integer | CEP do favorecido |
dadosGeraisFavorecidos.cepIni | Integer | Faixa inicial do CEP da cidade do favorecido |
dadosGeraisFavorecidos.baiFav | String | Bairro do favorecido |
dadosGeraisFavorecidos.cidFav | String | Cidade do favorecido |
dadosGeraisFavorecidos.sigUfs | String | Sigla do estado do favorecido |
dadosGeraisFavorecidos.fonFav | String | Número do telefone do favorecido |
dadosGeraisFavorecidos.faxFav | String | Número do FAX do favorecido |
dadosGeraisFavorecidos.cxaPst | Integer | Número da caixa postal do favorecido |
dadosGeraisFavorecidos.intNet | String | Endereço eletrônico (E-Mail) |
dadosGeraisFavorecidos.codBan | String | Código do banco da conta corrente do favorecido |
dadosGeraisFavorecidos.codAge | String | Código da agência do banco da conta corrente do favorecido |
dadosGeraisFavorecidos.ccbFav | String | Número da conta corrente do favorecido no banco |
dadosGeraisFavorecidos.datCad | DateTime | Data do cadastramento do favorecido |
dadosGeraisFavorecidos.datAtu | DateTime | Data da última alteração do cadastro do favorecido |
dadosGeraisFavorecidos.sitFav | String | Situação do favorecido (Obrigatório) |
contas | Set | |
contas.seqBan | Integer | Sequência da Conta bancária |
contas.codBan | String | Código do banco da conta corrente do favorecido |
contas.tipTcc | Integer | Tipo da conta corrente do favorecido |
contas.codAge | String | Código da agência do banco da conta corrente do favorecido |
contas.ccbFav | String | Número da conta corrente do favorecido no banco |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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:GravarFavorecidoResponse> <result> <gridResult> <msgErr>String</msgErr> </gridResult> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:GravarFavorecidoResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
gridResult | Set | Itens de erro |
gridResult.msgErr | String | Erros |
resultado | String | O campo resultado irá retornar as seguintes mensagens:
Execução do serviço sem erros: Inclusão ou Alteração: "OK Execução do serviço com erros: "ERRO". Mensagens do erro, na grid de retorno de erros. |
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" |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Exportar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <identificadorSistema>String</identificadorSistema> <tipoIntegracao>String</tipoIntegracao> <quantidadeRegistros>Integer</quantidadeRegistros> <codFav>Double</codFav> </parameters> </ser:Exportar> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
codEmp | Opcional | (Obrigatório) - Number(004) - Código da Empresa |
codFil | Opcional | (Obrigatório) - Number(005) - Código da Filial |
identificadorSistema | Opcional | (Obrigatório) - String(15) - Identificador de Sistema para Integração |
tipoIntegracao | Opcional | (Obrigatório) - String(001) - Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
quantidadeRegistros | Opcional | (Opcional) - Number(005) - Quantidade de Registros a serem exportados |
codFav | Opcional | (Opcional) - Number(014) - Código do Favorecido |
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:ExportarResponse> <result> <erros> <mensagemErro>String</mensagemErro> </erros> <tipoRetorno>Integer</tipoRetorno> <favorecidos> <codFav>Double</codFav> <tipFav>String</tipFav> <nomFav>String</nomFav> <apeFav>String</apeFav> <endFav>String</endFav> <numEnd>Integer</numEnd> <cplEnd>String</cplEnd> <cepFav>Integer</cepFav> <cepIni>Integer</cepIni> <baiFav>String</baiFav> <cidFav>String</cidFav> <sigUfs>String</sigUfs> <fonFav>String</fonFav> <faxFav>String</faxFav> <cxaPst>Integer</cxaPst> <intNet>String</intNet> <codBan>String</codBan> <tipTcc>Integer</tipTcc> <codAge>String</codAge> <ccbFav>String</ccbFav> <datCad>DateTime</datCad> <datAtu>DateTime</datAtu> <sitFav>String</sitFav> <eenFav>String</eenFav> <seqBan>Integer</seqBan> </favorecidos> <mensagemRetorno>String</mensagemRetorno> <finalizaramRegistros>String</finalizaramRegistros> <numeroLote>Integer</numeroLote> <erroExecucao>String</erroExecucao> </result> </ser:ExportarResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
erros | Opcional | (Opcional) - Lista dos erro |
erros.mensagemErro | Opcional | (Opcional) - Itens da lista de erros |
tipoRetorno | Opcional | (Obrigatório) - Number(001) - Tipo de Retorno de Processamento - Lista: 0 = Processado, -1 = Erro na Solicitação |
favorecidos | Opcional | |
favorecidos.codFav | Opcional | Número do CNPJ ou CPF do favorecido |
favorecidos.tipFav | Opcional | Tipo favorecido |
favorecidos.nomFav | Opcional | Nome do favorecido |
favorecidos.apeFav | Opcional | Nome fantasia do favorecido |
favorecidos.endFav | Opcional | Endereço do favorecido |
favorecidos.numEnd | Opcional | Número do Endereço do Sacado |
favorecidos.cplEnd | Opcional | Complemento do endereço do favorecido (sala, andar, etc.) |
favorecidos.cepFav | Opcional | CEP do favorecido |
favorecidos.cepIni | Opcional | Faixa inicial do CEP da cidade do favorecido |
favorecidos.baiFav | Opcional | Bairro do favorecido |
favorecidos.cidFav | Opcional | Cidade do favorecido |
favorecidos.sigUfs | Opcional | Sigla do estado do favorecido |
favorecidos.fonFav | Opcional | Número do telefone do favorecido |
favorecidos.faxFav | Opcional | Número do FAX do favorecido |
favorecidos.cxaPst | Opcional | Número da caixa postal do favorecido |
favorecidos.intNet | Opcional | Endereço eletrônico (E-Mail) |
favorecidos.codBan | Opcional | Código do banco da conta corrente do favorecido |
favorecidos.tipTcc | Opcional | Tipo de conta |
favorecidos.codAge | Opcional | Código da agência do banco da conta corrente do favorecido |
favorecidos.ccbFav | Opcional | Número da conta corrente do favorecido no banco |
favorecidos.datCad | Opcional | Data do cadastramento do favorecido |
favorecidos.datAtu | Opcional | Data da última alteração do cadastro do favorecido |
favorecidos.sitFav | Opcional | Situação do favorecido |
favorecidos.eenFav | Opcional | Código do endereço do favorecido |
favorecidos.seqBan | Opcional | Sequência da Conta bancária |
mensagemRetorno | Opcional | (Obrigatório) - String(1000) - Mensagem de Retorno de Processamento |
finalizaramRegistros | Opcional | (Obrigatório) - String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
numeroLote | Opcional | Obrigatório - Inteiro - Identificação do Lote de Exportação |
erroExecucao | 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 sucesso; - A mensagem do erro ocorrido no servidor. |