Histórico da Página

01. DADOS GERAIS

Produto:

TOTVS RH

Solucoes_totvs

Solucao

Solucoes_totvs_cross

SolucaoCross

Solucoes_totvs_parceiros

SolucaoParceiros

Solucoes_totvs_parceirosexptotvs

SolucaoParcsExpsTOTVS

Linha de Produto:

Linha Protheus

Linhas_totvs

Segmento:

RH

Segmentos_totvs

Segmento

Módulo:

GESTÃO DE PESSOAS (SIGAGPE)

Função:

POR FUNCIONÁRIO (GPEA090)

Ticket:

Requisito/Story/Issue (informe o requisito relacionado) :

DRHCALCPRT-13991

02. SITUAÇÃO/REQUISITO

Criação de API para integração dos resultados do ponto originados do sistema Ahgora para o Protheus.

03. SOLUÇÃO

Foi criado a API 'results', para receber os resultados originados do sistema de ponto da Ahgora, para integração nos lançamentos do funcionário no Protheus.

...

Este método é responsável por importar os resultados do sistema Ahgora, nos lançamentos do funcionário no Protheus.

Endpoint:api/rh/v1/v1/ahgora/results
Método: POST
Autenticação: Basic

...

Deck of Cards

startHidden	false
id	body

Card

default	true
id	body1
label	Definição das propriedades
title	Definição das propriedades

Campos Protheus	Propriedades API	Descrição
RGB_MAT	matricula	Matrícula do funcionário - Matrícula deve ser enviada concatenada sem o pipe: Empresa + Filial + Matricula
RGB_PERIOD	anocom	Ano do período do resultado
RGB_PERIOD	mescom	Mês do período do resultado
RGB_SEMANA	campoAdicional	semana	Semana Para o protheus será tratado para verificar a semana do período
	codfuncionario	Código do funcionário separado por pipe contendo Empresa + Filial + Matrícula
RGB_PD	rubrica	Código da verba do funcionário
RGB_HORAS	referencia	Referência em horas ou dia da verba
RGB_DTREF	datafalta	Data da falta

Informações

title	Importante

Envio do atributo 'datafalta' vazio, será assumido o primeiro dia do período que está sendo processado, todas as verbas serão gravadas com referência.

Para o atributo 'campoAdicional', para o protheus será usado para enviar a semana do período, caso seja enviado vazio, será assumido a semana aberta do período em questão.

Caso ocorra um segundo envio do resultado para o funcionário no mesmo período, o primeiro envio do resultado será deletado da tabela RGB, e será gravado apenas o último envio.

Card

id	body2
label	Body
title	Body

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vaziaBody

{
  "items": [
    {
      "matricula": "0000010101000001",
      "anocom": "2024",
      "mescom": "08",
      "semanacampoAdicional": "1",
      "codfuncionario": "01|01|000001",
      "resultados": [
        {
          "rubrica": "114",
          "referencia": "1,30",
          "datafalta": ""
        }
      ]
    }
  ]
}

...

Deck of Cards

startHidden	false
id	retorno

cardid400bas

Card

default	true
id	200ok
label	200 - OK
title	Sucesso

Propriedades API	Descrição
matricula	Matrícula do funcionário concatenada por Empresa + Filial + Matricula
rubrica	Verba processada
status	Status 'S'(Sucesso) ou 'E'(Erro)
mensagem	Detalhe da mensagem
referencia	Referência da rubrica
datafalta	Data da falta quando houver

Retorno status 'S'

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vaziaOperação realizada com sucesso!

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "0000010101000001",
          "rubrica": "114",
          "status": "S",
          "mensagem": "Operação realizada com sucesso!",
          "referencia": "1",
          "datafalta": "20240722" 
        }        }
      ]
    }
  ]
}

Retorno status 'E'

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vaziaVerba não encontrada na base de dados

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "0000010101000001",
          "rubrica": "ASD",
          "status": "E",
          "mensagem": "Verba não encontrada na base de dados.",
		  "referencia": "1",
          "datafalta": ""  
         }
      ]
    }
  ]
}

Bloco de código

language

Propriedades API

Descrição

empresa

Código da empresa

filial

Filial do funcionário

user

Usuário do sistema

matricula

Matrícula do funcionário

periodo

Ano/Mês do Período

semana

Semana do período

processo

Código do processo do período

roteiro

Roteiro de cálculo do período

mensagem

Detalhe da mensagem

cpp

label

400 - Solicitação inválida

title

Body

title
theme	Confluence

