Objetivo: Realizar o envio, por parte da Ahgora, dos resultados apurados do ponto, permitindo a transferência de dados para vários funcionários simultaneamente. - Tipo de requisição: POST
- Endpoint: api/rh/ahgora/v1/results
- Autenticação: Basic Authentication
- Para autenticação com o RH Datasul, basta ter um usuário com permissões da acesso as informações do funcionário, e utilizar o Basic Authentication usuário e senha.
- Sugestão que seja um usuário genérico, para evitar recadastro caso ocorra alteração de permissões de usuário.
Body: Nome | Descrição | Tipo | Obrigatório | Exemplo | items | Array de objetos funcionário | objeto | Sim |
|
Objeto funcionário
Nome | Descrição | Tipo | Obrigatório | Exemplo | matricula | Matrícula do funcionário (campo exclusivo da Ahgora). | string | Sim | "10100000001" | anocomp | Ano competência. | string | Sim | "2024" | mescomp | Mês competência. | string | Sim | "12" | campoAdicional | Número do Pagamento | string | Sim | "01" | codfuncionario | Campo usado para identificar estabelecimento e matricula do funcionário. É composto por Empresa|Estabelecimento|Matricula. | string | Sim | "10|1|00000001" | resultados | Array de objetos rubrica, representa os resultados de ponto do funcionário. | objeto | Sim |
|
Objeto evento
Nome | Descrição | Tipo | Obrigatório | Exemplo | rubrica | Composto pelo código do Evento. | string | Sim | "206" | referencia | Valor de referência, dado tipo da verba, será considerado como hora, valor. Quando enviado como horas, deve ser considerado o formato centesimal. Exemplo: o funcionário teve uma situação de jornada incompleta totalizando 1 hora e 30 min. Neste caso, deve ser enviado ao Datasul o valor de 1,50. |
| string | Sim | "1,50" | datafalta | Será retornado a data da falta. | string | Não | "20240802" |
{
"items": [
{
"matricula": "1019445",
"anocom": "2023",
"mescom": "11",
"campoAdicional": "",
"codfuncionario": "10|1|9445",
"resultados": [
{
"rubrica": "103",
"referencia": "15,30",
"datafalta": ""
}
]
}
]
} |
Estrutura de Retorno: O retorno é por rubrica processada, se foram enviados 6 funcionários, cada um com 2 rubricas. A api vai retornar 12 rubricas, cada uma com seu 'status' e 'mensagem'. Nome | Descrição | Tipo | Obrigatório | Exemplo | response | Array de objetos resultado | objeto | Sim |
|
Objeto resultado: Nome | Descrição | Tipo | Obrigatório | Exemplo | resultados | Array de objetos rubrica, representa os resultados de ponto do funcionário. | objeto | Sim |
|
Objeto rubrica: Nome | Descrição | Tipo | Obrigatório | Exemplo | matricula | Matricula enviada na requisição | string | Sim | "1019445" | rubrica | Rubrica enviada na requisição. | string | Não | "103" | status | Informa se foi concluído ou não. Entende-se 'E' como erro e 'S' como sucesso. | string | Sim | "E" ou "S" | mensagem | Mensagem com descrição do status. | string | Sim | "Operação realizada com sucesso!" | referencia | Referencia enviada na requisição. | string | Não | "1,50" | datafalta | Data falta enviada na requisição. | string | Não | "20231101" |
{
"response": [
{
"resultados": [
{
"matricula": "1019445",
"rubrica": "103",
"status": "S",
"mensagem": "Operação realizada com sucesso!",
"referencia": "15,30",
"datafalta": ""
}
]
}
]
} |
|
- As informações integradas entre o PontoWeb e o RH Datasul são exibidas no programa FP2040 - Manutenção Movimento c/ Controle Parcela.
- Com base nos dados enviados, são geradas as informações necessárias para o cálculo do funcionário, permitindo a criação de vencimentos ou descontos apurados pelo PontoWeb.
|
| Tipo Informação | Regra |
|---|
| Matricula (Empresa + Estab e Matricula) | FP1500 - Manutenção do Funcionário | | Ano / Mês Competencia | FP3000 - Manutenção de Habitação de Cálculo | | codFuncionario (Empresa + |+ Estab + |+ Matricula) | FP1500 - Manutenção do Funcionário | | Rubrica | FP0020 - Manutenção Eventos |
|
|
Lista de erros que podem ocorrer durante a integração.
Mensagem | Detalhes | Folha Normal já calculada. | | Quantidade deve ser maior ou igual a 0 (zero). | - Isso significa que o valor ou horas, são menores que zero.
| Evento inexistente. | - Isso significa que o evento não foi encontrado na base do RH Datasul.
| Funcionário inexistente. | - Isso significa que o funcionário não foi encontrado na base do RH Datasul.
| Ano/Mês competência incorreto(s). | - Isso significa que a Folha de Pagamento já esta concluída para o funcionário.
- Período dos envios é anterior à habilitação do cálculo. Nesse caso, é importante verificar se a competência informada está correta.
| Já existe ocorrência Situação Afastamento informada. | - Isso significa que já exista uma situação de afastamento informado para a mesma da datafalta.
| Evento não está relacionado a uma falta injustificada.
| - Isso significa que o evento não está informado no FP0060. Quando a datafalta é informada no envio dos resultados, o programa verifica as situações de afastamento do tipo 'falta injustificada' que contenham o evento informado na aba Ponto, nos campos 'Afastamento Diurno' e 'Afastamento Noturno', tanto para horistas quanto para mensalistas.
|
|
|