Web service Com.senior.g5.co.mct.ctb.importacaolctctb
Este web service permite importar os lançamentos contábeis para a Gestão de Contabilidade.
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_mct_ctb_importacaolctctb?wsdl
- Assíncrono: http://example.com/g5-senior-services/sapiens_Asynccom_senior_g5_co_mct_ctb_importacaolctctb?wsdl
- Agendado: http://example.com/g5-senior-services/sapiens_Scheduledcom_senior_g5_co_mct_ctb_importacaolctctb?wsdl
Porta(s)
Controladoria - Gestão de Contabilidade - Contabilidade - Importação de Lançamentos Contábeis.
Importante
A partir da versão 2 deste web service houve uma reestruturação no processamento, onde o principal objetivo é o ganho de desempenho na importação dos lançamentos. Por este motivo o web service não suporta o processamento de lançamentos em empresas diferentes, ou seja, na requisição que será processada todos os lançamentos devem pertencer a mesma empresa. Caso existam lançamentos a serem importados em empresas distintas, então o processo não será iniciado e será exibida a mensagem de erro: “Não será possível processar esta requisição, foi identificado que existem lançamentos a serem integrados em mais de uma empresa.”
Necessita autenticação: sim.
Situação de versão: atual.
Versão: 3.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.senior.com.br"> <soapenv:Body> <ser:Importar> <user>String</user> <password>String</password> <encryption>Integer</encryption> <parameters> <gridLct> <ideUni>String</ideUni> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <numLot>Integer</numLot> <numFtc>Integer</numFtc> <datLct>DateTime</datLct> <ctaCre>Integer</ctaCre> <ctaDeb>Integer</ctaDeb> <vlrLct>Double</vlrLct> <codHpd>Integer</codHpd> <oriLct>String</oriLct> <cplLct>String</cplLct> <docLct>String</docLct> <desLot>String</desLot> <cgcCpf>Double</cgcCpf> <codFor>Integer</codFor> <cgcCre>Double</cgcCre> <forCre>Integer</forCre> <obsCpl>String</obsCpl> <rateio> <ctaRed>Integer</ctaRed> <codCcu>String</codCcu> <perRat>Double</perRat> <vlrRat>Double</vlrRat> <ctaFin>Integer</ctaFin> </rateio> <auxiliar> <ctaRed>Integer</ctaRed> <ctaAux>Integer</ctaAux> <vlrAux>Double</vlrAux> <codHpd>Integer</codHpd> <cplLct>String</cplLct> <docLct>String</docLct> </auxiliar> <datExt>DateTime</datExt> </gridLct> <eTipRet>String</eTipRet> <eLctZer>String</eLctZer> <eIgnorarRatAux>String</eIgnorarRatAux> <sistemaIntegracao>String</sistemaIntegracao> </parameters> </ser:Importar> </soapenv:Body> </soapenv:Envelope>
Nome | Tipo | Descrição |
---|---|---|
gridLct | 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 sistema |
gridLct.ideUni | String | Identificador Único para o lançamento contábil |
gridLct.codEmp | Integer | Código da empresa |
gridLct.codFil | Integer | Código da filial |
gridLct.numLot | Integer | Número do lote contábil |
gridLct.numFtc | Integer | |
gridLct.datLct | DateTime | Data do lançamento |
gridLct.ctaCre | Integer | Conta reduzida crédito |
gridLct.ctaDeb | Integer | Conta reduzida débito |
gridLct.vlrLct | Double | Valor do lançamento contábil |
gridLct.codHpd | Integer | Código do histórico padrão |
gridLct.oriLct | String | Origem do Lançamento |
gridLct.cplLct | String | Complemento do lançamento |
gridLct.docLct | String | Documento |
gridLct.desLot | String | Descrição da Origem (Lote) |
gridLct.cgcCpf | Double | CNPJ/CPF |
gridLct.codFor | Integer | Código do fornecedor que será usado para buscar o CNPJ/CPF |
gridLct.cgcCre | Double | |
gridLct.forCre | Integer | |
gridLct.obsCpl | String | (Opcional) - Texto[250] - Observação complementar do lançamento |
rateio | Set | Rateio do lançamento contábil |
rateio.ctaRed | Integer | Conta contábil reduzida |
rateio.codCcu | String | Centro de custo |
rateio.perRat | Double | Percentual de rateio para centro de custo |
rateio.vlrRat | Double | Valor do rateio para o centro de custo |
rateio.ctaFin | Integer | Conta financeira reduzida |
auxiliar | Set | Composição auxiliar do lançamento contábil |
auxiliar.ctaRed | Integer | Conta contábil reduzida |
auxiliar.ctaAux | Integer | Conta reduzida auxiliar |
auxiliar.vlrAux | Double | Valor do lançamento auxiliar |
auxiliar.codHpd | Integer | Código do histórico padrão |
auxiliar.cplLct | String | Descrição complementar do lançamento auxiliar |
auxiliar.docLct | String | Documento do lançamento auxiliar |
gridLct.datExt | DateTime | Data de Lançamento Extemporâneo |
eTipRet | String | Permite escolher o tipo de retorno que será recebido, podendo ser: 0 ou nulo - Se algum dos lançamentos enviados possuir uma divergência, o web service carregará como retorno todos os lançamentos enviados, em cada lançamento haverá uma mensagem descrevendo qual a divergência ou se está apto para ser importado 1 - Se algum dos lançamentos enviados possuir uma divergência, o web service carregará como retorno somente os lançamentos que tiverem divergências, não efetuando a gravação dos lançamentos que estiverem aptos a ser importados 2 - Se algum dos lançamentos enviados possuir uma divergência, o web service carregará como retorno somente os lançamentos que tiverem divergências, efetuará a gravação dos lançamentos que estiverem aptos a serem importados |
eLctZer | String | Campo lista que deverá receber o valor M para receber lançamentos normais ou Z para lançamentos de zeramento, caso o valor passado não seja nenhum destes, por padrão, irá interpretar o lançamento como normal. Importante Definir um lote como sendo do tipo "Z - Especial para Zeramento" é uma prática que deve ser executada de forma cautelosa, pois o sistema deixará de garantir que as contas foram de fato zeradas |
eIgnorarRatAux | String | Indica se deve ignorar rateios/composições auxiliares enviadas para contas contábeis que não exigem essa informação.
Opcional - (S/N)
S - Sim - Ignora N - Não - (Padrão): consiste caso seja enviado rateios/composições auxiliares para contas contábeis exijam esta informação |
sistemaIntegracao | String | String(15) - Sigla do sistema de Integração |
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:ImportarResponse> <result> <gridLctResult> <ideUni>String</ideUni> <codEmp>Integer</codEmp> <codFil>Integer</codFil> <numLot>Integer</numLot> <numLct>Double</numLct> <numFtc>Integer</numFtc> <datLct>DateTime</datLct> <ctaCre>Integer</ctaCre> <ctaDeb>Integer</ctaDeb> <vlrLct>Double</vlrLct> <codHpd>Integer</codHpd> <cplLct>String</cplLct> <docLct>String</docLct> <oriLct>String</oriLct> <desLot>String</desLot> <cgcCpf>Double</cgcCpf> <codFor>Integer</codFor> <cgcCre>Double</cgcCre> <forCre>Integer</forCre> <linha>Integer</linha> <obsCpl>String</obsCpl> <resultado>String</resultado> </gridLctResult> <erroExecucao>String</erroExecucao> </result> </ser:ImportarResponse> </soapenv:Body> </soapenv:Envelope>
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" |
gridLctResult | 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 sistema |
gridLctResult.ideUni | String | Identificador Único para o lançamento contábil |
gridLctResult.codEmp | Integer | Código da empresa |
gridLctResult.codFil | Integer | Código da filial |
gridLctResult.numLot | Integer | Número do lote contábil |
gridLctResult.numLct | Double | Numero do lançamento contábil gerado pelo sistema |
gridLctResult.numFtc | Integer | |
gridLctResult.datLct | DateTime | Data do lançamento |
gridLctResult.ctaCre | Integer | Conta reduzida crédito |
gridLctResult.ctaDeb | Integer | Conta reduzida débito |
gridLctResult.vlrLct | Double | Valor do lançamento contábil |
gridLctResult.codHpd | Integer | Código do histórico padrão |
gridLctResult.cplLct | String | Complemento do lançamento |
gridLctResult.docLct | String | Documento |
gridLctResult.oriLct | String | Origem do Lançamento |
gridLctResult.desLot | String | Descrição da Origem (Lote) |
gridLctResult.cgcCpf | Double | CNPJ/CPF |
gridLctResult.codFor | Integer | Código do fornecedor que será usado para buscar o CNPJ/CPF |
gridLctResult.cgcCre | Double | |
gridLctResult.forCre | Integer | |
gridLctResult.linha | Integer | |
gridLctResult.obsCpl | String | Observação complementar do lançamento |
gridLctResult.resultado | String |