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/v1/ahgora/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 por Empresa + Evento. O sistema só irá considerar os últimos 4 dígitos para encontrar o código da evento. | string | Sim | "10206" | referencia | Valor de referência, dado tipo da verba, será considerado como hora, valor. | string | Sim | "1,30" | datafalta | Será retornado a data da falta. | string | Não | "20240802" |
| Expandir |
|---|
| {
"items":[
{
"matricula":"1019445",
"anocom":"2023",
"mescom":"11",
"campoAdicional":"",
"codfuncionario":"10|1|9445",
"resultados":[
{
"rubrica":"10103",
"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 | 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 | "10103" | 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,59" | datafalta | Data falta enviada na requisição. | string | Não | "20231101" |
| Expandir |
|---|
| {
"response":[
{
"resultados":[
{
"matricula":"1019445",
"rubrica":"10103",
"status":"S",
"mensagem":"Operação realizada com sucesso!",
"referencia":"15,30",
"datafalta":""
}
]
}
]
} |
| 