Portuguese (Brasil)

Esta documentação descreve os recursos da API de Apuração de Resultados do sistema Pontoweb. A API permite iniciar processos de apuração, acompanhar seu status, consultar os resultados apurados e gerenciar o re-consumo de eventos já processados.

As operações foram desenvolvidas para integração com sistemas de folha de pagamento, contabilidade ou outras aplicações corporativas que necessitam acessar dados de apuração de ponto e eventos contábeis dos colaboradores.

Todas as requisições exigem autenticação via HTTP Basic Auth, utilizando um usuário do tipo service. Algumas rotas também requerem cabeçalhos específicos de versionamento.

As respostas seguem o formato JSON, com mensagens claras de erro e sucesso para facilitar o tratamento por aplicações clientes.

Section

Deck of Cards

id	001

Card

label	Autenticação

ITG2.0-01 Autenticação

Card

label	1. Solicitar resultados apurados

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.

Informações

Possuí limite de

title	Limitações de Uso

É permitido, no máximo, 3 processos diários para a "base full", para cada tipo de parâmetro "feature"

e limite de

consumido (daily.totals, daily.punches e monthly). Em chamadas informando o filtro de matrícula (não são "base full"), o consumo é livre.
É permitido o start de, no máximo, 4 processos simultâneos.

Item	Descrição
Fluxo:	Cliente → PontoWeb
URL API:	https://api.ahgora.com.br/reckons/process/start
Método:	POST
Autenticação:	Basic (ver)

Corpo da

requisição

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

Apresenta funcionários sem dados. 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:

theme

includeEmptyCode

boolean

Não

Indica ao fluxo que eventos sem código contábil também devem ser incluídos no retorno dos resultados. Padrão: false.

Observação: Quando definido como true, os eventos retornados poderão conter valores negativos, caso o valor original do evento seja negativo.

Exemplos de Requisições (Requests)

Corpo da Requisição:

Bloco de código

theme
language	text

Bloco de código

language text

	Emacs
linenumbers	true
collapse	true

{
    "registers": ["98a159Q"],
    "rescission": false,
    "month": "04",
    "year": "2025",
    "paymentDate": "2025-04-30",
    "infotype": "0015",
    "allowEmpty": false,
    "locations": [],
    "features": ["daily.punches", "daily.totals", "monthly"],
	"includeEmptyCode": false
}

Exemplo de resposta quando sucesso:

Código do status: 200

Exemplos de Respostas (Responses)

Resposta quando SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "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

ERRO de Autenticação - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Sem permissão para acessar a rota:

Código de status: 403

ERRO de Permissão - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Forbidden",
        "code": 403
    }
}

Parâmetros obrigatórios não informados:

Código de status: 400

Observação: Verificar as permissões do usuário para acessar a rota/serviço.

ERRO de Validação - Code 400:

Bloco de código

theme	Emacs
linenumbers	true
collapse	true

{
    "error": "\"rescission\" is required"
}

Observação: Verifique os parâmetros obrigatórios do request.

Card

label	2. Verificar status do processo

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).

Item	Descrição
Fluxo:	Cliente → PontoWeb
URL API:	https://api.ahgora.com.br/reckons/process/status/:process
Método:	GET
Autenticação:	Basic (ver)
Parâmetro:	Process É o código identificador do processo iniciado, obtido no retorno da requisição de "Solicitar" Exemplo: 6b28ff7e-dda5-415c-b5b4-ff776f92142b

Query Params
Chave	Valor
Accept-Version	v1 v2

Corpo da

resposta

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:

Exemplos de Respostas (Responses)

Resposta quando em PROCESSAMENTO - Code 200:

Código do status: 200

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "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

Resposta quando SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "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

text

ERRO de Validação - Code 400:

Accept-Version v1

Bloco de código

Bloco de código

language

theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "

code

message":

401

 "Process not found",
        "

message

code":

"Unauthorized"

400
    }
}

Sem permissão para acessar a rota:

Observação: Verifique o unique informado.

ERRO de Validação - Code 400:

