TRANXACT.AI Help

HRMS · Time & Attendance

Punch Corrections

A missed or wrong punch put right, with the reason, decided by somebody other than whoever asked and never by the employee themselves. Those an employee asks for wait in their manager’s Team Approvals too.

Type REST7 operationsBase path /api/hrms/punch-correctionsPublished as /api/v1/punch-corrections

Download specification (OpenAPI 3.1) Screen: Punch Corrections

Overview

PackageHRMS
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold HRMS › Punch Corrections on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tablehr.punch_correction_board · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

7 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/punch-correctionsList punch corrections

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "correction_no": "COR-000001",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "employee_no": "EMP-000001",
      "employee_name": "Example",
      "manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "action": "text",
      "punch_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "punch_type": "text",
      "status_code": "STA-000001",
      "corrected_at": "2026-10-30T09:00:00Z",
      "original_at": "2026-10-30T09:00:00Z",
      "reason": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/punch-corrections?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/punch-corrections/{id}Read one punch corrections

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "correction_no": "COR-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_no": "EMP-000001",
  "employee_name": "Example",
  "manager_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "action": "text",
  "punch_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "punch_type": "text",
  "status_code": "STA-000001",
  "corrected_at": "2026-10-30T09:00:00Z",
  "original_at": "2026-10-30T09:00:00Z",
  "reason": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/punch-corrections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/punch-correctionsPost punch corrections

Request body

The keys this action reads (* = required; "one of" lists the only values):

employeeId, employee_id

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/punch-corrections" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","employee_id":"value"}'
POST/api/hrms/punch-corrections/{id}/decideDecide

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

decision, comment, note, reason

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/punch-corrections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decide" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"decision":"value","comment":"value","note":"value","reason":"value"}'
POST/api/hrms/punch-corrections/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/punch-corrections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/hrms/punch-corrections/{id}Put punch corrections

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/punch-corrections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/punch-corrections/{id}Delete punch corrections

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

No body is required.

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/hrms/punch-corrections/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a punch corrections, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
correction_notextread onlyCorrection no
employee_iduuidread onlyEmployee id
employee_notextread onlyEmployee no
employee_nametextread onlyEmployee name
manager_iduuidread onlyManager id
actiontextread onlyAction
punch_iduuidread onlyPunch id
punch_typetextread onlyPunch type
status_codetextread onlyStatus code
corrected_attimestamp with time zoneread onlyCorrected at
original_attimestamp with time zoneread onlyOriginal at
reasontextread onlyReason
statustextread onlyStatus
requested_byuuidread onlyRequested by
requested_by_nametextread onlyRequested by name
requested_attimestamp with time zoneread onlyRequested at
decided_byuuidread onlyDecided by
decided_by_nametextread onlyDecided by name
decided_attimestamp with time zoneread onlyDecided at
decision_notetextread onlyDecision note
applied_punch_iduuidread onlyApplied punch id
created_attimestamp with time zoneread onlyCreated at

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold HRMS › Punch Corrections for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.