Objetivo
Este artigo mostra como utilizar os endpoints de Histórico de Regra para listar, incluir ou remover o histórico de regras de ponto aplicadas a um colaborador.
1. Listar Histórico
Endpoint:
GET https://api1.tradingworks.net/v1/rulehistory/{Matrícula}/{Código do Empregador}Parâmetros:
Matrícula (obrigatório) – identificador do colaborador.
Código do Empregador (opcional) – necessário apenas se existirem matrículas repetidas.
FromDate / ToDate (opcionais) – permitem filtrar por período.
Headers:
AUTH-TOKEN: sua_chave_privada
Exemplo de resposta:
[
{
"RuleCode":"451",
"Title":"08:00 – 17:00",
"BaseDate":"2022-10-04T00:00:00"
},
{
"RuleCode":"455",
"Title":"07:00 – 16:00",
"BaseDate":"2022-10-03T00:00:00"
}
]
2. Incluir Histórico
Endpoint:
POST https://api1.tradingworks.net/v1/rulehistory
Headers:
AUTH-TOKEN: sua_chave_privada Content-Type: application/json
Dados:
Campo | Tipo | Requerido | Exemplo | Observações |
EmployeeNumber | string | Sim | "5555" | Matrícula do colaborador |
EmployerImportRef | string | Opcional | "8888" | Código de importação do empregador. Opcional caso a matrícula seja única para o ambiente todo. Se não informado e existirem matrículas duplicadas, o primeiro colaborador com a matrícula encontrada será utilizado. |
RuleCode | string | Sim | "ATENDENTE 8-17" | Código de importação da regra de ponto. |
BaseDate | DATE | Sim | "2022-03-05" | Data que a regra de ponto passará a valer. |
AuditEmployeeID | integer | Opcional | 5435 | O ID é o código interno da TradingWorks para designar quem é o responsável alteração. Isso afetará os arquivos de auditoria. |
AuditEmployeeNumber | string | Sim | "1234" | Número da matrícula do colaborador em substituição do campo AuditEmployeeID. |
AuditEmployerImportRef | string | Sim | "8888" | Código de importação do empregador. Opcional caso a matrícula seja única para o ambiente todo. Se não informado e existirem matrículas duplicadas, o primeiro colaborador com a matrícula encontrada será utilizado. |
JSON de envio:
{
"EmployeeNumber":"5555",
"EmployerImportRef":"8888",
"RuleCode":"ATENDENTE 8-17",
"BaseDate":"2022-03-05",
"AuditEmployeeID":5435
}Comportamento:
Se já existir uma regra para a mesma data, ela será substituída.
Caso contrário, será adicionada normalmente.
3. (Opcional) Excluir Histórico
Endpoint:
DELETE https://api1.tradingworks.net/v1/rulehistory/{Matrícula}/{BaseDate}Uso: remove a regra vinculada a um colaborador a partir da data informada.
Dicas e Observações
Sem Token ou com parâmetros inválidos → erro de autorização.
Matrículas duplicadas → é necessário informar EmployerImportRef.
Alterações retroativas → pode ser necessário reprocessar a folha para refletir as mudanças.
Perguntas Frequentes
1- E se enviar o mesmo RuleCode para a mesma data?
R: A regra será atualizada, não duplicada.
2- Preciso reprocessar a folha de ponto?
R: Sim, especialmente se a BaseDate for no passado.
3- O que acontece com registros futuros?
R: São considerados conforme a sequência histórica da API.