TRANXACT.AI Help

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.

Type REST8 operationsBase path /api/platform/retention-policiesPublished as /api/v1/retention-policies

Download specification (OpenAPI 3.1) Screen: Retention Policies

Overview

PackagePlatform
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 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.
Tableplatform.retention_policies · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
codetextYesPolicy code — e.g. RET-AUDIT
nametextYesName
targettextYesData — Only data that is finished can be chosen: a paid invoice, a closed ticket, a log. The ledger is not offered.
actiontextYesArchive or purge — archive = moved out of the live tables and kept, readable and restorable. purge = deleted.
Allowed: archive purge
older_than_yearsintegerYesOlder than (years) — Data is considered once it is at least this many years old.
untouched_yearsintegerYesNot 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.
frequencytextYesRuns
Allowed: daily weekly monthly quarterly yearly
first_run_attimestamp with time zoneNoFirst run — Empty = the next check after it is switched on (every 15 minutes).
max_rows_per_runintegerNoAt most (rows per run) — What one run handles; the rest wait for the next. 50,000 unless you say otherwise.
is_activebooleanNoSwitched on — Off until you switch it on. Preview first.
notestextNoNotes
purge_archived_after_yearsintegerNoThen 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

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesPolicy code — e.g. RET-AUDIT
nametextYesName
targettextYesData — Only data that is finished can be chosen: a paid invoice, a closed ticket, a log. The ledger is not offered.
actiontextYesArchive or purge — archive = moved out of the live tables and kept, readable and restorable. purge = deleted.
Allowed: archive purge
older_than_yearsintegerYesOlder than (years) — Data is considered once it is at least this many years old.
untouched_yearsintegerYesNot 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.
frequencytextYesRuns
Allowed: daily weekly monthly quarterly yearly
first_run_attimestamp with time zoneNoFirst run — Empty = the next check after it is switched on (every 15 minutes).
max_rows_per_runintegerNoAt most (rows per run) — What one run handles; the rest wait for the next. 50,000 unless you say otherwise.
is_activebooleanNoSwitched on — Off until you switch it on. Preview first.
notestextNoNotes
purge_archived_after_yearsintegerNoThen 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

NameTypeDescription
idstring (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

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 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

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 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

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writePolicy code — e.g. RET-AUDIT
nametextread, writeName
targettextread, writeData — Only data that is finished can be chosen: a paid invoice, a closed ticket, a log. The ledger is not offered.
actiontextread, writeArchive or purge — archive = moved out of the live tables and kept, readable and restorable. purge = deleted.
Allowed: archive purge
older_than_yearsintegerread, writeOlder than (years) — Data is considered once it is at least this many years old.
untouched_yearsintegerread, writeNot 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.
frequencytextread, writeRuns
Allowed: daily weekly monthly quarterly yearly
first_run_attimestamp with time zoneread, writeFirst run — Empty = the next check after it is switched on (every 15 minutes).
max_rows_per_runintegerread, writeAt most (rows per run) — What one run handles; the rest wait for the next. 50,000 unless you say otherwise.
is_activebooleanread, writeSwitched on — Off until you switch it on. Preview first.
notestextread, writeNotes
next_run_attimestamp with time zoneread onlyNext run at
claimed_attimestamp with time zoneread onlyClaimed at
last_run_attimestamp with time zoneread onlyLast run at
last_run_statustextread onlyLast run status
last_run_iduuidread onlyLast run id
created_byuuidread onlyCreated by
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
purge_archived_after_yearsintegerread, writeThen 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_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

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 Platform › Retention Policies 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.