Accept-Version v2:

Código de status: 403

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": "Process not

{

found"
}

Observação: Verifique o unique informado.

ERRO de Autenticação - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "

message

error":

"Forbidden",

{
        "code":

403

401,

}

    "message": "Unauthorized"
    }
}

Processo com status inexistente ou expirado:

Código de status: 400

Observação: Verifique usuário e senha.

ERRO de Permissão - Code 403

Accept-Version v1

:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "

Process not found

Forbidden",
        "code":

400

403
    }
}

Accept-Version v2:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{ "error": "Process not found" }

Observação: Verificar as permissões do usuário para acessar a rota/serviço.

Card

label	3. Obter resultados apurados

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
Parâmetro:	Limit (number) (opcional): é o limite

dos eventos

de registros que irão retornar na resposta.
- Padrão: 1000.
- Máximo: 1000.

Corpo da

Exemplos de Respostas (Responses)

Resposta - monthly

Exemplo de 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. Observação: Quando o parâmetro do body includeEmptyCode estiver definido como true, este campo poderá vir com valor vazio.
data.results.value	string/number	Valor do evento contábil. Exemplos: Eventos em Dias:

"

2

"

;
Eventos em Horas: "16:

00

30" (

Para Sexagesimais ou

Sexagesimais) Eventos em Horas: "16,50" (Centesimais)
data.results.type	string	Tipo do evento contábil. Pode conter: "days" - Para dias; "hours" - Para horas.

Aviso
Por padrão, as Faltas são enviadas em horas (value e type).

Exemplo de resposta com sucesso:

Código de status: 200

Resposta com SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
	"company": "a133595",
    "unique": "3234ca5d",
    "total": 1,
    "data": [
        {
            "employee": "98a159Q",
            "paymentDate": "2025-04-30",
            "infotype": "0015",
            "results": [
                {
                      "name": "Horas previstas",
                      "event": "9077",
                      "value": "71:

70

20",
                      "type": "hours"
                  },
                  {
                      "name": "Dias previstos",
                      "event": "9078",
                      "value": 1,
                      "type": "days"
                  }
            ]
        }
    ]
}

Corpo da

Resposta - daily.punches

Exemplo de 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

Online.
"I" - Inclusão

manual

Manual. "BI" - Registros de Pausas.
data.daily.punches.label	string	Indica se o registro é de entrada ou saída.

Exemplo de resposta com sucesso:

Código de status: 200

Resposta com SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
	"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 - daily.totals

Exemplo de 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

colaboradores

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. Observação: Quando o parâmetro do body includeEmptyCode estiver definido como true, este campo poderá vir com valor vazio.
data.daily.results.value	string	Valor do evento contábil.

Exemplos:

Eventos em Dias:

"

2

"

;
Eventos em Horas: "16:

00

30" (

Para Sexagesimais ou

Sexagesimais)
Eventos em Horas: "16,50" (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

Resposta com SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "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

20",
                            "type": "hours"
                        },
                        {
                            "name": "Dias previstos",
                            "event": "9078",
                            "value": 1,
                            "type": "days"
                        }
                    ]
                }
            ]
        }
    ]
}

Corpo da

Resposta - daily.totals, daily.punches e monthly

Exemplo de resposta quando o campo "features" contém todas as opções.

Resposta com SUCESSO - Code 200:

Código de status: 200

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "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

20",
                            "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

20",
                    "type": "hours"
                },
                {
                    "name": "Dias previstos",
                    "event": "9078",
                    "value": 1,
                    "type": "days"
                }
            ]
        }
    ]
}

Exemplo comuns de erros:

Não autorizado:

Código de status:

ERRO de Autenticação - Code 401

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Sem permissão para acessar a rota:

Código de status:

Observação: Verificar usuário e senha informado.

ERRO de Permissão - Code 403

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Forbidden",
        "code": 403
    }
}

Observação: Verificar as permissões do usuário para acessar a rota/serviço.

Card

label	4. Habilitar re-consumo dos eventos

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

Resposta:

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:

Exemplos de Respostas (Responses)

