Histórico da Página

...

Produto:	RM
Linha de Produto:	Linha RM
Segmento:	RH
Módulo:	TOTVS Folha de Pagamento
Função:	Integração RM X Ahgora - API de Eventos/Verbas
País:	Brasil
Requisito/Story/Issue (informe o requisito relacionado) :	DRHROTRM-13585

02. LIBERAÇÃO

Lembrando que, será a partir dos patches:

12.1.2410.xxx
12.1.2502.xxx
12.1.2506 e superiores

03. SITUAÇÃO/REQUISITO

...

Visando otimizar a integração entre os sistemas, foi disponibilizada a API ahgora/verbas. Essa API é responsável por enviar automaticamente as informações dos Eventos/Verbas cadastradas na Folha de Pagamento para o Ponto Web da Ahgora, garantindo mais agilidade, padronização e segurança no compartilhamento de informações.

Este método é responsável por enviar uma lista de verbas da tabela GCOLIGADA da linha de produto RM.

Endpoint: api/rh/v1/ahgora/verbas?page=1&pageSize=500&cnpjList= 'CNPJ da COLIGADA'
Método: GET
Autenticação: Basic

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
page	Numérico	Sim	Número da página a ser consultada (inicia em 1).
pageSize	Numérico	Sim	Quantidade de registros por página.
cnpjList	String	Sim

CNPJs das filiais

CNPJ(s) da(s) Coligada(s) que serão consultadas na base do

Protheus

RM

Nota

title	Importante:

O sistema da Ahgora não está dentro da sua rede, logo, para funcionar a busca das verbas, seu REST no RM deve permitir esse acesso externo.

Configurações de porta no firewall, IP público, DNS e redirecionamento de portas devem ser verificadas junto com o seu time de TI/Redes.

Informações

title	Atenção:

Autenticação Basic: Enviar usuário e senha do RM no header da requisição.

Retorno

Deck of Cards

startHidden	false
id	retorno

Card

default	true
id	200ok
label	200 - OK
title	Sucesso

Propriedades API	Descrição
cod	Código da Verba - PEVENTO.CODIGO
desc	Descrição da Verba - PEVENTO.DESCRICAO
cnpj	CNPJ da Coligada- GCOLIGADA.

...

CGC
categoria	Provento - Hora ou Dia; Desconto - Hora ou Dia; Base de Cálculo - Hora ou Dia; - PEVENTO.PROVDESCBASE e PEVENTO.VALHORDIAREF

Será retornado uma lista com as verbas referente ao CNPJ da coligada que foi enviado na requisição e caso tenha algum erro será enviado no array de erros dentro do response.

Bloco de código

language	js
title	Operação realizada com sucesso!
linenumbers	true

{
    "response": [
        {
            "erros": [
                {
                    "mensagem": "05.295.401/0001-30",
                    "cnpj": "Necessário ativar a integração."
                },
                {
                    "mensagem": "07.363.764/0001-90",
                    "cnpj": "Coligada não existe."
                }
            ],
            "items": [
                {
                    "cod": "0001",
                    "desc": "HORAS NORMAIS 2",
                    "cnpj": "07.577.599/0001-70",
                    "categoria": "Provento-Hora"
                },
                {
                    "cod": "0002",
                    "desc": "DIAS TRABALHADOS2",
                    "cnpj": "07.577.599/0001-70",
                    "categoria": "Provento-Dia"
                },
                {
                    "cod": "0003",
                    "desc": "INSS2",
                    "cnpj": "07.577.599/0001-70",
                    "categoria": "Desconto-Valor"
                }
            ],
            "hasNext": true
        }
    ]
}

Informações

title	Importante:

Caso o número de itens ultrapasse o limite da página, o campo hasNext será retornado como true, indicando que há mais dados a serem requisitados.
O recomendável é solicitar 500 itens por página.

Card

id	400bas
label	400 - Solicitação inválida
title	Body

Verificar se todos os parâmetros foram passados na requisição

Bloco de código

language	js
theme	Confluence
linenumbers	true

{
    "code": "FE016",
    "message": "O campo CnpjList é obrigatório.\r\n",
    "detailedMessage": "",
    "helpUrl": "",
    "details": null
}

05. DEMAIS INFORMAÇÕES

Integração RM X Ahgora

Importante

Colocar mais detalhes semelhante ao TDN do Protheus : DT Integração Ahgora - API Verbas e Sindicatos

...

Atalhos

Páginas filhas

Versões comparadas

Versão antiga 3

Nova versão Atual

Chave

02. LIBERAÇÃO

03. SITUAÇÃO/REQUISITO

Parâmetros de Consulta

05. DEMAIS INFORMAÇÕES