Platform · Records & Legal Hold
HR Document Types
The kinds of employee document the company keeps — I-9s, contracts, reviews, medical certificates — each with how long it is kept after the person leaves. A legal hold can hold documents by type, and retention keeps each type for its own period. A type in use is not deleted: set it inactive.
/api/platform/document-typesPublished as /api/v1/document-typesDownload specification (OpenAPI 3.1) Screen: HR Document Types
Overview
| Package | Platform |
|---|---|
| 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 Platform › HR Document Types 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.document_types · 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/platform/document-typesList hr document types
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",
"code": "COD-000001",
"name": "Example",
"category": "personnel",
"is_mandatory": true,
"requires_signature": true,
"expires": true,
"valid_months": 10,
"retention_years": 10,
"applies_to": "all",
"country": "US",
"description": "text",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/document-types?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/document-types/{id}Read one hr document type
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",
"code": "COD-000001",
"name": "Example",
"category": "personnel",
"is_mandatory": true,
"requires_signature": true,
"expires": true,
"valid_months": 10,
"retention_years": 10,
"applies_to": "all",
"country": "US",
"description": "text",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/document-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/document-typesCreate a hr document type
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code — For example I9, OFFER-LETTER, PERF-REVIEW. |
name | text | Yes | Name |
category | text | No | Category Allowed: personnel identity right_to_work tax payroll benefits contract policy performance disciplinary medical training |
is_mandatory | boolean | No | Every employee must have one |
requires_signature | boolean | No | Signed by the employee |
expires | boolean | No | Expires |
valid_months | integer | No | Valid for (months) |
retention_years | integer | No | Keep for (years) — How long a document of this type is kept once the person has left (Form I-9: 3 years after hire or 1 after leaving, whichever is later). |
applies_to | text | No | Applies to Allowed: all employees contingent managers new_hires leavers |
country | text | No | Country — Empty for every country. |
description | text | No | Description |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"category": "personnel",
"is_mandatory": true,
"requires_signature": true,
"expires": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"category": "personnel",
"is_mandatory": true,
"requires_signature": true,
"expires": true,
"valid_months": 10,
"retention_years": 10,
"applies_to": "all",
"country": "US",
"description": "text",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/document-types" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","category":"personnel","is_mandatory":true,"requires_signature":true,"expires":true}'PUT/api/platform/document-types/{id}Change a hr document type
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 |
|---|---|---|---|
code | text | Yes | Code — For example I9, OFFER-LETTER, PERF-REVIEW. |
name | text | Yes | Name |
category | text | No | Category Allowed: personnel identity right_to_work tax payroll benefits contract policy performance disciplinary medical training |
is_mandatory | boolean | No | Every employee must have one |
requires_signature | boolean | No | Signed by the employee |
expires | boolean | No | Expires |
valid_months | integer | No | Valid for (months) |
retention_years | integer | No | Keep for (years) — How long a document of this type is kept once the person has left (Form I-9: 3 years after hire or 1 after leaving, whichever is later). |
applies_to | text | No | Applies to Allowed: all employees contingent managers new_hires leavers |
country | text | No | Country — Empty for every country. |
description | text | No | Description |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"category": "personnel",
"is_mandatory": true,
"requires_signature": true,
"expires": true,
"valid_months": 10,
"retention_years": 10,
"applies_to": "all",
"country": "US",
"description": "text",
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/document-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/platform/document-types/{id}Delete a hr document type
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/platform/document-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/document-types/{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/platform/document-types/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 hr document type, 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 |
code | text | read, write | Code — For example I9, OFFER-LETTER, PERF-REVIEW. |
name | text | read, write | Name |
category | text | read, write | Category Allowed: personnel identity right_to_work tax payroll benefits contract policy performance disciplinary medical training |
is_mandatory | boolean | read, write | Every employee must have one |
requires_signature | boolean | read, write | Signed by the employee |
expires | boolean | read, write | Expires |
valid_months | integer | read, write | Valid for (months) |
retention_years | integer | read, write | Keep for (years) — How long a document of this type is kept once the person has left (Form I-9: 3 years after hire or 1 after leaving, whichever is later). |
applies_to | text | read, write | Applies to Allowed: all employees contingent managers new_hires leavers |
country | text | read, write | Country — Empty for every country. |
description | text | read, write | Description |
is_active | boolean | read, write | Active |
org_unit_id | uuid | read only | Org unit id |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 |
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 Platform › HR Document Types 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.