Web service com.senior.g5.co.mfi.prj.aproveitamentodecreditoviaprestacao
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_mfi_prj_aproveitamentodecreditoviaprestacao?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mfi_prj_aproveitamentodecreditoviaprestacao?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_mfi_prj_aproveitamentodecreditoviaprestacao?wsdl
Porta
AprCredViaPrestacao
Finanças - Gestão Orçamentária e Projetos - Controle Financeiro - Aproveitamento de Crédito via Prestação de Contas
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:AprCredViaPrestacao> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <gridAproveitamentoCred> <codFor>String</codFor> <numPrj>String</numPrj> <codPca>String</codPca> </gridAproveitamentoCred> <codEmp>Integer</codEmp> <codFil>Integer</codFil> </parameters> </ser:AprCredViaPrestacao> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Descrição |
---|---|---|
gridAproveitamentoCred | Set | Grid - Aproveitamento de títulos via prestação de contas.
HELP: Esse web service realiza a baixa por aproveitamento de crédito dos adiantamentos gerados contra as duplicadas geradas pela nota fiscal de entrada. Equivale ao botão "Aproveitar Tit." da tela F615PCA. Esse web service somente deve ser utilizado para prestações de contas com origem de "Pagamento". Essa origem é cadastrada no momento da inclusão do item do protocolo. |
gridAproveitamentoCred.codFor | String | (Obrigatório) - Integer(009 ) - Código do órgão financiador (Fornecedor) |
gridAproveitamentoCred.numPrj | String | (Obrigatório) - (008) - Número interno do projeto |
gridAproveitamentoCred.codPca | String | (Obrigatório) - (008) - Código da prestação de contas do adiantamento |
codEmp | Integer | (Obrigatório) - Number(004) - Código da empresa. |
codFil | Integer | (Obrigatório) - Number(005) - Código da filial. |
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:AprCredViaPrestacaoResponse> <result> <gridRetorno> <codEmp>Integer</codEmp> <codFor>Integer</codFor> <numPrj>Integer</numPrj> <codPca>Integer</codPca> <msgErr>String</msgErr> </gridRetorno> <resultado>String</resultado> <erroExecucao>String</erroExecucao> </result> </ser:AprCredViaPrestacaoResponse> </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" |
gridRetorno | Set | Itens de erro |
gridRetorno.codEmp | Integer | |
gridRetorno.codFor | Integer | |
gridRetorno.numPrj | Integer | |
gridRetorno.codPca | Integer | |
gridRetorno.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. |