Resposta quando SUCESSO - Code 200:

Código do status: 200

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "company": "a133595",
    "unique": "3234ca5d"
}

Exemplo comuns de erros:

Não autorizado:

Código de status: 401

text

ERRO de Validação - Code 400:

Accept-Version v1

Bloco de código

Bloco de código

language

theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "

code

message":

401

"Process not found",
        "

message

code":

"Unauthorized"

400
    }
}

Sem permissão para acessar a rota:

Observação: O processo é inexistente ou pode estar inexistente.

ERRO de Validação - Code 400:

Accept-Version v2:

Código de status: 403

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error":

{

message": "Forbidden", "code": 403 } }

Processo com status inexistente ou expirado:

Process not found"
}

Observação: O processo é inexistente ou pode estar inexistente.

ERRO de Autenticação - Code 401:

Código de status: 400

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "

message

code":

"Process

401,

not found

       "message": "Unauthorized"
    }
}

Observação: Verifique usuário e senha.

ERRO de Permissão - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Forbidden",
        "code":

400

403
    }
}

Observação: Verificar as permissões do usuário para acessar a rota/serviço.

ERRO de Limite diário de requisições excedido - Code 429:

Accept-Version v1

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "The daily limit of 3 has been exceeded for the following features: daily.punches, daily.totals, monthly.",
        "code": 429
    }
}

Accept-Version v2

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": "The daily limit of 3 has been exceeded for the following features: daily.punches, daily.totals, monthly."
}

Card

label	5. FAQ

Em Construção

Como identificar o limite de 1000 registros por pagina, o que é considerado um registro?

Resposta: Cada registro é um Objeto retornado na propriedade "data" no body da requisição. No exemplo abaixo, temos 2 objetos dentro de "data" sendo um referente ao daily (daily.totals e punches) e o segundo referente ao monthly (results), então temos dois (2) registros:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

"company": "a123456",
"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:20",
                        "type": "hours"
                    }
                ],
                "punches": [
                    {
                        "date": "2022-07-28",
                        "hour": "0800",
                        "type": "O",
                        "label": "entrada-1"
                    }
                ]
            }
        ]
    },
    {
        "employee": "98a159Q",
        "paymentDate": "2022-08-08",
        "infotype": "0015",
        "results": [
            {
                "name": "Horas previstas",
                "event": "9077",
                "value": "71:20",
                "type": "hours"
            }
        ]
    }
]
}

Composition Setup
deck.tab.inactive.background = #fffffff deck.tab.active.background = #b3a5ef

English (US)

This documentation describes the features of the Pontoweb system's Results Calculation API. The API allows you to start calculation processes, monitor their status, consult the results calculated and manage the re-consumption of events that have already been processed.

The operations have been developed for integration with payroll systems, accounting systems or other corporate applications that need to access employees' time and attendance data and accounting events.

All requests require authentication via HTTP Basic Auth, using a service type user. Some routes also require specific versioning headers.

Responses are in JSON format, with clear error and success messages to facilitate handling by client applications.

Section

Deck of Cards

id	001

Card

label	Authentication

ITG2.0-01 Authentication

Card

label	1. Request calculated results

Starts the process of calculating accounting events and clockings for employees in a given period. It allows you to filter by location, specific employees and optional features such as daily totals, daily punches and monthly totals.

Informações

title	Limitations of Use

A maximum of 3 daily processes are allowed for the “full base” for each type of ‘feature’ parameter consumed (daily.totals, daily.punches, and monthly). In calls informing the registration filter (not “full base”), consumption is free.
A maximum of 4 simultaneous processes are allowed to start.

Item	Description
Flow:	Client → PontoWeb
URL API:	https://api.ahgora.com.br/reckons/process/start
Method:	POST
Auth:	Basic (show)

Body Request:

