Platform · Data Retention
Retention Policies
Archive or purge one kind of data once it is older than the years you set AND has not been added to or changed for the years you set — then again on the period you choose. There are no defaults and none is shipped. A policy starts switched off: preview it, then switch it on. Records something else still refers to are kept and counted. Purging needs the delete permission on this screen.
/api/platform/retention-policiesPublished as /api/v1/retention-policiesDownload specification (OpenAPI 3.1) Screen: Retention Policies
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 › Retention Policies 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 | platform.retention_policies · 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
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/retention-policiesList retention policies
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",
"code": "COD-000001",
"name": "Example",
"target": "text",
"action": "archive",
"older_than_years": 10,
"untouched_years": 10,
"frequency": "daily",
"first_run_at": "2026-10-30T09:00:00Z",
"max_rows_per_run": 10,
"is_active": true,
"notes": "text",
"next_run_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/retention-policies?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/retention-policies/{id}Read one retention policies
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",
"code": "COD-000001",
"name": "Example",
"target": "text",
"action": "archive",
"older_than_years": 10,
"untouched_years": 10,
"frequency": "daily",
"first_run_at": "2026-10-30T09:00:00Z",
"max_rows_per_run": 10,
"is_active": true,
"notes": "text",
"next_run_at": "2026-10-30T09:00:00Z"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/retention-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/retention-policiesCreate a retention policies
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Policy code — e.g. RET-AUDIT |
name | text | Yes | Name |
target | text | Yes | Data — Only data that is finished can be chosen: a paid invoice, a closed ticket, a log. The ledger is not offered. |
action | text | Yes | Archive or purge — archive = moved out of the live tables and kept, readable and restorable. purge = deleted. Allowed: archive purge |
older_than_years | integer | Yes | Older than (years) — Data is considered once it is at least this many years old. |
untouched_years | integer | Yes | Not added or changed for (years) — And only if nothing has added to or changed it in this many years — its own dates and the audit trail are both read. |
frequency | text | Yes | Runs Allowed: daily weekly monthly quarterly yearly |
first_run_at | timestamp with time zone | No | First run — Empty = the next check after it is switched on (every 15 minutes). |
max_rows_per_run | integer | No | At most (rows per run) — What one run handles; the rest wait for the next. 50,000 unless you say otherwise. |
is_active | boolean | No | Switched on — Off until you switch it on. Preview first. |
notes | text | No | Notes |
purge_archived_after_years | integer | No | Then purge the archive after (years) — Archive, then purge: an archived record is deleted from the archive this many years after it was archived. Empty = kept in the archive. Records under legal hold are kept. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"target": "text",
"action": "archive",
"older_than_years": 10,
"untouched_years": 10,
"frequency": "daily",
"first_run_at": "2026-10-30T09:00:00Z"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"target": "text",
"action": "archive",
"older_than_years": 10,
"untouched_years": 10,
"frequency": "daily",
"first_run_at": "2026-10-30T09:00:00Z",
"max_rows_per_run": 10,
"is_active": true,
"notes": "text",
"next_run_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/retention-policies" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","target":"text","action":"archive","older_than_years":10,"untouched_years":10,"frequency":"daily","first_run_at":"2026-10-30T09:00:00Z"}'PUT/api/platform/retention-policies/{id}Change a retention policies
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 | Policy code — e.g. RET-AUDIT |
name | text | Yes | Name |
target | text | Yes | Data — Only data that is finished can be chosen: a paid invoice, a closed ticket, a log. The ledger is not offered. |
action | text | Yes | Archive or purge — archive = moved out of the live tables and kept, readable and restorable. purge = deleted. Allowed: archive purge |
older_than_years | integer | Yes | Older than (years) — Data is considered once it is at least this many years old. |
untouched_years | integer | Yes | Not added or changed for (years) — And only if nothing has added to or changed it in this many years — its own dates and the audit trail are both read. |
frequency | text | Yes | Runs Allowed: daily weekly monthly quarterly yearly |
first_run_at | timestamp with time zone | No | First run — Empty = the next check after it is switched on (every 15 minutes). |
max_rows_per_run | integer | No | At most (rows per run) — What one run handles; the rest wait for the next. 50,000 unless you say otherwise. |
is_active | boolean | No | Switched on — Off until you switch it on. Preview first. |
notes | text | No | Notes |
purge_archived_after_years | integer | No | Then purge the archive after (years) — Archive, then purge: an archived record is deleted from the archive this many years after it was archived. Empty = kept in the archive. Records under legal hold are kept. |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"target": "text",
"action": "archive",
"older_than_years": 10,
"untouched_years": 10,
"frequency": "daily",
"first_run_at": "2026-10-30T09:00:00Z",
"max_rows_per_run": 10,
"is_active": true,
"notes": "text",
"next_run_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/retention-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/platform/retention-policies/{id}Delete a retention policies
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/retention-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/retention-policies/{id}/previewPreview
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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 POST "https://demo.tranxact.ai/api/platform/retention-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/retention-policies/{id}/runRun
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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 POST "https://demo.tranxact.ai/api/platform/retention-policies/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/run" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/retention-policies/{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/retention-policies/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 retention policies, 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 only | Org unit id |
code | text | read, write | Policy code — e.g. RET-AUDIT |
name | text | read, write | Name |
target | text | read, write | Data — Only data that is finished can be chosen: a paid invoice, a closed ticket, a log. The ledger is not offered. |
action | text | read, write | Archive or purge — archive = moved out of the live tables and kept, readable and restorable. purge = deleted. Allowed: archive purge |
older_than_years | integer | read, write | Older than (years) — Data is considered once it is at least this many years old. |
untouched_years | integer | read, write | Not added or changed for (years) — And only if nothing has added to or changed it in this many years — its own dates and the audit trail are both read. |
frequency | text | read, write | Runs Allowed: daily weekly monthly quarterly yearly |
first_run_at | timestamp with time zone | read, write | First run — Empty = the next check after it is switched on (every 15 minutes). |
max_rows_per_run | integer | read, write | At most (rows per run) — What one run handles; the rest wait for the next. 50,000 unless you say otherwise. |
is_active | boolean | read, write | Switched on — Off until you switch it on. Preview first. |
notes | text | read, write | Notes |
next_run_at | timestamp with time zone | read only | Next run at |
claimed_at | timestamp with time zone | read only | Claimed at |
last_run_at | timestamp with time zone | read only | Last run at |
last_run_status | text | read only | Last run status |
last_run_id | uuid | read only | Last run id |
created_by | uuid | read only | Created by |
created_at | timestamp with time zone | read only | Created at |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
purge_archived_after_years | integer | read, write | Then purge the archive after (years) — Archive, then purge: an archived record is deleted from the archive this many years after it was archived. Empty = kept in the archive. Records under legal hold are kept. |
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 › Retention Policies 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.