Web service com.senior.g5.co.ger.cad.ModeloPlano
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_ModeloPlano?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_ger_cad_ModeloPlano?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_ger_cad_ModeloPlano?wsdl
Portas
ExcluirContas
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:ExcluirContas> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <GridCta> <codMpc>Integer</codMpc> <ctaRed>Integer</ctaRed> </GridCta> </parameters> </ser:ExcluirContas> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Descrição |
---|---|---|
gridCta | Set | Contas contábeis a excluir |
gridCta.codMpc | Integer | (Obrigatório) - Number(0004) - Código do modelo de plano |
gridCta.ctaRed | Integer | (Obrigatório) - Number(0007) - Número reduzido da conta do modelo de plano |
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:ExcluirContasResponse> <result> <GridCtaResult> <codMpc>Integer</codMpc> <ctaRed>Integer</ctaRed> <logCta>String</logCta> </GridCtaResult> <erroExecucao>String</erroExecucao> </result> </ser:ExcluirContasResponse> </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" |
gridCtaResult | Set | Grade para retornar todos os lançamentos gerados pelo sistema. A coluna Número do lançamento é o numero do lançamento contábil gerado pelo Gestão Empresarial | ERP. |
gridCtaResult.codMpc | Integer | Number(0004) - Código do modelo de plano |
gridCtaResult.ctaRed | Integer | Number(0007) - Número reduzido da conta do modelo de plano |
gridCtaResult.logCta | String | String(250) - Mensagem de retorno da integração |
GerarContas_2
Cadastros - Modelos de Plano - Plano Contas - Gerar
Necessita autenticação: Sim
Situação de versão: Atual
Versão: 2
Requisição:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:GerarContas> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <GridCta> <codMpc>Integer</codMpc> <ctaRed>Integer</ctaRed> <claCta>String</claCta> <desCta>String</desCta> <abrCta>String</abrCta> <ctaPar>Integer</ctaPar> <claPar>String</claPar> <desPar>String</desPar> <anaSin>String</anaSin> <natCta>String</natCta> <forRat>Integer</forRat> <exiRat>String</exiRat> <exiAux>String</exiAux> <metCon>Integer</metCon> <modCtb>Integer</modCtb> <ctaCtb>Integer</ctaCtb> <tipCcu>Integer</tipCcu> <codCcu>String</codCcu> <valIni>DateTime</valIni> <valFin>DateTime</valFin> <abrEmp>String</abrEmp> <defGru>String</defGru> </GridCta> </parameters> </ser:GerarContas> </soapenv:Body> </soapenv:Envelope>
Parâmetros da requisição:
Nome | Tipo | Descrição |
---|---|---|
gridCta | Set | Grade para carregar todos os lançamentos com seus respectivos rateios e composição auxiliar. Os registros contidos nesta grade serão importados para o Gestão Empresarial | ERP. |
gridCta.codMpc | Integer | Number(0004) - Código do modelo de plano |
gridCta.ctaRed | Integer | Number(0007) - Número reduzido da conta do modelo de plano |
gridCta.claCta | String | String(30) - Classificação da conta do modelo de plano |
gridCta.desCta | String | String(250) - Nomenclatura da conta do modelo de plano |
gridCta.abrCta | String | String(20) - Abreviatura da conta do modelo de plano |
gridCta.ctaPar | Integer | Number(009) - Conta reduzida paralela |
gridCta.claPar | String | String(030) - Classificação paralela |
gridCta.desPar | String | String(080) - Descrição paralela |
gridCta.anaSin | String | String(1) - Indicativo se a conta é analítica ou sintética |
gridCta.natCta | String | String(1) - Indicativo se a natureza da conta é credora ou devedora |
gridCta.forRat | Integer | Number(1) - Forma de rateio da conta do modelo de plano |
gridCta.exiRat | String | String(1) - Indicativo se a conta exige ou não rateio gerencial |
gridCta.exiAux | String | String(1) - Indicativo se a conta exige ou não conta do plano composição auxiliar |
gridCta.metCon | Integer | Number(0001) - Método de conversão da conta contábil |
gridCta.modCtb | Integer | Number(0004) - Código do modelo do plano contábil |
gridCta.ctaCtb | Integer | Number(0007) - Conta contábil reduzida relacionada a conta financeira |
gridCta.tipCcu | Integer | Number(0001) - Tipo do centro de custos |
gridCta.codCcu | String | String(9) - Código do centro de custos sugerido para modelos tipo 3 = Centro Custos |
gridCta.valIni | DateTime | Date - Data de validade inicial da conta |
gridCta.valFin | DateTime | Date - Data de validade final da conta |
gridCta.abrEmp | String | String(255) - Abrangência de empresas. Os valores devem estar separados com "," (vírgula) |
gridCta.defGru | String | String(001) - Definição da Conta: A=Ativo; P=Passivo; D=Despesas; R=Receitas; X=Ambas; M=Receitas Financeiras; N=Despesas Financeiras; U=Conta Auxiliar; L=Patrimônio Líquido; V=Custo de Venda; C=Custo de Produção; S=Custo de Ordem Dedutora; E=Custo de Ordem Credora; O=Outros |
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:GerarContasResponse> <result> <gridCtaResult> <codMpc>Integer</codMpc> <ctaRed>Integer</ctaRed> <logCta>String</logCta> <ideUni>String</ideUni> </gridCtaResult> <erroExecucao>String</erroExecucao> </result> </ser:GerarContasResponse> </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" |
gridCtaResult | Set | Grade para retornar todos os lançamentos gerados pelo sistema. A coluna Número do lançamento é o numero do lançamento contábil gerado pelo Gestão Empresarial | ERP. |
gridCtaResult.codMpc | Integer | Código do modelo de plano |
gridCtaResult.ctaRed | Integer | Número reduzido da conta do modelo de plano |
gridCtaResult.logCta | String | Log de geração (Erro/OK) |
gridCtaResult.ideUni | Integer | Identificador único da classificação da conta |