Field	Type	Required	Description
registers	array	Situational	List of employee registrations, if empty, considers all employees. When the rescission field is true, this field becomes mandatory and must contain at least one register.
rescission	boolean	Yes	Indicates whether to consider dismissed employees. Default: false.
month	string	Yes	Calculation month, expected format: “MM”.
year	string	Yes	Calculation year, expected format: “YYYY”.
paymentDate	string	No	Date of payment, expected format: “YYYY-MM-DD”.
infotype	string	No	Identification of the event type. Default: 0015.
allowEmpty	boolean	No	Displays employees without data. Default: false.
locations	array	No	Filters employees by location registered with Pontoweb.
features	array	No	Type of processing requested. Options: "daily.punches" "daily.totals" "monthly" Default: monthly. You can request a specific one or more than one. If you don't enter one, the default one will be generated.
includeEmptyCode	boolean	No	Indicates to the flow that events without an accounting code should also be included in the result response. Default: false. Note: When set to true, the returned events may include negative values if the original event value is negative.

Request examples:

Body Request:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "registers": ["98a159Q"],
    "rescission": false,
    "month": "04",
    "year": "2025",
    "paymentDate": "2025-04-30",
    "infotype": "0015",
    "allowEmpty": false,
    "locations": [],
    "features": ["daily.punches", "daily.totals", "monthly"],
    "includeEmptyCode": false
 }

Responses examples:

Response when SUCCESS - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "process": "6b28ff7e-dda5-415c-b5b4-ff776f92142b",
    "company": "a133595",
    "created_at": "2025-04-28T13:49:32.334Z"
}

Authentication ERROR - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Permission ERROR - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Forbidden",
        "code": 403
    }
}

Note: Check the user's permissions to access the route/service.

Validation ERROR - Code 400:

Bloco de código

theme	Emacs
linenumbers	true
collapse	true

{
    "error": "\"rescission\" is required"
}

Note: Check the mandatory parameters of the request.

Card

label	2. Check the process status

Once you have requested processing, you can query the status. This query returns the status of a previously initiated calculation process. It informs you whether processing has been completed, whether there have been any errors and the progress. You must provide the process identifier.

Item	Description
Flow:	Client → PontoWeb
URL API:	https://api.ahgora.com.br/reckons/process/status/:process
Method:	GET
Auth:	Basic (show)
Parameters:	Process This is the identifier code of the initiated process, obtained on the response from the start process request. Example: 6b28ff7e-dda5-415c-b5b4-ff776f92142b

Query Params
Key	Value
Accept-Version	v1 v2

Response body:

Field	Type	Description
process	string	Initiated process code.
company	string	Company code in the PontoWeb system.
status	string	Current process status: "processing" – Processing in progress; "done" – Processing completed successfully; "error" – Processing completed with error.
unique	string	Unique identifier code for process control.
progress.done	number	Number of employees with completed processing.
progress.total	number	Total number of employees to be processed.

Response examples:

Response when in PROCESS - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "status": "processing",
    "unique": "323256d",
    "process": "323256d-d0df-4c0d-a6c1-8d9ca6fed06b",
    "company": "a133595",
     "progress": {
        "done": 0,
        "total": 0
    }
}

Response when SUCCESS - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "status": "done",
    "unique": "3234ca5d",
    "process": "3234ca5d-d0df-4c0d-a6c1-8d9ca6fed06b",
    "company": "a133595",
    "progress": {
        "done": 1,
        "total": 1
    }
}

Validation ERROR - Code 400:

Accept-Version v1

Bloco de código

theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Process not found",
        "code": 400
    }
}

Note: Check the unique code entered.

Validation ERROR - Code 400:

Accept-Version v2:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": "Process not found"
}

Note: Check the unique code entered.

Authentication ERROR - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Note: Check the username and password entered.

Permission ERROR - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Forbidden",
        "code": 403
    }
}

Note: Check the user's permissions to access the route/service.

Card

label	3. Get calculated results

Obtains the generated processing results, based on the unique identifier code. The data returned can include monthly events, daily totals and punches (clockings), as defined in the request asking for the results.
The data is available for 72 hours for consumption; after this period, it automatically expires.

Important: once the process data has been successfully queried, the events returned are marked as “consumed” and will not be displayed again in future calls.
To obtain the same events, you will need to enable the re-consumption of events via route 4. Enable re-consumption of events.

