Histórico da Página

Objetivo:

O objetivo deste guia é apresentar como expor o e utilizar os WebMethods do WebService utilizado para inclusão e leitura de lançamentos contábeis

Introdução:

Expondo e utilizando o DataServer do TOTVS Gestão Contábil via WebService.

1 - Para configurar WebService no RM.Host.exe e/ou RM.Host.Service.exe seguir os passos dos documentos a seguir:

“http://tdn.totvs.com/display/public/LRM/WebService+RM”

http://tdn.totvs.com/pages/viewpage.action?pageId=89620766.

Os documentos em questão mostraram como expor os serviços do webservice RM. No caso o serviço que nos interessa está exposto no caminho a seguir com o título DataServer: “http://localhost:8051/wsDataServer/MEX?wsdl”. Lembrando que localhost será a máquina onde se encontram os aplicativos RM.Host.exe e/ou RM.Host.Service.exe. 

2 - O serviço DataServer possui diversos webmethods mas os principais são para leitura e inserção de registros são:

2.1 - ReadView -> Responsável por retornar os registros com base no filtro passado. Esse webmethod retorna os dados das tabelas CLANCAMENTO e CPARTIDA. O xml abaixo faz com que o webservice retorne o lançamento e suas partidas da coligada 1 e lançamento 2897 utilizando o DataServer CtbLanData “<tot:DataServerName>CtbLanData</tot:DataServerName>”.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">

   <soapenv:Header/>

   <soapenv:Body>

      <tot:ReadView>

         <tot:DataServerName>CtbLanData</tot:DataServerName>

         <tot:Filtro>clancamento.codcoligada=1 and clancamento.idlancamento=2897</tot:Filtro>

         <tot:Contexto>codcoligada=1<1;codusuario=mestre;codsistemas=C</tot:Contexto>

      </tot:ReadView>

   </soapenv:Body>

</soapenv:Envelope>

2.2 - ReadRecord -> Responsável por retornar um registro de forma detalhada com base na chave passada “<tot:PrimaryKey>1;0;12</tot:PrimaryKey>” (CODCOLIGADA; CODLOTE; IDLANCAMENTO). Este webmethod retorna o lançamento, partida(s), rateio(s) e campo(s) complementares. O xml abaixo faz com que o webmethod retorne o lançamento e sua(s) partida(s), rateio(s) e campo(s) complementares da coligada 1, lote zero e lançamento 12 utilizando o DataServer CtbLanData “<tot:DataServerName>CtbLanData</tot:DataServerName>”. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">

   <soapenv:Header/>

   <soapenv:Body>

      <tot:ReadRecord>

         <tot:DataServerName>CtbLanData</tot:DataServerName>

         <tot:PrimaryKey>1;0;12</tot:PrimaryKey>

          <tot:Contexto>codcoligada=1<1;codusuario=mestre;codsistemas=C</tot:Contexto>

      </tot:ReadRecord>

   </soapenv:Body>

</soapenv:Envelope>

