RH - RM - FOP - Como realizar o lançamento de eventos/verbas para o envelope de pagamento via DataServer ou API? – Central de Atendimento TOTVS

Tempo aproximado para leitura: 00:04:00 min

Dúvida
Como realizar o lançamento de eventos/verbas para o envelope de pagamento via DataServer ou API? FopLancExternoData

Ambiente
TOTVS RH - TOTVS RH (Linha RM) - TOTVS Folha de Pagamento - Todas as versões

Solução
O DataServer/API indicado nesta documentação é o recomendado pela TOTVS, pois incorpora uma camada adicional de segurança. Nesse fluxo, após o lançamento das verbas via WebService, o Departamento Pessoal (DP) pode visualizar a movimentação por meio da tela de Consulta de Movimento de Integração e, caso esteja correta, realizar a aprovação para inclusão no envelope dos funcionários, pelo Grupo de Eventos.

Para realizar o lançamento de eventos/verbas para o envelope de pagamento através de API ou Webservice, a inserção deverá ser feita através de um lançamento externo (Consulta Movimento Integração). Abaixo, exemplificamos esse processo utilizando as ferramentas SoapUI e Postman:

🔹Lançamento via SoapUI (Dataserver)

🔹Lançamento via Postman (Api rest)

🔹Efetivação dos lançamentos no envelope

🔹Lançamento via Dataserver (SoapUI):

Para obter um XML exemplo, execute via SOAP um ReadRecord (Função de consultar dados) no dataserver FopLancExternoData. Para executar este método, devem ser fornecidas em "PrimaryKey" as chaves primárias:

CODCOLIGADA;
CHAPA;
ANOCOMP; (Ano competência)
MESCOMP; (Mês competência)
CODEVENTO; (Código do evento/verba)
IDMOVTEMP; (Id do lançamento externo)

Em "DataServerName" informe o valor FopLancExternoData.

Em contexto, forneça os seguintes parâmetros:

CODCOLIGADA
CODUSUARIO
CODSISTEMA

XML exemplo:

<![CDATA[<FopLancExterno >
  <PFMOVTEMP>
    <CODCOLIGADA>1</CODCOLIGADA>
    <CHAPA>00001</CHAPA>
    <ANOCOMP>2026</ANOCOMP>
    <MESCOMP>6</MESCOMP>
    <CODEVENTO>0005</CODEVENTO>
    <IDMOVTEMP>-1</IDMOVTEMP>
    <HORA>300</HORA>
    <REF>0.00</REF>
    <VALOR>0.00</VALOR>
    <ORIGEMEVENTO>7</ORIGEMEVENTO>
    <DATAINCLUSAO>2026-02-26T11:23:13</DATAINCLUSAO>
    <CODUSUARIO>mestre</CODUSUARIO>
    <TIPOLANCAMENTO>15</TIPOLANCAMENTO>
    <HORAFORMATADA>005:00</HORAFORMATADA>
  </PFMOVTEMP>
</FopLancExterno>]]

Após o obter o XML exemplo, para inserir um novo registro, utilize o método SaveRecord. Atualize os valores base do XML para as informações do novo registro que será inserido. Atente-se ao formato exigido pelas tags, seguindo o mesmo padrão da estrutura XML obtida no ReadRecord.

Observação:

Utilize IDMOVTEMP= -1 para geração do ID sequencial automático

ORIGEMEVENTO = 7 (Sistema Externo)

TIPOLANCAMENTO = 16 (Lançamento Sistema Externo)

Após execução, o lançamento ficará disponível na tela "Consulta Movimento Integração" em "Folha Mensal":

🔹Lançamento via API Rest (Postman):

Para obter um "Json" exemplo, execute o método GET no endopint "/rmsrestdataserver/rest/FopLancExternoData". Exemplo:

http://localhost:8051/rmsrestdataserver/rest/FopLancExternoData

Observação: Inclua no Headers a chave CodColigada com o valor correspondente

JSON Exemplo:

 {
         
            "CODCOLIGADA": 1,
            "CHAPA": "00001",
            "NOME": "ITAMAR MENDES",
            "ANOCOMP": 2026,
            "MESCOMP": 7,
            "CODEVENTO": "0005",
            "DESCRICAO": "SALARIO FAMILIA",
            "IDMOVTEMP": -1,
            "HORA": 300,
            "HORAFORMATADA": "005:00",
            "REF": 0.00,
            "VALOR": 0.00,
            "VALORFORCADO": 0,
            "CODCCUSTO": null,
            "ORIGEMEVENTO": 7,
            "DATAINCLUSAO": "2026-02-26T11:23:13-03:00",
            "CODUSUARIO": "mestre",
            "TIPOLANCAMENTO": 15,
            "IDITEMCONTABIL": null,
            "IDCLASSEVALOR": null
        }

Após obter o JSON exemplo, atualize os valores mantendo o mesmo padrão e execute método Post para inserir um novo registro.

🔹 Efetivação dos lançamentos no envelope:

Para lançar os eventos para o envelope, realize os seguintes passos:

Acesse: Folha Mensal | Lançamento | Grupo de Eventos. Ao parametrizar o grupo de eventos, será necessário marcar a flag "Lançar eventos da integração com outros aplicativos".