Item	Description
Flow:	Client → PontoWeb
URL API:	https://api.ahgora.com.br/reckons/:unique
Method:	GET
Auth:	Basic (show)
Parameter:	Unique (string): is the unique identifier code for control. Example: 3234ca5d
Parameter:	Limit (number) (optional): is the limit of records that will be returned in the response. Default: 1000. Max: 1000.

Response examples:

Response - monthly

Example of a response when the “features” field is entered with “monthly” in the request for calculated results:

Field	Type	Description
unique	string	Unique process identifier code.
company	string	Company code in the PontoWeb system.
total	number	Total number of employees.
data	array	Contains a list of employee and event information.
data.employee	string	Employee's registration.
data.paymentDate	string	Date of payment, expected format: “YYYY-MM-DD”.
data.infotype	string	Identifying the type of event.
data.results	array	It contains a list of monthly events.
data.results.name	string	Name of the accounting code.
data.results.event	string	Accounting code for the event. Note: When the includeEmptyCode parameter in the body is set to true, this field may be returned with an empty value.
data.results.value	string/number	Value of the accounting event. Example: Events in Days: 2; Events in Hours: "16:00" (For Sexagesimals) Events in Hours: "16,60" (For Centesimals)
data.results.type	string	Type of accounting event. Can be: "days" "hours"

Aviso
By default, Absent Time are sent in hours (value and type).

Response when SUCCESS - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
	"company": "a133595",
    "unique": "3234ca5d",
    "total": 1,
    "data": [
        {
            "employee": "98a159Q",
            "paymentDate": "2025-04-30",
            "infotype": "0015",
            "results": [
                {
                      "name": "Horas previstas",
                      "event": "9077",
                      "value": "71:20",
                      "type": "hours"
                  },
                  {
                      "name": "Dias previstos",
                      "event": "9078",
                      "value": 1,
                      "type": "days"
                  }
            ]
        }
    ]
}

Response - daily.punches

Example of a response when the “features” field is entered with “daily.punches” in the request for calculated results:

Field	Type	Description
unique	string	Unique process identifier code.
company	string	Company code in the PontoWeb system.
total	number	Total number of days counted.
data	array	Contains a list of employee and clock-in information.
data.employee	string	Matrícula do colaborador.
data.paymentDate	string	Date of payment, expected format: “YYYY-MM-DD”.
data.infotype	string	Identifying the type of event.
data.daily	array	Contains the list of clockings.
data.daily.day	string	Day on which the clock-in occurred, expected format: “YYYY-MM-DD”.
data.daily.punches	array	List of appointment information.
data.daily.punches.date	string	Effective date of clock-in.
data.daily.punches.hour	string	Time of clocking in, expected format: "HHMM".
data.daily.punches.type	string	Record type. Can be: "O" - ETR (Electronic Time Recording) or Online Clocking. "I" - Manual Entry. "BI" - Break Records.
data.daily.punches.label	string	Indicates whether the record is incoming or outgoing.

Response when SUCCESS - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
	"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"
                        }
                    ]
                }
            ]
        }
    ]
}

Response - daily.totals

Example response when the “features” field is entered with “daily.totals” in the request for calculated results:

Field	Type	Description
unique	string	Unique process identification code.
company	string	Company code in the PontoWeb system.
total	number	Total number of days counted.
data	array	Contains a list of employee information and daily events
data.employee	string	Employee's registration.
data.paymentDate	string	Date of payment, expected format: “YYYY-MM-DD”.
data.infotype	string	Identification of the event type.
data.daily	array	Contains a list of the punches (clockings).
data.daily.day	string	Day of the punches (clock-in), expected format: "YYYY-MM-DD".
data.daily.results	array	It contains a list of daily events.
data.daily.results.name	string	Name of the accounting code.
data.daily.results.event	string	Accounting code for the event. Note: When the includeEmptyCode parameter in the body is set to true, this field may be returned with an empty value.
data.daily.results.value	string	Value of the accounting event. Example: Events in Days: 2; Events in Hours: "16:00" (For Sexagesimals) Events in Hours: "16,60" (For Centesimals)
data.daily.results.type	string	Type of accounting event. Can be: "days" "hours"