2.3 - SaveRecord -> Responsável por salvar Salvar/Atualizar um registro. Este webmethod salva o lançamento contábil com sua(s) partida(s), rateio(s) e campo(s) complementares. Lembrando que só o lançamento e partida são obrigatórios para serem salvos. Abaixo o xml de exemplo mostrando como salvar um lançamento contábil que possui duas partidas, dois rateios (um para cada partida) e os campos complementares (um para cada partida). Rateios e campos complementares podem ser mais de um por partida.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tot="http://www.totvs.com/">

    <soapenv:Header/>

    <soapenv:Body>

        <tot:SaveRecord>        SaveRecord>

        <tot:DataServerName>CtbLanData</tot:DataServerName>        DataServerName>

        <tot:XML>

        <![CDATA[

                               <CtbLan>                 

                                 <CLANCAMENTO>

                                               <CtbLan>

                                                <CLANCAMENTO>

                                                                <CODCOLIGADA>1<                                               <CODCOLIGADA>1</CODCOLIGADA>

                                               <CODLOTE>0<                                                                <CODLOTE>0</CODLOTE>

                                               <IDLANCAMENTO>1<                                                                <IDLANCAMENTO>-1</IDLANCAMENTO>

                                               <DESCRICAO>Lançamento                                                                 <DESCRICAO>Lançamento da data 15/10/2010</DESCRICAO>

                                               <DATA>2010                                                                <DATA>2010-10-15T00:00:00</DATA>

                                               <ORIGEM                                                                <ORIGEM_HISTORICO>0</ORIGEM_HISTORICO>

                                               <INTEGRAAPLICACAO>C<                                                                <INTEGRAAPLICACAO>C</INTEGRAAPLICACAO>

                                 <                                                </CLANCAMENTO>

                                 <CPARTIDA>

                                                <CPARTIDA>

                                                                <CODCOLIGADA>1<                                               <CODCOLIGADA>1</CODCOLIGADA>

                                               <IDPARTIDA>1<                                                                <IDPARTIDA>-1</IDPARTIDA>

                                                                <LCTREF>-1</LCTREF>

                                                                <CODLOTE>0<                                               <CODLOTE>0</CODLOTE>

                                               <IDLANCAMENTO>1<                                                                <IDLANCAMENTO>-1</IDLANCAMENTO>

                                               <LCTREF>1</LCTREF>

                                               <CODLOTEORIGEM>30<                                                                <CODLOTEORIGEM>30</CODLOTEORIGEM>

                                               <CODFILIAL>1<                                                                <CODFILIAL>1</CODFILIAL>

                                               <DOCUMENTO>002349<                                                                <DOCUMENTO>002349</DOCUMENTO>

                                               <DATA>2010                                                                <DATA>2010-10-15T00:00:00</DATA>

                                               <CODCOLDEBITO>0<                                                                <CODCOLDEBITO>0</CODCOLDEBITO>

                                               <DEBITO>1                                                                <DEBITO>1.1.1.1.361</DEBITO>

                                               <CODCOLCREDITO>1<                                                                <CODCOLCREDITO>1</CODCOLCREDITO>

                                               <CODCOLPARTIDA>1<                                                                <CODCOLPARTIDA>1</CODCOLPARTIDA>

                                               <VALOR>237300.                                                                <VALOR>237300,00</VALOR>

                                               <VALOR2>121692.                                                                <VALOR2>121692,3077</VALOR2>

                                               <DATA2>2010                                                                <DATA2>2010-10-15T00:00:00</DATA2>

                                               <USUARIO>charles<                                                                <USUARIO>charles</USUARIO>

                                               <DATAINCLU>2010                                                                <DATAINCLU>2010-10-15T00:00:00</DATAINCLU>

                                               <USUARIOALTER>charles<                                                                <USUARIOALTER>charles</USUARIOALTER>

                                               <DATAALTER>2010                                                                <DATAALTER>2010-10-15T00:00:00</DATAALTER>

                                               <USUARIOINTEGRACAO>Walquiria<                                                                <USUARIOINTEGRACAO>Walquiria</USUARIOINTEGRACAO>

                                               <DATAINTEGRACAO>2011                                                                <DATAINTEGRACAO>2011-10-07T09:05:06.153</DATAINTEGRACAO>

                                               <INTEGRAAPLICACAO>C<                                                               <INTEGRAAPLICACAO>C</INTEGRAAPLICACAO>

                                               <INTEGRACHAVE>2349<                                                                <INTEGRACHAVE>2349</INTEGRACHAVE>

                                               <EXIGERATEIODEBITO>0<                                                                <EXIGERATEIODEBITO>0</EXIGERATEIODEBITO>

                                               <ORIGINADONOVOMOD>1<                                                                <ORIGINADONOVOMOD>1</ORIGINADONOVOMOD>

                                               <TIPOAGRUP>0<                                                                <TIPOAGRUP>0</TIPOAGRUP>

                                 <                                                </CPARTIDA>

                                 <CPARTIDA>

                                                <CPARTIDA>

                                                                <CODCOLIGADA>1<                                               <CODCOLIGADA>1</CODCOLIGADA>

                                               <IDPARTIDA>2<                                                                <IDPARTIDA>-2</IDPARTIDA>

                                                                <LCTREF>-2</LCTREF>

                                                                <CODLOTE>0<                                               <CODLOTE>0</CODLOTE>

                                               <IDLANCAMENTO>1<                                                                <IDLANCAMENTO>-1</IDLANCAMENTO>

                                               <LCTREF>2</LCTREF>

                                               <CODLOTEORIGEM>30</CODLOTEORIGEM>

                                                                <CODLOTEORIGEM>30</CODLOTEORIGEM>

                                                                <CODFILIAL>1<                                               <CODFILIAL>1</CODFILIAL>

                                               <DOCUMENTO>002349<                                                                <DOCUMENTO>002349</DOCUMENTO>

                                               <DATA>2010                                                                <DATA>2010-10-15T00:00:00</DATA>

                                               <CODCOLDEBITO>1<                                                                <CODCOLDEBITO>1</CODCOLDEBITO>

                                               <CODCOLCREDITO>1<                                                                <CODCOLCREDITO>1</CODCOLCREDITO>

                                               <CREDITO>1                                                                <CREDITO>1.1.1.1.004</CREDITO>

                                               <CODCOLPARTIDA>1<                                                                <CODCOLPARTIDA>1</CODCOLPARTIDA>

                                               <VALOR>237300.                                                                <VALOR>237300,00</VALOR>

                                               <VALOR2>121692.                                                                <VALOR2>121692,3077</VALOR2>

                                               <DATA2>2010                                                                <DATA2>2010-10-15T00:00:00</DATA2>

                                               <USUARIO>charles<                                                                <USUARIO>charles</USUARIO>

                                               <DATAINCLU>2010                                                                <DATAINCLU>2010-10-15T00:00:00</DATAINCLU>

                                               <USUARIOALTER>charles<                                                                <USUARIOALTER>charles</USUARIOALTER>

                                               <DATAALTER>2010                                                                <DATAALTER>2010-10-15T00:00:00</DATAALTER>

                                               <USUARIOINTEGRACAO>Walquiria<                                                                <USUARIOINTEGRACAO>Walquiria</USUARIOINTEGRACAO>

                                               <DATAINTEGRACAO>2011                                                                <DATAINTEGRACAO>2011-10-07T09:05:06.153</DATAINTEGRACAO>

                                               <INTEGRAAPLICACAO>C<                                                                <INTEGRAAPLICACAO>C</INTEGRAAPLICACAO>

                                               <INTEGRACHAVE>2349<                                                                <INTEGRACHAVE>2349</INTEGRACHAVE>

                                               <EXIGERATEIOCREDITO>0<                                                                <EXIGERATEIOCREDITO>0</EXIGERATEIOCREDITO>

                                               <ORIGINADONOVOMOD>1<                                                                <ORIGINADONOVOMOD>1</ORIGINADONOVOMOD>                                               <TIPOAGRUP>0<

                                                                <TIPOAGRUP>0</TIPOAGRUP>

                                                <TIPOAGRUP>                                    </CPARTIDA>

                                 <CRATEIOLCCREDITO>

                                                <CRATEIOLCCREDITO>

                                                                <CODCOLIGADA>1<                                               <CODCOLIGADA>1</CODCOLIGADA>

                                               <CODLOTE>0<                                                                <CODLOTE>0</CODLOTE>

                                               <IDRATEIO>1<                                                                <IDRATEIO>-1</IDRATEIO>

                                               <IDPARTIDA>2<                                                                <IDPARTIDA>-2</IDPARTIDA>

                                               <LCTREF>2<                                                                <LCTREF>-2</LCTREF>

                                               <CODCOLCONTA>1<                                                                <CODCOLCONTA>1</CODCOLCONTA>

                                               <CODCONTA>1                                                                <CODCONTA>1.1.1.1.004</CODCONTA>

                                               <CODCOLGERENCIAL>1<                                                                <CODCOLGERENCIAL>1</CODCOLGERENCIAL>

                                               <CODGERENCIAL>1                                                                <CODGERENCIAL>1.01.01.3</CODGERENCIAL>

                                               <DATA>2010                                                                <DATA>2010-10-15</DATA>

                                               <VLRCREDITO>237300.                                                                <VLRCREDITO>237300,00</VLRCREDITO>                                               <PERCENTUAL>100

.                                                                <PERCENTUAL>100,00</PERCENTUAL>

                                 <                                                </CRATEIOLCCREDITO>

                                 <CRATEIOLCDEBITO>

                                                <CRATEIOLCDEBITO>

                                                                <CODCOLIGADA>1<                                               <CODCOLIGADA>1</CODCOLIGADA>

                                               <CODLOTE>0<                                                                <CODLOTE>0</CODLOTE>

                                               <IDRATEIO>2<                                                                <IDRATEIO>-2</IDRATEIO>

                                               <IDPARTIDA>1<                                                                <IDPARTIDA>-1</IDPARTIDA>

                                               <LCTREF>1<                                                                <LCTREF>-1</LCTREF>

                                               <CODCOLCONTA>0<                                                                <CODCOLCONTA>0</CODCOLCONTA>

                                               <CODCONTA>1                                                                <CODCONTA>1.1.1.1.361</CODCONTA>

                                               <CODCOLGERENCIAL>1<                                                                <CODCOLGERENCIAL>1</CODCOLGERENCIAL>

                                               <CODGERENCIAL>1                                                                <CODGERENCIAL>1.01.01.4</CODGERENCIAL>

                                               <DATA>2010                                                                <DATA>2010-10-15</DATA>

                                               <VLRDEBITO>237300.                                                                <VLRDEBITO>237300,00</VLRDEBITO>                                               <PERCENTUAL>100

.                                                                <PERCENTUAL>100,00</PERCENTUAL>

                                 <                                                </CRATEIOLCDEBITO>

                                 <CLCOMPL>

                                                <CLCOMPL>

                                                                <CODCOLIGADA>1<                                               <CODCOLIGADA>1</CODCOLIGADA>

                                               <CODLOTE>0<                                                                <CODLOTE>0</CODLOTE>

                                               <LCTREF>1</LCTREF>

                                               <IDPARTIDA>1</IDPARTIDA>

                                                                <IDPARTIDA>-1</IDPARTIDA>

                                                <                                 </CLCOMPL>

                                 <CLCOMPL>

                                                <CLCOMPL>

                                                                <CODCOLIGADA>1<                                               <CODCOLIGADA>1</CODCOLIGADA>

                                               <CODLOTE>0<                                                                <CODLOTE>0</CODLOTE>                                               <LCTREF>2</LCTREF>

                                                                <IDPARTIDA>-2</IDPARTIDA>

                                               <IDPARTIDA>2</IDPARTIDA>                                 </ </CLCOMPL>                               <

                                                </CtbLan>        CtbLan>

        ]]>        >

        <        </tot:XML>        XML>

        <tot:Contexto>codcoligada=1<1;codusuario=mestre;codsistemas=C</tot:Contexto>

    </tot:SaveRecord>

   </soapenv:Body>

</soapenv:Envelope>

Obs.:

As tags <IDLANCAMENTO>, <IDPARTIDA>, <LCTREF> e <IDRATEIO> quando inseridas com valores negativos irão gerar um novo lançamento contábil, respeitando as FKs. Caso seja inserido um valor existente este lançamento será atualizado3 - Utilizando uma ferramenta como por exemplo o “SoapUI” é possível visualizar de forma fácil os webmethods disponíveis no serviço “http://localhost:8051/wsDataServer/MEX?wsdl”. Com esta ferramenta pode ser feito testes para inserir e ler os registros.