Linha RM

Atalhos

Páginas filhas
  • DT - Integração RM X Ahgora - API de Eventos/Verbas

Versões comparadas

Versão antiga 1

changes.mady.by.user Simone Cristina Dos Reis

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Monica Germany Mendes Ruela Oliveira

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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

Criação de API para integração dos dados dos eventos/verbas para o Ponto Web da Ahgora.

04. SOLUÇÃO

Disponibilizamos Visando otimizar a integração entre os sistemas, foi disponibilizada a API ' ahgora/verbas', responsáveis . Essa API é responsável por enviar os dados dos eventos/verbas da automaticamente as informações dos Eventos/Verbas cadastradas na Folha de Pagamento RM para o Ponto Web da Ahgora.

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

...

, 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

pageNuméricoSimNúmero da página a ser consultada (inicia em 1).
pageSizeNuméricoSimQuantidade de registros por página.
cnpjListStringSimCNPJ(s) da(s) Coligada(s) que serão consultadas na base do RM



Nota
titleImportante:

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
titleAtenção:

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


   Retorno

Deck of Cards
startHiddenfalse
idretorno
Card
defaulttrue
id200ok
label200 - OK
titleSucesso
Propriedades APIDescrição
codCódigo da Verba - PEVENTO.CODIGO
descDescrição da Verba - PEVENTO.DESCRICAO
cnpjCNPJ da Coligada- GCOLIGADA.CGC
categoriaProvento - 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
languagejs
titleOperação realizada com sucesso!
linenumberstrue
{
    "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
titleImportante:

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
id400bas
label400 - Solicitação inválida
titleBody

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

Bloco de código
languagejs
themeConfluence
linenumberstrue
{
    "code": "FE016",
    "message": "O campo CnpjList é obrigatório.\r\n",
    "detailedMessage": "",
    "helpUrl": "",
    "details": null
}


05. DEMAIS INFORMAÇÕES

Integração RM X Ahgora