Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 1

changes.mady.by.user Bruno Ferreira da Costa

Gravado em

comparado com

Nova versão 2

changes.mady.by.user Bruno Ferreira da Costa

Gravado em

Chave

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

...

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


Informações
titleImportante
Autenticação Basic: Enviar usuário e senha do protheus no header da requisição.


     Body da requisição

Deck of Cards
startHiddenfalse
idbody
Card
defaulttrue
idbody1
labelDefinição das propriedades
titleDefinição das propriedades
Campos ProtheusPropriedades APIDescrição
RGB_MATmatriculaMatrícula do funcionário
RGB_PERIODanocomAno do período do resultado
RGB_PERIODmescomMês do período do resultado
RGB_SEMANAsemanaSemana do período

codfuncionarioCódigo do funcionário separado por pipe contendo Empresa + Filial + Matrícula
RGB_PDrubricaCódigo da verba do funcionário 
RGB_HORASreferenciaReferência em horas ou dia da verba
RGB_DTREFdatafaltaData da falta


Informações
titleImportante
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.
Card
idbody2
labelBody
titleBody

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


   Retorno

Deck of Cards
startHiddenfalse
idretorno
Card
defaulttrue
id200ok
label200 - OK
titleSucesso
Propriedades APIDescrição
matriculaMatrícula do funcionário
rubricaVerba processada
statusStatus 'S'(Sucesso) ou 'E'(Erro)
mensagemDetalhe da mensagem


Retorno status 'S'

{
  "response": [
    {
      "resultados": [
        {
          "matricula": "000001",
          "rubrica": "114",
          "status": "S",
          "mensagem": "Operação realizada com sucesso!"
        }
      ]
    }
  ]
}


Retorno status 'E'

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

Card
id400bas
label400 - Solicitação inválida
titleBody
Propriedades APIDescrição
empresaCódigo da empresa
filialFilial do funcionário
userUsuário do sistema
matriculaMatrícula do funcionário
periodoAno/Mês do Período
semanaSemana do período
processoCódigo do processo do período
roteiroRoteiro de cálculo do período
mensagemDetalhe da mensagem


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

{
  "filial": "D MG 01 ",
  "matricula": "XXXXX",
  "message": "Funcionário não localizado na base de dados."
}


Retorno de usuário sem permissão de acesso

{
  "empresa": "T2",
  "filial": "D MG 01 ",
  "user": "ahgora",
  "message": "Usuário sem permissão de acesso na Empresa/Filial."
}


Retorno de empresa/filial inexistente na base de dados

{
  "empresa": "Z1",
  "filial": "D MG 01 ",
  "message": "Empresa/Filial não encontradas na base de dados."
}


Retorno de usuário sem acesso a filial processada

{
  "empresa": "T1",
  "filial": "D MG 02 ",
  "user": "ahgora",
  "message": "Usuário sem permissão de acesso na filial."
}


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

{
  "periodo": "202403",
  "semana": "01",
  "processo": "02117",
  "roteiro": "FOL",
  "message": "Período/Semana não encontrados na base de dados ou o período está fechado. Necessário verificar o cadastro de períodos!"
}

04. DEMAIS INFORMAÇÕES

Não se aplica

05. ASSUNTOS RELACIONADOS

        Não se aplica Configuração REST




Templatedocumentos