Web service com.senior.g5.co.int.vetorh.titulos
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_int_vetorh_titulos?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_int_vetorh_titulos?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_int_vetorh_titulos?wsdl
Porta
Integrações - Gestao de Pessoas - Integrar Títulos CPA.
Necessita autenticação: sim.
Situação de versão: atual.
Versão: 1.
Observação
O identificador de regras CPA-501INTHI01 tem a finalidade de informar ao Gestão Empresarial | ERP se a integração de históricos do Gestão de Pessoas | HCM está ativo.
Com esse identificador ativo, a busca das informações do Banco, Agência e Conta Corrente terão um comportamento diferente.
1º informado no próprio web service;
2º do cadastro do fornecedor (se não tiver favorecido);
3º do cadastro do favorecido;
4º da conta bancária (primeira sequência da conta).
1º informado no próprio web service;
2º da conta bancária (última sequência da conta);
3º do cadastro do fornecedor (se não tiver favorecido);
4º do cadastro do favorecido.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:IntegrarTitulos> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>Integer</codEmp> <entradaTitulos> <codFil>Integer</codFil> <numTit>String</numTit> <codTpt>String</codTpt> <codFor>Integer</codFor> <codTns>String</codTns> <obsTcp>String</obsTcp> <codFav>Double</codFav> <codNtg>Integer</codNtg> <numPrj>Integer</numPrj> <codFpj>Integer</codFpj> <ctaFin>Integer</ctaFin> <ctaRed>Integer</ctaRed> <codCcu>String</codCcu> <codCrp>String</codCrp> <datEmi>DateTime</datEmi> <datEnt>DateTime</datEnt> <vctOri>DateTime</vctOri> <vlrOri>Double</vlrOri> <codMoe>String</codMoe> <vctPro>DateTime</vctPro> <proJrs>String</proJrs> <codMpt>String</codMpt> <codFpg>Integer</codFpg> <datNeg>DateTime</datNeg> <jrsNeg>Double</jrsNeg> <mulNeg>Double</mulNeg> <dscNeg>Double</dscNeg> <outNeg>Double</outNeg> <cotNeg>Double</cotNeg> <datPpt>DateTime</datPpt> <antDsc>String</antDsc> <datDsc>DateTime</datDsc> <tolDsc>Integer</tolDsc> <perDsc>Integer</perDsc> <vlrDsc>Double</vlrDsc> <codPor>String</codPor> <codCrt>String</codCrt> <codBan>String</codBan> <tipTcc>Integer</tipTcc> <codAge>String</codAge> <ccbFor>String</ccbFor> <titBan>String</titBan> <priPgt>Integer</priPgt> <perMul>Integer</perMul> <tolMul>Integer</tolMul> <jrsDia>Double</jrsDia> <perJrs>Integer</perJrs> <tipJrs>String</tipJrs> <tolJrs>Integer</tolJrs> <rateio> <numPrj>Integer</numPrj> <codFpj>Integer</codFpj> <ctaFin>Integer</ctaFin> <ctaRed>Integer</ctaRed> <perCta>Double</perCta> <vlrCta>Double</vlrCta> <codCcu>String</codCcu> <perRat>Double</perRat> <vlrRat>Double</vlrRat> <obsRat>String</obsRat> </rateio> <cotEmi>Double</cotEmi> <vlrRba>Double</vlrRba> <excTie>String</excTie> <codDfs>Integer</codDfs> </entradaTitulos> <codFil>Integer</codFil> <forCli>String</forCli> </parameters> </ser:IntegrarTitulos> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa |
entradaTitulos | Set | Entrada de Títulos |
entradaTitulos.codFil | Integer | (Obrigatório) - Number(005) - Filial |
entradaTitulos.numTit | String | (Obrigatório) - String(015) - Título |
entradaTitulos.codTpt | String | (Obrigatório) - String(003) - Tipo Tít. |
entradaTitulos.codFor | Integer | (Obrigatório) - Number(009) - Forn. |
entradaTitulos.codTns | String | (Obrigatório) - String(005) - Trans. |
entradaTitulos.obsTcp | String | (Opcional) - String(250) - Obs. |
entradaTitulos.codFav | Double | (Opcional) - Number(014) - Favorecido |
entradaTitulos.codNtg | Integer | (Opcional) - Number(004) - Nat. Gasto |
entradaTitulos.numPrj | Integer | (Opcional) - Number(008) - Projeto |
entradaTitulos.codFpj | Integer | (Opcional) - Number(004) - Fase |
entradaTitulos.ctaFin | Integer | (Opcional) - Number(007) - Cta. Fin. |
entradaTitulos.ctaRed | Integer | (Opcional) - Number(007) - Cta. Ctb. Red. |
entradaTitulos.codCcu | String | (Opcional) - String(009) - CC |
entradaTitulos.codCrp | String | (Opcional) - String(003) - Grupo Pagar |
entradaTitulos.datEmi | DateTime | (Obrigatório) - Date(000) - Emissão |
entradaTitulos.datEnt | DateTime | (Obrigatório) - Date(000) - Data Ent. |
entradaTitulos.vctOri | DateTime | (Obrigatório) - Date(000) - Venc. Orig. |
entradaTitulos.vlrOri | Double | (Obrigatório) - Number(015) - Vlr. Orig. |
entradaTitulos.codMoe | String | (Opcional) - String(003) - Moeda |
entradaTitulos.vctPro | DateTime | (Obrigatório) - Date(000) - Venc. Prorr. |
entradaTitulos.proJrs | String | (Obrigatório) - String(001) - Prorr. c/ Jrs. - Lista: S = Sim, N = Não |
entradaTitulos.codMpt | String | (Opcional) - String(003) - Mot. Prorr. |
entradaTitulos.codFpg | Integer | (Opcional) - Number(002) - Forma Pgto. |
entradaTitulos.datNeg | DateTime | (Opcional) - Date(000) - Data Vlr. Neg. |
entradaTitulos.jrsNeg | Double | (Opcional) - Number(015) - Vlr. Jrs. Neg. |
entradaTitulos.mulNeg | Double | (Opcional) - Number(015) - Vlr. Multa Neg. |
entradaTitulos.dscNeg | Double | (Opcional) - Number(015) - Vlr. Dsc. Neg. |
entradaTitulos.outNeg | Double | (Opcional) - Number(015) - Vlr. Outros Neg. |
entradaTitulos.cotNeg | Double | (Opcional) - Number(019) - Cot. Moeda Neg. |
entradaTitulos.datPpt | DateTime | (Obrigatório) - Date(000) - Data Prov. Pagto. |
entradaTitulos.antDsc | String | (Opcional) - String(001) - Cal. Desc. Antec. - Lista: S = Sim, N = Não |
entradaTitulos.datDsc | DateTime | (Opcional) - Date(000) - Data Desc. |
entradaTitulos.tolDsc | Integer | (Opcional) - Number(004) - Tol Desc. |
entradaTitulos.perDsc | Integer | (Opcional) - Number(005) - % Desc. |
entradaTitulos.vlrDsc | Double | (Opcional) - Number(015) - Vlr. Desc. |
entradaTitulos.codPor | String | (Obrigatório) - String(004) - Port. |
entradaTitulos.codCrt | String | (Obrigatório) - String(002) - Cart. |
entradaTitulos.codBan | String | (Opcional) - String(003) - Banco Forn. |
entradaTitulos.tipTcc | Integer | (Opcional) - Number(002) - Tipo da Conta |
entradaTitulos.codAge | String | (Opcional) - String(007) - Agência Forn. |
entradaTitulos.ccbFor | String | (Opcional) - String(014) - Nº CC |
entradaTitulos.titBan | String | (Opcional) - String(020) - Tít. Banco |
entradaTitulos.priPgt | Integer | (Opcional) - Number(009) - Pri. Pgto Tit. |
entradaTitulos.perMul | Integer | (Opcional) - Number(005) - % Multa |
entradaTitulos.tolMul | Integer | (Opcional) - Number(004) - Dias Tol. Multa |
entradaTitulos.jrsDia | Double | (Opcional) - Number(009) - Jrs. Dia |
entradaTitulos.perJrs | Integer | (Opcional) - Number(005) - % Jrs. |
entradaTitulos.tipJrs | String | (Opcional) - String(001) - Tipo Jrs. - Lista: S = Juros Simples, C = Juros Compostos |
entradaTitulos.tolJrs | Integer | (Opcional) - Number(004) - Dias Tol. Jrs. |
rateio | Set | Rateio do título |
rateio.numPrj | Integer | |
rateio.codFpj | Integer | |
rateio.ctaFin | Integer | |
rateio.ctaRed | Integer | |
rateio.perCta | Double | |
rateio.vlrCta | Double | |
rateio.codCcu | String | |
rateio.perRat | Double | |
rateio.vlrRat | Double | |
rateio.obsRat | String | |
entradaTitulos.cotEmi | Double | (Opcional) - Number(019) - Valor da cotação da moeda na data de emissão do título |
entradaTitulos.vlrRba | Double | |
entradaTitulos.excTie | String | (Opcional) - String(001) - Indicativo se exclui o título existente antes de inserir o novo (títulos integrados com situação 'AV') |
entradaTitulos.codDfs | Integer | Código do dispositivo fiscal |
codFil | Integer | (Obrigatório) - Number(005) - Código da filial. Filial onde irá acontecer os movimentos |
forCli | String | (Opcional) - String(001) - Fornecedor como Cliente |
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:IntegrarTitulosResponse> <result> <gridResult> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <numTit>String</numTit> <codTpt>String</codTpt> <codFor>Integer</codFor> <numInt>String</numInt> <txtRet>String</txtRet> </gridResult> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:IntegrarTitulosResponse> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
gridResult | Set | Itens de retorno. |
gridResult.codEmp | Integer | |
gridResult.codFil | Integer | |
gridResult.numTit | String | |
gridResult.codTpt | String | |
gridResult.codFor | Integer | |
gridResult.numInt | String | |
gridResult.txtRet | String | |
resultado | String | O campo resultado irá retornar as seguintes mensagens: Execução do serviço sem erros: "OK" -> Verificar títulos baixados e gerados na grid "Retorno" Execução do serviço com erros: "ERRO" -> Analizar os erros na grid "Retorno" |
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" |