Response when SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "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:20",
                            "type": "hours"
                        },
                        {
                            "name": "Dias previstos",
                            "event": "9078",
                            "value": 1,
                            "type": "days"
                        }
                    ]
                }
            ]
        }
    ]
}

Response - daily.totals, daily.punches e monthly

Example answer when the “features” field contains all the options.

Resposta when SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "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:20",
                            "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:20",
                    "type": "hours"
                },
                {
                    "name": "Dias previstos",
                    "event": "9078",
                    "value": 1,
                    "type": "days"
                }
            ]
        }
    ]
}

Authentication ERROR - Code 401

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Note: Check the username and password entered.

ERRO de Permissão - Code 403

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Forbidden",
        "code": 403
    }
}

Note: Check the user's permissions to access the route/service.

Card

label	4. Enable re-consumption of events

Restores the availability of events previously consumed in a calculation process. After executing this route, the data associated with the identifier entered can be obtained again via the results query route.

Item	Description
Flow:	Client → PontoWeb
URL API:	https://api.ahgora.com.br/reckons/reconsume/:unique
Method:	GET
Auth:	Basic (show)
Parameter:	Unique (string): is the unique identification code for control. Example: 3234ca5d
Max limit:	1000 times (The results calculation identified by unique) Each refill is available for 72 hours for re-consumption. After this time it is no longer accessible.

Response Body:

Field	Type	Description
company	string	Company code in the PontoWeb system.
unique	string	Unique process identification code.

Response examples:

Response when SUCESSO - Code 200:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "company": "a133595",
    "unique": "3234ca5d"
}

Validation ERROR - Code 400:

Accept-Version v1

Bloco de código

theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Process not found",
        "code": 400
    }
}

Note: Check the unique code entered.

Validation ERROR - Code 400:

Accept-Version v2:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": "Process not found"
}

Note: Check the unique code entered.

Authentication ERROR - Code 401:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "code": 401,
        "message": "Unauthorized"
    }
}

Note: Check the username and password entered.

Permission ERROR - Code 403:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "Forbidden",
        "code": 403
    }
}

Note: Check the user's permissions to access the route/service.

Daily requisition limit exceeded ERROR - Code 429:

Accept-Version v1

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": {
        "message": "The daily limit of 3 has been exceeded for the following features: daily.punches, daily.totals, monthly.",
        "code": 429
    }
}

Accept-Version v2

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

{
    "error": "The daily limit of 3 has been exceeded for the following features: daily.punches, daily.totals, monthly."
}

Card

label	5. FAQ

Under construction

How to identify the limit of 1000 records per page, what is considered a record?

Answer: Each record is an Object returned in the "data" property in the body of the request. In the example below, we have 2 objects within "data", one referring to the daily (daily.totals and punches) and the second referring to the monthly (results), so we have two (2) records:

Bloco de código

language	text
theme	Emacs
linenumbers	true
collapse	true

"company": "a123456",
"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:20",
                        "type": "hours"
                    }
                ],
                "punches": [
                    {
                        "date": "2022-07-28",
                        "hour": "0800",
                        "type": "O",
                        "label": "entrada-1"
                    }
                ]
            }
        ]
    },
    {
        "employee": "98a159Q",
        "paymentDate": "2022-08-08",
        "infotype": "0015",
        "results": [
            {
                "name": "Horas previstas",
                "event": "9077",
                "value": "71:20",
                "type": "hours"
            }
        ]
    }
]

}

}

Composition Setup
deck.tab.inactive.background = #fffffff deck.tab.active.background = #b3a5ef

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 12

Nova versão Atual

Chave

Corpo da

Requisição:

Exemplo de corpo da requisição:

Exemplos de Requisições (Requests)

Corpo da Requisição:

Exemplo de resposta quando sucesso:

