TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/platform/document-typesPublished as /api/v1/document-types

Download specification (OpenAPI 3.1) Screen: HR Document Types

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 › 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.
Tablehr.document_types · 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

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

GET/api/platform/document-typesList hr document types

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

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

FieldTypeRequiredDescription
codetextYesCode — For example I9, OFFER-LETTER, PERF-REVIEW.
nametextYesName
categorytextNoCategory
Allowed: personnel identity right_to_work tax payroll benefits contract policy performance disciplinary medical training
is_mandatorybooleanNoEvery employee must have one
requires_signaturebooleanNoSigned by the employee
expiresbooleanNoExpires
valid_monthsintegerNoValid for (months)
retention_yearsintegerNoKeep 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_totextNoApplies to
Allowed: all employees contingent managers new_hires leavers
countrytextNoCountry — Empty for every country.
descriptiontextNoDescription
is_activebooleanNoActive

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

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
codetextYesCode — For example I9, OFFER-LETTER, PERF-REVIEW.
nametextYesName
categorytextNoCategory
Allowed: personnel identity right_to_work tax payroll benefits contract policy performance disciplinary medical training
is_mandatorybooleanNoEvery employee must have one
requires_signaturebooleanNoSigned by the employee
expiresbooleanNoExpires
valid_monthsintegerNoValid for (months)
retention_yearsintegerNoKeep 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_totextNoApplies to
Allowed: all employees contingent managers new_hires leavers
countrytextNoCountry — Empty for every country.
descriptiontextNoDescription
is_activebooleanNoActive

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

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/document-types/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/platform/document-types/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode — For example I9, OFFER-LETTER, PERF-REVIEW.
nametextread, writeName
categorytextread, writeCategory
Allowed: personnel identity right_to_work tax payroll benefits contract policy performance disciplinary medical training
is_mandatorybooleanread, writeEvery employee must have one
requires_signaturebooleanread, writeSigned by the employee
expiresbooleanread, writeExpires
valid_monthsintegerread, writeValid for (months)
retention_yearsintegerread, writeKeep 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_totextread, writeApplies to
Allowed: all employees contingent managers new_hires leavers
countrytextread, writeCountry — Empty for every country.
descriptiontextread, writeDescription
is_activebooleanread, writeActive
org_unit_iduuidread onlyOrg unit id
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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 › HR Document Types 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.