Retorno funcionário não encontrada na base de dados

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{
  "filial": "D MG 01 ",
  "matricula": "XXXXX",
  "message{
  "response": [
    {
      "resultados": [
        {
          "matricula": "0101XXXXXX",
          "rubrica": "001",
          "status": "E",
          "mensagem": "Funcionário não localizado na base de dados.",
          "referencia": "1",
          "datafalta": "20240722"  
        },
        {
          "matricula": "0101XXXXXX",
          "rubrica": "001",
          "status": "E",
          "mensagem": "Funcionário não localizado na base de dados.",
          "referencia": "1",
}

Retorno de usuário sem permissão de acesso

          "datafalta": "20240723"           
        }
      ]
    }
  ]
}

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia	Retorno de usuário sem permissão de acesso

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "0101000001",
          "rubrica": "Z52",
          "status": "E",
          "mensagem": "Usuário sem permissão de acesso na Empresa/Filial.",
          "referencia": "1",
          "datafalta": ""  
        },
        {
          "matricula": "0101000001",
          "rubrica": "Z53",
          "status": "E",
          "mensagem{
  "empresa": "T2",
  "filial": "D MG 01 ",
  "user": "ahgora",
  "message": "Usuário sem permissão de acesso na Empresa/Filial.",
		  "referencia": "1",
          "datafalta": ""  
        }

Retorno de empresa/filial inexistente na base de dados


      ]
    }
  ]
}

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia	Retorno de empresa/filial inexistente na base de dados

{
  "response": [
    {
      "resultados": [
        {
          "matricula{
  "empresa": "Z10101000001",
           "filialrubrica": "D MG 01 ",
  "messageZ52",
          "status": "E",
          "mensagem": "Empresa/Filial não encontradas na base de dados.",
          "referencia": "1",
}

Retorno de usuário sem acesso a filial processada

          "datafalta": ""  
        }
      ]
    }
  ]
}

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vaziaRetorno de período do processamento não encontrado ou fechado

{
  "empresaresponse": [
    {
      "T1",resultados": [
        {
  "filial        "matricula": "D MG 02 "0101000001",
          "rubrica": "202",
    "user      "status": "ahgoraE",
          "messagemensagem": "Usuário sem permissão de acesso na filial."
}

Retorno de período do processamento não encontrado ou fechado

Bloco de código

language	cpp
theme	Confluence
title	Propriedade Product vazia

{
  "periodo": "202403",
  "semana": "01",
  "processo": "02117",
  "roteiro": "FOL",
  "messagePeríodo/Semana não encontrados na base de dados ou o período está fechado. Necessário verificar o cadastro de períodos!",
          "referencia": "1",
          "datafalta": "20240722" 
        },
        {
          "matricula": "0101000002",
          "rubrica": "203",
          "status": "E",
          "mensagem": "Período/Semana não encontrados na base de dados ou o período está fechado. Necessário verificar o cadastro de períodos!"
		  "referencia": "1",
          "datafalta": ""  
        }
      ]
    }
  ]
}

Bloco de código

language	cpp
theme	Confluence
title	Retorno de limite de lançamentos diários para a mesma verba

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "T2D MG 02 600528",
          "rubrica": "003",
          "status": "S",
          "mensagem": "Operação realizada com sucesso!",
          "referencia": "1,30",
          "datafalta": ""
        },
        {
          "matricula": "T2D MG 02 600528",
          "rubrica": "003",
          "status": "E",
          "mensagem": "Verba ultrapassou o limite de lançamentos diários, verificar o cadastro da verba.",
          "referencia": "1,30",
          "datafalta": "20220102"
        },
        {
          "matricula": "T2D MG 02 600528",
          "rubrica": "003",
          "status": "E",
          "mensagem": "Verba ultrapassou o limite de lançamentos diários, verificar o cadastro da verba.",
          "referencia": "1,30",
          "datafalta": "20220103"
        }
      ]
    }
  ]
}

Card

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

Bloco de código

language	cpp
theme	Confluence

{
  "code": 400,
  "message": "Não foi enviado nenhum registro na requisição para ser gravado."
}

04. DEMAIS INFORMAÇÕES

Não se aplica

05. ASSUNTOS RELACIONADOS

Configuração REST

Templatedocumentos

...

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão Atual

Chave

01. DADOS GERAIS

02. SITUAÇÃO/REQUISITO

03. SOLUÇÃO

04. DEMAIS INFORMAÇÕES

05. ASSUNTOS RELACIONADOS