Exemplos de Respostas (Responses)

Resposta quando SUCESSO - Code 200:

Exemplo comuns de erros:

Não autorizado:

ERRO de Autenticação - Code 401:

Sem permissão para acessar a rota:

ERRO de Permissão - Code 403:

Parâmetros obrigatórios não informados:

ERRO de Validação - Code 400:

Corpo da

Resposta:

Exemplo de resposta quando esta em processamento:

Exemplos de Respostas (Responses)

Resposta quando em PROCESSAMENTO - Code 200:

Bloco de códigolanguagetextthemeEmacslinenumberstruecollapsetrue{ "status": "processing", "unique": "323256d", "process": "323256d-d0df-4c0d-a6c1-8d9ca6fed06b", "company": "a133595", "progress": { "done": 0, "total": 0 } }

Exemplo de resposta quando sucesso:

Resposta quando SUCESSO - Code 200:

Exemplo comuns de erros:

Não autorizado:

ERRO de Validação - Code 400:

Accept-Version v1

Sem permissão para acessar a rota:

ERRO de Validação - Code 400:

Accept-Version v2:

Bloco de códigolanguagetextthemeEmacslinenumberstruecollapsetrue{ "error": "Process not { found" }Observação: Verifique o unique informado.

ERRO de Autenticação - Code 401:

Processo com status inexistente ou expirado:

ERRO de Permissão - Code 403

:

Exemplos de Respostas (Responses)

Resposta - monthly

Exemplo de resposta com sucesso:

Resposta com SUCESSO - Code 200:

Resposta - daily.punches

Exemplo de resposta com sucesso:

Resposta com SUCESSO - Code 200:

Resposta - daily.totals

Exemplo de resposta com sucesso:

Resposta com SUCESSO - Code 200:

Resposta - daily.totals, daily.punches e monthly

Resposta com SUCESSO - Code 200:

Exemplo comuns de erros:

Não autorizado:

ERRO de Autenticação - Code 401

Sem permissão para acessar a rota:

ERRO de Permissão - Code 403

Corpo da

Resposta:

Exemplo de resposta quando sucesso:

Exemplos de Respostas (Responses)

Resposta quando SUCESSO - Code 200:

Bloco de códigolanguagetextthemeEmacslinenumberstruecollapsetrue{ "company": "a133595", "unique": "3234ca5d" }

Exemplo comuns de erros:

Não autorizado:

ERRO de Validação - Code 400:

Accept-Version v1

Sem permissão para acessar a rota:

ERRO de Validação - Code 400:

Accept-Version v2:

Bloco de códigolanguagetextthemeEmacslinenumberstruecollapsetrue{ "error": { "message": "Forbidden", "code": 403 } }

Processo com status inexistente ou expirado:

ERRO de Autenticação - Code 401:

Bloco de códigolanguagetextthemeEmacslinenumberstruecollapsetrue{ "error": { "messagecode": "Process401, not found "message": "Unauthorized" } }Observação: Verifique usuário e senha.

ERRO de Permissão - Code 403:

ERRO de Limite diário de requisições excedido - Code 429:

Accept-Version v1

Accept-Version v2

Em Construção

Bloco de código
language text
theme Emacs
linenumbers true
collapse true
{ "status": "processing", "unique": "323256d", "process": "323256d-d0df-4c0d-a6c1-8d9ca6fed06b", "company": "a133595", "progress": { "done": 0, "total": 0 } }

Bloco de código
language text
theme Emacs
linenumbers true
collapse true
{ "error": "Process not
{
found" }
Observação: Verifique o unique informado.

Bloco de código
language text
theme Emacs
linenumbers true
collapse true
{ "company": "a133595", "unique": "3234ca5d" }

Bloco de código
language text
theme Emacs
linenumbers true
collapse true
{ "error":
{

"
message": "Forbidden", "code": 403 } }

Bloco de código
language text
theme Emacs
linenumbers true
collapse true
{ "error": { "
message
code":
"Process
401,
not found
"message": "Unauthorized" } }
Observação: Verifique usuário e senha.