HRMS · Health & Safety
Safety Incidents
Injuries, near misses and dangerous occurrences — with the lost-time and reportability fields the regulator actually measures.
/api/hrms/safety-incidentsPublished as /api/v1/safety-incidentsDownload specification (OpenAPI 3.1) Screen: Safety Incidents
Overview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Safety Incidents 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. |
| Table | hr.safety_incidents · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/safety-incidentsList safety incidents
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"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",
"incident_no": "INC-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"person_description": "text",
"occurred_at": "2026-10-30T09:00:00Z",
"reported_at": "2026-10-30T09:00:00Z",
"reported_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_description": "text",
"incident_type": "injury",
"severity": "near_miss",
"description": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/safety-incidents?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/safety-incidents/{id}Read one safety incidents
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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",
"incident_no": "INC-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"person_description": "text",
"occurred_at": "2026-10-30T09:00:00Z",
"reported_at": "2026-10-30T09:00:00Z",
"reported_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_description": "text",
"incident_type": "injury",
"severity": "near_miss",
"description": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/safety-incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/safety-incidentsCreate a safety incidents
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
org_unit_id | uuid | No | Business unit |
employee_id | uuid | No | Person hurt — Leave empty for a contractor or visitor, and describe them below. |
person_description | text | No | Person (if not an employee) |
occurred_at | timestamp with time zone | Yes | When it happened |
reported_by | uuid | No | Reported by |
location_id | uuid | No | Location id |
warehouse_id | uuid | No | Site |
location_description | text | No | Where exactly |
incident_type | text | Yes | Type Allowed: injury illness near_miss property_damage environmental fire security vehicle hazard dangerous_occurrence |
severity | text | No | Severity Allowed: near_miss minor moderate serious major fatal |
description | text | Yes | What happened |
immediate_action | text | No | Immediate action taken |
is_lost_time | boolean | No | Lost time |
days_lost | integer | No | Days lost |
days_restricted | integer | No | Days on restricted duties |
required_medical_treatment | boolean | No | Medical treatment required |
body_part | text | No | Body part |
injury_nature | text | No | Nature of injury |
is_reportable | boolean | No | Reportable to the authority |
reporting_scheme | text | No | Scheme — RIDDOR, OSHA 300, or the local equivalent. |
reported_to_authority_on | date | No | Reported on |
authority_reference | text | No | Authority reference |
investigation_status | text | No | Investigation Allowed: open investigating root_cause_found actions_assigned closed |
root_cause | text | No | Root cause |
contributing_factors | text | No | Contributing factors |
corrective_actions | text | No | Corrective actions |
closed_on | date | No | Closed on |
closed_by | uuid | No | Closed by |
Sample body
{
"occurred_at": "2026-10-30T09:00:00Z",
"incident_type": "injury",
"description": "text",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"person_description": "text",
"reported_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"incident_no": "INC-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"person_description": "text",
"occurred_at": "2026-10-30T09:00:00Z",
"reported_at": "2026-10-30T09:00:00Z",
"reported_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_description": "text",
"incident_type": "injury",
"severity": "near_miss",
"description": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/safety-incidents" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"occurred_at":"2026-10-30T09:00:00Z","incident_type":"injury","description":"text","org_unit_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","person_description":"text","reported_by":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'PUT/api/hrms/safety-incidents/{id}Change a safety incidents
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
org_unit_id | uuid | No | Business unit |
employee_id | uuid | No | Person hurt — Leave empty for a contractor or visitor, and describe them below. |
person_description | text | No | Person (if not an employee) |
occurred_at | timestamp with time zone | Yes | When it happened |
reported_by | uuid | No | Reported by |
location_id | uuid | No | Location id |
warehouse_id | uuid | No | Site |
location_description | text | No | Where exactly |
incident_type | text | Yes | Type Allowed: injury illness near_miss property_damage environmental fire security vehicle hazard dangerous_occurrence |
severity | text | No | Severity Allowed: near_miss minor moderate serious major fatal |
description | text | Yes | What happened |
immediate_action | text | No | Immediate action taken |
is_lost_time | boolean | No | Lost time |
days_lost | integer | No | Days lost |
days_restricted | integer | No | Days on restricted duties |
required_medical_treatment | boolean | No | Medical treatment required |
body_part | text | No | Body part |
injury_nature | text | No | Nature of injury |
is_reportable | boolean | No | Reportable to the authority |
reporting_scheme | text | No | Scheme — RIDDOR, OSHA 300, or the local equivalent. |
reported_to_authority_on | date | No | Reported on |
authority_reference | text | No | Authority reference |
investigation_status | text | No | Investigation Allowed: open investigating root_cause_found actions_assigned closed |
root_cause | text | No | Root cause |
contributing_factors | text | No | Contributing factors |
corrective_actions | text | No | Corrective actions |
closed_on | date | No | Closed on |
closed_by | uuid | No | Closed by |
Sample body
{
"occurred_at": "2026-10-30T09:00:00Z",
"incident_type": "injury"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"incident_no": "INC-000001",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"person_description": "text",
"occurred_at": "2026-10-30T09:00:00Z",
"reported_at": "2026-10-30T09:00:00Z",
"reported_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"warehouse_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"location_description": "text",
"incident_type": "injury",
"severity": "near_miss",
"description": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/safety-incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"occurred_at":"2026-10-30T09:00:00Z","incident_type":"injury"}'DELETE/api/hrms/safety-incidents/{id}Delete a safety incidents
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/hrms/safety-incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/safety-incidents/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/safety-incidents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a safety incidents, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read, write | Business unit |
incident_no | text | read only | Incident no |
employee_id | uuid | read, write | Person hurt — Leave empty for a contractor or visitor, and describe them below. |
person_description | text | read, write | Person (if not an employee) |
occurred_at | timestamp with time zone | read, write | When it happened |
reported_at | timestamp with time zone | read only | Reported at |
reported_by | uuid | read, write | Reported by |
location_id | uuid | read, write | Location id |
warehouse_id | uuid | read, write | Site |
location_description | text | read, write | Where exactly |
incident_type | text | read, write | Type Allowed: injury illness near_miss property_damage environmental fire security vehicle hazard dangerous_occurrence |
severity | text | read, write | Severity Allowed: near_miss minor moderate serious major fatal |
description | text | read, write | What happened |
immediate_action | text | read, write | Immediate action taken |
is_lost_time | boolean | read, write | Lost time |
days_lost | integer | read, write | Days lost |
days_restricted | integer | read, write | Days on restricted duties |
required_medical_treatment | boolean | read, write | Medical treatment required |
body_part | text | read, write | Body part |
injury_nature | text | read, write | Nature of injury |
is_reportable | boolean | read, write | Reportable to the authority |
reporting_scheme | text | read, write | Scheme — RIDDOR, OSHA 300, or the local equivalent. |
reported_to_authority_on | date | read, write | Reported on |
authority_reference | text | read, write | Authority reference |
investigation_status | text | read, write | Investigation Allowed: open investigating root_cause_found actions_assigned closed |
root_cause | text | read, write | Root cause |
contributing_factors | text | read, write | Contributing factors |
corrective_actions | text | read, write | Corrective actions |
closed_on | date | read, write | Closed on |
closed_by | uuid | read, write | Closed by |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Safety Incidents for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.