Skip to main content
Historical corrections are required when modifying a resource in a closed pay period, or which may impact a closed pay period. This safety mechanism ensures that changes to historical data are intentional and properly documented for payroll and audit purposes.

​
When Historical Corrections Are Required

Some examples of when a historical correction is required include:
  • Creating, updating, or deleting timecard punches in signed-off pay periods
  • Modifying shifts in signed-off pay periods
  • Updating pay codes or other pay-related system configuration in the past

​
Historical Correction Structure

To make a historical correction, include the historicalCorrection object in your request body:
Historical Correction Structure
{
    // Your normal request data
    "startTime": "2024-01-15T08:00:00Z",
    "endTime": "2024-01-15T17:00:00Z",

    // Historical correction acknowledgment
    "historicalCorrection": {
        "note": "Correcting missed punch from employee timesheet review"
    }
}

​
Fields

​
historicalCorrection
object
required
Required when modifying historical data that may affect pay.

​
Error Handling

​
Missing Historical Correction

If you attempt to modify historical data without the required acknowledgment:
Missing Historical Correction Error
{
    "type": "https://developers.untetherlabs.com/errors#missing-historical-correction-acknowledgement",
    "status": 400,
    "title": "A historical correction acknowledgement is required to create a historical correction.",
    "detail": "This action would create one or more historical corrections, but no historical correction acknowledgement was provided."
}
You may handle this before sending the request, or as a retry after receiving the error. For additional help with historical corrections, contact our support team.