Web service Com.senior.g5.co.ger.cad.sacado
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_ger_cad_sacado?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_cad_sacado?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_ger_cad_sacado?wsdl
Portas
GravarSacado
Cadastros - Finanças - Sacados
Necessita autenticação: Sim
Situação de 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:GravarSacado>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<dadosGeraisSacados>
<codSac>String</codSac>
<tipSac>String</tipSac>
<nomSac>String</nomSac>
<apeSac>String</apeSac>
<sitSac>String</sitSac>
<eenSac>String</eenSac>
<cepSac>String</cepSac>
<cepIni>String</cepIni>
<endSac>String</endSac>
<numEnd>Integer</numEnd>
<cplEnd>String</cplEnd>
<baiSac>String</baiSac>
<cidSac>String</cidSac>
<sigUfs>String</sigUfs>
<fonSac>String</fonSac>
<faxSac>String</faxSac>
<cxaPst>Integer</cxaPst>
<intNet>String</intNet>
<eenCob>String</eenCob>
<endCob>String</endCob>
<cplCob>String</cplCob>
<cepCob>String</cepCob>
<cidCob>String</cidCob>
<estCob>String</estCob>
<nenCob>String</nenCob>
<baiCob>String</baiCob>
<iniCob>String</iniCob>
<datCad>String</datCad>
<datAtu>String</datAtu>
<celSac>String</celSac>
<sacBlo>String</sacBlo>
<motBlo>String</motBlo>
<contas>
<seqBan>Integer</seqBan>
<codBan>String</codBan>
<codAge>String</codAge>
<ccbSac>String</ccbSac>
</contas>
</dadosGeraisSacados>
</parameters>
</ser:GravarSacado>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:| Nome | Tipo | Descrição |
|---|---|---|
| dadosGeraisSacados | Set | Dados gerais do sacado |
| dadosGeraisSacados.codSac | String | (Obrigatório) - String(014) - Número do CNPJ ou CPF do sacado |
| dadosGeraisSacados.tipSac | String | (Obrigatório) - String(001) - Tipo do sacado - Lista: J = Pessoa Jurídica, F = Pessoa Física |
| dadosGeraisSacados.nomSac | String | (Obrigatório) - String(040) - Nome do sacado |
| dadosGeraisSacados.apeSac | String | (Opcional) - String(020) - Nome fantasia do sacado |
| dadosGeraisSacados.sitSac | String | (Obrigatório) - String(001) - Situação do sacado - Lista: A = Ativo, I = Inativo |
| dadosGeraisSacados.eenSac | String | (Opcional) - String(018) - Código do endereço do sacado |
| dadosGeraisSacados.cepSac | String | (Opcional) - String(008) - CEP do sacado |
| dadosGeraisSacados.cepIni | String | (Opcional) - String(008) - Faixa inicial do CEP da cidade do sacado |
| dadosGeraisSacados.endSac | String | (Opcional) - String(035) - Endereço do sacado |
| dadosGeraisSacados.numEnd | Integer | (Opcional) - Number(005) - Número do Endereço do Sacado |
| dadosGeraisSacados.cplEnd | String | (Opcional) - String(060) - Complemento do endereço do sacado (sala, andar, etc.) |
| dadosGeraisSacados.baiSac | String | (Opcional) - String(075) - Bairro do sacado |
| dadosGeraisSacados.cidSac | String | (Opcional) - String(060) - Cidade do sacado |
| dadosGeraisSacados.sigUfs | String | (Opcional) - String(002) - Sigla do estado do sacado |
| dadosGeraisSacados.fonSac | String | (Opcional) - String(020) - Número do telefone do sacado |
| dadosGeraisSacados.faxSac | String | (Opcional) - String(020) - Número do FAX do sacado |
| dadosGeraisSacados.cxaPst | Integer | (Opcional) - Number(006) - Número da caixa postal do sacado |
| dadosGeraisSacados.intNet | String | (Opcional) - String(100) - Endereço eletrônico (E-Mail) |
| dadosGeraisSacados.eenCob | String | (Opcional) - String(018) - Código do endereço de cobrança do sacado |
| dadosGeraisSacados.endCob | String | (Opcional) - String(100) - Endereço de cobrança do sacado |
| dadosGeraisSacados.cplCob | String | (Opcional) - String(060) - Complemento do endereço de cobrança do sacado |
| dadosGeraisSacados.cepCob | String | (Opcional) - String(008) - CEP do endereço de cobrança do sacado |
| dadosGeraisSacados.cidCob | String | (Opcional) - String(060) - Cidade do endereço de cobrança do sacado |
| dadosGeraisSacados.estCob | String | (Opcional) - String(002) - Estado do endereço de cobrança do sacado |
| dadosGeraisSacados.nenCob | String | (Opcional) - String(060) - Número do Endereço de Cobrança do Sacado |
| dadosGeraisSacados.baiCob | String | (Opcional) - String(075) - Bairro de cobrança do sacado |
| dadosGeraisSacados.iniCob | String | (Opcional) - String(008) - Faixa inicial do CEP do endereço de cobrança do sacado |
| dadosGeraisSacados.datCad | DateTime | (Opcional) - Date(000) - Data do cadastramento do sacado |
| dadosGeraisSacados.datAtu | DateTime | (Opcional) - Date(000) - Data da última alteração do cadastro do sacado |
| dadosGeraisSacados.celSac | String | (Opcional) - String(020) - Número do telefone celular do sacado |
| dadosGeraisSacados.sacBlo | String | (Opcional) - String(001) - Indicativo para Sacado Bloqueado - Lista: S = Sim, N = Não |
| dadosGeraisSacados.motBlo | String | (Opcional) - String(150) - Descrição do Motivo do Bloqueio |
| dadosGeraisSacados.contas | Set | Contas do sacado |
| dadosGeraisSacados.contas.seqBan | Integer | (Opcional) - Number(004) - Sequência da Conta bancária |
| dadosGeraisSacados.contas.codBan | String | (Opcional) - String(003) - Código do banco da conta corrente do sacado |
| dadosGeraisSacados.contas.codAge | String | (Opcional) - String(007) - Código da agência do banco da conta corrente do sacado |
| dadosGeraisSacados.contas.ccbSac | String | (Opcional) - String(014) - Número da conta corrente do sacado no banco |
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:GravarSacadoResponse>
<result>
<retornoSacados>
<codSac>String</codSac>
<msgRet>String</msgRet>
</retornoSacados>
<resultado>String</resultado>
<erroExecucao>String</erroExecucao>
</result>
</ser:GravarSacadoResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:| Nome | Tipo | Descrição |
|---|---|---|
| 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" |
| retornoSacados | Set | Itens de retorno |
| retornoSacados.codSac | String | String(014) - Número do CNPJ ou CPF do sacado |
| retornoSacados.msgRet | String | String(200) - Será retornado "OK" para os cadastros realizados com sucesso e uma mensagem de erro para os cadastros que não foram realizados. |
| 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". As mensagens completas serão apresentadas na grid de retorno. |
ExportarSacado
Situação de 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:ExportarSacado>
<user>String</user>
<password>String</password>
<encryption>Integer</encryption>
<parameters>
<consulta>
<codSac>String</codSac>
</consulta>
<codEmp>Integer</codEmp>
<codFil>Integer</codFil>
<tipoIntegracao>String</tipoIntegracao>
<quantidadeRegistros>Integer</quantidadeRegistros>
<identificacaoSistema>String</identificacaoSistema>
</parameters>
</ser:ExportarSacado>
</soapenv:Body>
</soapenv:Envelope>
Parâmetros da requisição:
| Nome | Preenchimento | Tipo | Descrição |
|---|---|---|---|
| consulta | Opcional | Set | (Obrigatório) - Utilizar para informar quais registros devem ser retornados. Utilizar apenas quando o tipo de integração for específico ("E") |
| consulta.codSac | Opcional | String | Número do CNPJ ou CPF do sacado |
| codEmp | Opcional | Number | Código da Empresa |
| codFil | Opcional | Number | Código da Filial |
| tipoIntegracao | Opcional | String | Tipo de Integração - Lista: T = Todos, A = Somente Alterados, E = Registro Específico |
| quantidadeRegistros | Opcional | Number | Quantidade de registros limite para retorno da solicitação. Quando o tipo de integração for "E", este valor não é utilizado |
| identificacaoSistema | Opcional | String | Identificação do sistema integrado |
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:ExportarSacadoResponse>
<result>
<sacado>
<seqInt>Integer</seqInt>
<codSac>String</codSac>
<tipSac>String</tipSac>
<nomSac>String</nomSac>
<apeSac>String</apeSac>
<sitSac>String</sitSac>
<eenSac>String</eenSac>
<cepSac>String</cepSac>
<cepIni>String</cepIni>
<endSac>String</endSac>
<numEnd>Integer</numEnd>
<cplEnd>String</cplEnd>
<baiSac>String</baiSac>
<cidSac>String</cidSac>
<sigUfs>String</sigUfs>
<fonSac>String</fonSac>
<faxSac>String</faxSac>
<cxaPst>Integer</cxaPst>
<intNet>String</intNet>
<eenCob>String</eenCob>
<endCob>String</endCob>
<cplCob>String</cplCob>
<cepCob>String</cepCob>
<cidCob>String</cidCob>
<estCob>String</estCob>
<nenCob>String</nenCob>
<baiCob>String</baiCob>
<iniCob>String</iniCob>
<datCad>DateTime</datCad>
<datAtu>DateTime</datAtu>
<celSac>String</celSac>
<sacBlo>String</sacBlo>
<motBlo>String</motBlo>
</sacado>
<gridErros>
<msgErr>String</msgErr>
</gridErros>
<finalizaramRegistros>String</finalizaramRegistros>
<tipoRetorno>Integer</tipoRetorno>
<mensagemRetorno>String</mensagemRetorno>
<numeroLote>Integer</numeroLote>
<erroExecucao>String</erroExecucao>
</result>
</ser:ExportarSacadoResponse>
</soapenv:Body>
</soapenv:Envelope>
Atributos da resposta:
| Nome | Preenchimento | Tipo | Descrição |
|---|---|---|---|
| sacado | Opcional | Set | |
| sacado.seqInt | Opcional | Integer | SeqInt - Number(009) - Sequencial do Registro Integrado |
| sacado.codSac | Opcional | String | String(014) - Número do CNPJ ou CPF do sacado |
| sacado.tipSac | Opcional | String | String(001) - Tipo do sacado - Lista: J = Pessoa Jurídica, F = Pessoa Física |
| sacado.nomSac | Opcional | String | String(040) - Nome do sacado |
| sacado.apeSac | Opcional | String | String(020) - Nome fantasia do sacado |
| sacado.sitSac | Opcional | String | String(001) - Situação do sacado - Lista: A = Ativo, I = Inativo |
| sacado.eenSac | Opcional | String | String(018) - Código do endereço do sacado | |
| sacado.cepSac | Opcional | String | String(008) - CEP do sacado |
| sacado.cepIni | Opcional | String | String(008) - Faixa inicial do CEP da cidade do sacado |
| sacado.endSac | Opcional | String | String(035) - Endereço do sacado |
| sacado.numEnd | Opcional | Integer | Number(005) - Número do Endereço do Sacado |
| sacado.cplEnd | Opcional | String | String(060) - Complemento do endereço do sacado (sala, andar, etc.) |
| sacado.baiSac | Opcional | String | String(075) - Bairro do sacado |
| sacado.cidSac | Opcional | String | String(060) - Cidade do sacado |
| sacado.sigUfs | Opcional | String | String(002) - Sigla do estado do sacado |
| sacado.fonSac | Opcional | String | String(020) - Número do telefone do sacado |
| sacado.faxSac | Opcional | String | String(020) - Número do FAX do sacado |
| sacado.cxaPst | Opcional | Integer | Number(006) - Número da caixa postal do sacado |
| sacado.intNet | Opcional | String | String(100) - Endereço eletrônico (E-Mail) |
| sacado.eenCob | Opcional | String | String(018) - Código do endereço de cobrança do sacado | |
| sacado.endCob | Opcional | String | String(100) - Endereço de cobrança do sacado |
| sacado.cplCob | Opcional | String | String(060) - Complemento do endereço de cobrança do sacado |
| sacado.cepCob | Opcional | String | String(008) - CEP do endereço de cobrança do sacado |
| sacado.cidCob | Opcional | String | String(060) - Cidade do endereço de cobrança do sacado |
| sacado.estCob | Opcional | String | String(002) - Estado do endereço de cobrança do sacado |
| sacado.nenCob | Opcional | String | String(060) - Número do Endereço de Cobrança do Sacado |
| sacado.baiCob | Opcional | String | String(075) - Bairro de cobrança do sacado |
| sacado.iniCob | Opcional | String | String(008) - Faixa inicial do CEP do endereço de cobrança do sacado | |
| sacado.datCad | Opcional | DateTime | Date(000) - Data do cadastramento do sacado |
| sacado.datAtu | Opcional | DateTime | Date(000) - Data da última alteração do cadastro do sacado |
| sacado.celSac | Opcional | String | String(020) - Número do telefone celular do sacado |
| sacado.sacBlo | Opcional | String | String(001) - Indicativo para Sacado Bloqueado - Lista: S = Sim, N = Não |
| sacado.motBlo | Opcional | String | String(150) - Descrição do Motivo do Bloqueio |
| gridErros | Opcional | String | (Opcional) - Lista dos erros |
| gridErros.msgErr | Opcional | String | Erros |
| finalizaramRegistros | Opcional | String | String(001) - Indicativo se existem mais informações a serem solicitadas - Lista: S = Sim, N = Não |
| tipoRetorno | Opcional | Integer | Number(001) - Tipo de Retorno de Processamento - Lista: 1 = Processado, 2 = Erro na Solicitação |
| mensagemRetorno | Opcional | String | String(1000) - Mensagem de Retorno de Processamento |
| numeroLote | Opcional | Integer | Inteiro - Identificação do Lote de Exportação |
| erroExecucao | Opcional | 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 sucesso; - A mensagem do erro ocorrido no servidor. |
English
Español
English
Español


