Inicia o processo de apuração de eventos contábeis e marcações de ponto para colaboradores em um determinado período. Permite filtrar por localidade, colaboradores específicos e recursos opcionais como totais diários, batidas diárias e totais mensais.
Possuí limite de 3 processos diários para cada tipo de "feature" e limite de 4 processos simultâneos. |
Corpo da requisição:| Campo | Tipo | Obrigatório | Descrição |
|---|
| registers | array | Situacional | Lista de matrículas dos colaboradores, se vazio, considera todos colaboradores. Quando o campo rescission for true, este campo se torna obrigatório e deve conter no mínimo uma matrícula. | | rescission | boolean | Sim | Indica se deve considerar funcionários demitidos. Padrão: false. | | month | string | Sim | Mês de apuração no formato "MM". | | year | string | Sim | Ano de apuração no formato "YYYY". | | paymentDate | string | Não | Data de pagamento no formato "YYYY-MM-DD". | | infotype | string | Não | Identificação do tipo do evento. Padrão: 0015. | | allowEmpty | boolean | Não | Permite eventos sem código contábil. Padrão: false. | | locations | array | Não | Filtra funcionários por localização cadastrada no Pontoweb. | | features | array | Não | Tipo de Processamento solicitado. Opções:
"daily.punches"(Batidas Diárias),
"daily.totals" (Total diário),
"monthly" (Mensal).
Padrão: monthly.
Pode solicitar um específico ou mais de um. Caso não informe, será gerado o padrão.
|
Exemplo de corpo da requisição:{
"registers": ["98a159Q"],
"rescission": false,
"month": "04",
"year": "2025",
"paymentDate": "2025-04-30",
"infotype": "0015",
"allowEmpty": false,
"locations": [],
"features": ["daily.punches", "daily.totals", "monthly"]
} |
Exemplo de resposta quando sucesso:Código do status: 200 {
"process": "6b28ff7e-dda5-415c-b5b4-ff776f92142b",
"company": "a133595",
"created_at": "2025-04-28T13:49:32.334Z"
} |
Exemplo comuns de erros:Não autorizado:Código de status: 401 {
"error": {
"code": 401,
"message": "Unauthorized"
}
} |
Sem permissão para acessar a rota:Código de status: 403 {
"error": {
"message": "Forbidden",
"code": 403
}
} |
Parâmetros obrigatórios não informados:Código de status: 400 {
"error": "\"rescission\" is required"
} |
|
Após a requisição do processamento, é possível consultar o status. Nesta consulta, retorna o status de um processo de apuração previamente iniciado. Informa se o processamento foi concluído, se houve erro e o progresso. É necessário fornecer o identificador do processo (process).
Corpo da resposta:| Campo | Tipo | Descrição |
|---|
| process | string | Código do processo iniciado. | | company | string | Código da empresa no sistema PontoWeb. | | status | string | Status atual do processo: processing – Processamento em andamento;
done – Processamento finalizado com sucesso;
error – Processamento finalizado com erro.
| | unique | string | Código identificador único para controle do processo. | | progress.done | number | Quantidade de colaboradores com processamento finalizado. | | progress.total | number | Quantidade total de colaboradores a serem processados. |
Exemplo de resposta quando esta em processamento:Código do status: 200 {
"status": "processing",
"unique": "323256d",
"process": "323256d-d0df-4c0d-a6c1-8d9ca6fed06b",
"company": "a133595",
"progress": {
"done": 0,
"total": 0
}
} |
Exemplo de resposta quando sucesso:Código do status: 200 {
"status": "done",
"unique": "3234ca5d",
"process": "3234ca5d-d0df-4c0d-a6c1-8d9ca6fed06b",
"company": "a133595",
"progress": {
"done": 1,
"total": 1
}
} |
Exemplo comuns de erros:Não autorizado:Código de status: 401 {
"error": {
"code": 401,
"message": "Unauthorized"
}
} |
Sem permissão para acessar a rota:Código de status: 403 {
"error": {
"message": "Forbidden",
"code": 403
}
} |
Processo com status inexistente ou expirado:Código de status: 400
Accept-Version v1: {
"error": {
"message": "Process not found",
"code": 400
}
} |
Accept-Version v2: {
"error": "Process not found"
} |
|
Obtém os resultados gerados do processamento, com base no código identificador único (unique). Os dados retornados podem incluir eventos mensais, totais diários e marcações de ponto, conforme definido na requisição solicitando os resultados apurados.
Os dados ficam disponíveis por 72 horas para consumo; após esse período, expiram automaticamente.
Importante: uma vez que os dados do processo são consultados com sucesso, os eventos retornados são marcados como "consumidos" e não serão exibidos novamente em chamadas futuras.
Para obter os mesmos eventos, será necessário ativar o re-consumo dos eventos através da rota 4. Habilitar re-consumo dos eventos.
Item | Descrição |
|---|
| Fluxo: | Cliente → PontoWeb | | URL API: | https://api.ahgora.com.br/reckons/:unique | | Método: | GET | | Autenticação: | Basic (ver) | | Parâmetro: | - Unique (string): é o código identificador único para controle .
Exemplo: 3234ca5d
| - Limit (number) (opcional): é o limite dos eventos que irão retornar na resposta.
- Padrão: 1000.
- Máximo: 1000.
|
Corpo da resposta quando o campo "features" é informado com "monthly" na solicitação de resultados apurados:| Campo | Tipo | Descrição |
|---|
unique | string | Código único identificador do processo. | | company | string | Código da empresa no sistema PontoWeb. | | total | number | Quantidade total de colaboradores. | | data | array | Contém a lista com as informações do colaborador e dos eventos. | | data.employee | string | Matrícula do colaborador. | | data.paymentDate | string | Data de pagamento no formato "YYYY-MM-DD". | | data.infotype | string | Identificação do tipo do evento. | | data.results | array | Contém a lista dos eventos mensais. | | data.results.name | string | Nome do código contábil. | | data.results.event | string | Código contábil do evento. | | data.results.value | string/number | Valor do evento contábil. Exemplos:
Eventos em Dias: "2";
Eventos em Horas: "16:00" (Para Sexagesimais ou Centesimais) | | data.results.type | string | Tipo do evento contábil. Pode conter:
- "days" - Para dias;
- "hours" - Para horas.
|
Exemplo de resposta com sucesso:Código de status: 200 {
"company": "a133595",
"unique": "3234ca5d",
"total": 1,
"data": [
{
"employee": "98a159Q",
"paymentDate": "2025-04-30",
"infotype": "0015",
"results": [
{
"name": "Horas previstas",
"event": "9077",
"value": "71:70",
"type": "hours"
},
{
"name": "Dias previstos",
"event": "9078",
"value": 1,
"type": "days"
}
]
}
]
} |
Corpo da resposta quando o campo "features" é informado com "daily.punches" na solicitação de resultados apurados:| Campo | Tipo | Descrição |
|---|
unique | string | Código único identificador do processo. | | company | string | Código da empresa no sistema PontoWeb. | | total | number | Quantidade total de dias com marcação. | | data | array | Contém a lista com as informações do colaborador e das marcações de ponto. | | data.employee | string | Matrícula do colaborador. | | data.paymentDate | string | Data de pagamento no formato "YYYY-MM-DD". | | data.infotype | string | Identificação do tipo do evento. | | data.daily | array | Contém a lista das marcações de ponto | | data.daily.day | string | Dia em que ocorreu a marcação de ponto no formato "YYYY-MM-DD". | | data.daily.punches | array | Lista com as informações das marcações de ponto. | | data.daily.punches.date | string | Data efetiva do registro da marcação de ponto. | | data.daily.punches.hour | string | Hora do registro da marcação de ponto no formato "HHMM". | | data.daily.punches.type | string | Tipo de registro. Pode conter: - "O" - REP ou Batida online
- "I" - Inclusão manual
| | data.daily.punches.label | string | Indica se o registro é de entrada ou saída. |
Exemplo de resposta com sucesso:Código de status: 200 {
"company": "a133595",
"unique": "3234ca5d",
"total": 1,
"data": [
{
"employee": "98a159Q",
"paymentDate": "2022-08-08",
"infotype": "0015",
"daily": [
{
"day": "2022-07-29",
"punches": [
{
"date": "2022-07-28",
"hour": "0800",
"type": "O",
"label": "entrada-1"
},
{
"date": "2022-07-28",
"hour": "0900",
"type": "I",
"label": "saida-1"
}
]
}
]
}
]
} |
Corpo da resposta quando o campo "features" é informado com "daily.totals" na solicitação de resultados apurados:| Campo | Tipo | Descrição |
|---|
unique | string | Código único identificador do processo. | | company | string | Código da empresa no sistema PontoWeb. | | total | number | Quantidade total de dias apurados. | | data | array | Contém a lista com as informações do colaborador e dos eventos diários | | data.employee | string | Matrícula do colaborador. | | data.paymentDate | string | Data de pagamento no formato "YYYY-MM-DD". | | data.infotype | string | Identificação do tipo do evento. | | data.daily | array | Contém a lista das batidas (Marcações de Ponto) | | data.daily.day | string | Dia em que ocorreu a batida no formato "YYYY-MM-DD". | | data.daily.results | array | Contém a lista dos eventos diários. | | data.daily.results.name | string | Nome do código contábil. | | data.daily.results.event | string | Código contábil do evento. | | data.daily.results.value | string | Valor do evento contábil. Exemplos:
Eventos em Dias: "2";
Eventos em Horas: "16:00" (Para Sexagesimais ou Centesimais) | | data.daily.results.type | string | Tipo do evento contábil. Pode conter: - "days" - Para dias;
- "hours" - Para horas.
|
Exemplo de resposta com sucesso:Código de status: 200 {
"company": "a133595",
"unique": "3234ca5d",
"total": 1,
"data": [
{
"employee": "98a159Q",
"paymentDate": "2022-08-08",
"infotype": "0015",
"daily": [
{
"day": "2022-08-08",
"results": [
{
"name": "Horas previstas",
"event": "9077",
"value": "71:70",
"type": "hours"
},
{
"name": "Dias previstos",
"event": "9078",
"value": 1,
"type": "days"
}
]
}
]
}
]
} |
Corpo da resposta quando o campo "features" contém todas as opções:Código de status: 200 {
"company": "a133595",
"unique": "3234ca5d",
"total": 2,
"data": [
{
"employee": "98a159Q",
"paymentDate": "2022-08-08",
"infotype": "0015",
"daily": [
{
"day": "2022-08-08",
"results": [
{
"name": "Horas previstas",
"event": "9077",
"value": "71:70",
"type": "hours"
},
{
"name": "Dias previstos",
"event": "9078",
"value": 1,
"type": "days"
}
],
"punches": [
{
"date": "2022-07-28",
"hour": "0800",
"type": "O",
"label": "entrada-1"
},
{
"date": "2022-07-28",
"hour": "0900",
"type": "I",
"label": "saida-1"
}
]
}
]
},
{
"employee": "98a159Q",
"paymentDate": "2022-08-08",
"infotype": "0015",
"results": [
{
"name": "Horas previstas",
"event": "9077",
"value": "71:70",
"type": "hours"
},
{
"name": "Dias previstos",
"event": "9078",
"value": 1,
"type": "days"
}
]
}
]
} |
Exemplo comuns de erros:Não autorizado:Código de status: 401 {
"error": {
"code": 401,
"message": "Unauthorized"
}
} |
Sem permissão para acessar a rota:Código de status: 403 {
"error": {
"message": "Forbidden",
"code": 403
}
} |
|
Restaura a disponibilidade dos eventos previamente consumidos em um processo de apuração. Após a execução desta rota, os dados associados ao identificador informado poderão ser obtidos novamente por meio da rota de consulta de resultados.
Item | Descrição |
|---|
| Fluxo: | Cliente → PontoWeb | | URL API: | https://api.ahgora.com.br/reckons/reconsume/:unique | | Método: | GET | | Autenticação: | Basic (ver) | | Parâmetro: | - Unique (string): é o código identificador único para controle.
Exemplo: 3234ca5d
| | Limite Máximo: | 1000 vezes (A apuração identificada pelo unique)
Cada apuração fica disponível por 72 horas, para re-consumo.
Depois deste tempo ela não é mais acessível. |
Corpo da reposta:| Campo | Tipo | Descrição |
|---|
| company | string | Código da empresa no sistema PontoWeb. | | unique | string | Código único identificador do processo. |
Exemplo de resposta quando sucesso:Código do status: 200 {
"company": "a133595",
"unique": "3234ca5d"
} |
Exemplo comuns de erros:Não autorizado:Código de status: 401 {
"error": {
"code": 401,
"message": "Unauthorized"
}
} |
Sem permissão para acessar a rota:Código de status: 403 {
"error": {
"message": "Forbidden",
"code": 403
}
} |
Processo com status inexistente ou expirado:Código de status: 400 {
"error": {
"message": "Process not found",
"code": 400
}
} |
|
deck.tab.inactive.background = #fffffff
deck.tab.active.background = #b3a5ef |
|
|