Web service Com.senior.g5.co.mct.ctb.visaocontabil
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_mct_ctb_visaocontabil?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mct_ctb_visaocontabil?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_mct_ctb_visaocontabil?wsdl
Porta
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Controladoria - Gestão de Contabilidade - Visões Contábeis - Consultar
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:Consultar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <codEmp>String</codEmp> <codFil>String</codFil> <codAfi>String</codAfi> <codVis>String</codVis> <datIni>String</datIni> <datFim>String</datFim> <cmpAgl>String</cmpAgl> </parameters> </ser:Consultar> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
Nome | Tipo | Descrição |
---|---|---|
codEmp | String | (Obrigatório) - Number(004) - Empresa |
codFil | String | (Opcional) - String(250) - Abrangência de filiais |
codAfi | String | (Opcional) - String(250) - Abrangência de agrupamentos de filiais |
codVis | String | (Obrigatório) - String(20) - Código da Visão |
datIni | DateTime | (Obrigatório) - Data Inicial |
datFim | DateTime | (Obrigatório) - Data Final |
cmpAgl | String | (Obrigatório) - Carregar Composição Aglutinador - Lista S-Sim/N-Não. |
![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:ConsultarResponse> <result> <gridVisao> <codEmp>Integer</codEmp> <nomEmp>String</nomEmp> <codVis>String</codVis> <desVis>String</desVis> <ctaVis>Integer</ctaVis> <desCtaVis>String</desCtaVis> <claCta>String</claCta> <nivCta>Integer</nivCta> <ctaRed>Integer</ctaRed> <desCtaRed>String</desCtaRed> <seqCol>Integer</seqCol> <desCol>String</desCol> <seqCmp>Integer</seqCmp> <forCal>String</forCal> <ctaRef>Integer</ctaRef> <colRef>String</colRef> <tipVlr>String</tipVlr> <codAgl>Integer</codAgl> <desAgl>String</desAgl> <codSql>Integer</codSql> <seqSql>Integer</seqSql> <indNeg>String</indNeg> <codMpc>Integer</codMpc> <vlrCmp>Double</vlrCmp> </gridVisao> <gridComposicaoAglutinadores> <codAgl>Integer</codAgl> <seqCmp>Integer</seqCmp> <opeAgl>String</opeAgl> <vlrRef>String</vlrRef> <ctaRed>Integer</ctaRed> <desCta>String</desCta> <anaSin>String</anaSin> <codCcu>String</codCcu> <desCcu>String</desCcu> <aglCag>Integer</aglCag> <empSql>Integer</empSql> <codSql>Integer</codSql> <seqSql>Integer</seqSql> <datRef>String</datRef> <vlrCal>Double</vlrCal> </gridComposicaoAglutinadores> <erroExecucao>String</erroExecucao> </result> </ser:ConsultarResponse> </soapenv:Body> </soapenv:Envelope>
![Closed](../Skins/Default/Stylesheets/Images/transparent.gif)
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" |
gridVisao | Set | |
gridVisao.codEmp | Integer | (Obrigatório) - Number(004) - Empresa |
gridVisao.nomEmp | String | (Obrigatório) - String(100) - Nome |
gridVisao.codVis | String | (Obrigatório) - String(020) - Código |
gridVisao.desVis | String | (Opcional) - String(060) - Descrição |
gridVisao.ctaVis | Integer | (Obrigatório) - Number(009) - Conta |
gridVisao.desCtaVis | String | (Opcional) - String(100) - Descrição |
gridVisao.claCta | String | (Opcional) - String(025) - Classificação |
gridVisao.nivCta | Integer | (Opcional) - Number(002) - Nível |
gridVisao.ctaRed | Integer | (Opcional) - Number(007) - Cta. Red. |
gridVisao.desCtaRed | String | (Obrigatório) - String(250) - Nomenclatura |
gridVisao.seqCol | Integer | (Obrigatório) - Number(003) - Coluna |
gridVisao.desCol | String | (Obrigatório) - String(020) - Descrição |
gridVisao.seqCmp | Integer | (Obrigatório) - Number(003) - Sequência |
gridVisao.forCal | String | (Opcional) - String(250) - Fórmula |
gridVisao.ctaRef | Integer | (Opcional) - Number(009) - Conta visão |
gridVisao.colRef | String | (Opcional) - Number(003) - Coluna visão |
gridVisao.tipVlr | String | (Opcional) - String(001) - Tipo Valor - Lista: A = Saldo Anterior, M = Movimento do Período, D = Débito do Período, C = Crédito do Período, S = Saldo Atual (Anterior + Movimento) |
gridVisao.codAgl | Integer | (Opcional) - Number(009) - Aglutinação |
gridVisao.desAgl | String | (Opcional) - String(250) - Descrição Aglutinação |
gridVisao.codSql | Integer | (Opcional) - Number(009) - Cod. SQL |
gridVisao.seqSql | Integer | (Opcional) - Number(004) - Seq. |
gridVisao.indNeg | String | (Opcional) - String(001) - Negativo? - Lista: S = Sim, N = Não |
gridVisao.codMpc | Integer | (Opcional) - Number(004) - Mod. Plano Ctb. |
gridVisao.vlrCmp | Double | (Opcional) - Number(014) - Valor da composição |
gridComposicaoAglutinadores | Set | |
gridComposicaoAglutinadores.codAgl | Integer | Cod. Aglutinador |
gridComposicaoAglutinadores.seqCmp | Integer | (Obrigatório) - Number(003) - Seqüência |
gridComposicaoAglutinadores.opeAgl | String | (Opcional) - String(001) - Operação - Lista: + = Soma, - = Diminui, * = Multiplica, / = Divide |
gridComposicaoAglutinadores.vlrRef | String | (Opcional) - String(001) - Valor Referência - Lista: A = Saldo Anterior, M = Movimento do Período, D = Débito do Período, C = Crédito do Período, S = Saldo Atual (Anterior + Movimento) |
gridComposicaoAglutinadores.ctaRed | Integer | (Opcional) - Number(007) - Cta. Red. |
gridComposicaoAglutinadores.desCta | String | (Opcional) - String(100) - Descrição |
gridComposicaoAglutinadores.anaSin | String | (Obrigatório) - String(001) - Ana./Sin. - Lista: A = Analítico(a), S = Sintético(a) |
gridComposicaoAglutinadores.codCcu | String | (Opcional) - String(009) - CC |
gridComposicaoAglutinadores.desCcu | String | (Obrigatório) - String(080) - Descr. |
gridComposicaoAglutinadores.aglCag | Integer | (Opcional) - Number(009) - Aglutinação |
gridComposicaoAglutinadores.empSql | Integer | (Opcional) - Number(004) - Empresa |
gridComposicaoAglutinadores.codSql | Integer | (Opcional) - Number(009) - Cod. SQL |
gridComposicaoAglutinadores.seqSql | Integer | (Opcional) - Number(004) - Seq. |
gridComposicaoAglutinadores.datRef | DateTime | (Obrigatório) - Date(000) - Data |
gridComposicaoAglutinadores.vlrCal | Double | (Opcional) - Number(014) - Valor |