TRANXACT.AI Help

HRMS · Employee Relations & Records

Employee Documents

What each employee has handed in or signed, by document type: asked for on hire, uploaded in self service, or signed. Raised by the process that asks for them; HR verifies them on the onboarding checklist.

Type REST6 operationsBase path /api/hrms/employee-documentsPublished as /api/v1/employee-documents

Download specification (OpenAPI 3.1) Screen: Employee Documents

Overview

PackageHRMS
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 HRMS › Employee Documents 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.employee_documents · kept per company (and organisational unit where it has one)
RecordRead only; 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/hrms/employee-documentsList employee documents

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",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "document_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "content_document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "reference_no": "REF-000001",
      "issued_on": "2026-10-30",
      "expires_on": "2026-10-30",
      "status": "draft",
      "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "verified_at": "2026-10-30T09:00:00Z",
      "signed_at": "2026-10-30T09:00:00Z",
      "signed_by_name": "Example",
      "signature_method": "text"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/employee-documents?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/employee-documents/{id}Read one employee document

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "person_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "document_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "content_document_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reference_no": "REF-000001",
  "issued_on": "2026-10-30",
  "expires_on": "2026-10-30",
  "status": "draft",
  "verified_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "verified_at": "2026-10-30T09:00:00Z",
  "signed_at": "2026-10-30T09:00:00Z",
  "signed_by_name": "Example",
  "signature_method": "text"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/employee-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/employee-documentsPost employee documents

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/hrms/employee-documents" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/employee-documents/{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/hrms/employee-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/hrms/employee-documents/{id}Put employee documents

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 PUT "https://demo.tranxact.ai/api/hrms/employee-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/employee-documents/{id}Delete employee documents

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 DELETE "https://demo.tranxact.ai/api/hrms/employee-documents/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a employee document, 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
employee_iduuidread onlyEmployee id
person_iduuidread onlyPerson id
document_type_iduuidread onlyDocument type id
content_document_iduuidread onlyContent document id
reference_notextread onlyReference no
issued_ondateread onlyIssued on
expires_ondateread onlyExpires on
statustextread onlyStatus
verified_byuuidread onlyVerified by
verified_attimestamp with time zoneread onlyVerified at
signed_attimestamp with time zoneread onlySigned at
signed_by_nametextread onlySigned by name
signature_methodtextread onlySignature method
notestextread onlyNotes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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 HRMS › Employee Documents 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.