TRANXACT.AI Help

Employee Self Service · HR Self Service

Change Requests

Changes of address and bank account employees have asked for. Nothing is applied until it is approved here; account numbers show their last four only.

Type REST7 operationsBase path /api/ess/change-requestsPublished as /api/v1/change-requests

Download specification (OpenAPI 3.1) Screen: Change Requests

Overview

PackageEmployee Self Service
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 Employee Self Service › Change Requests 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.ess_change_requests · 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

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

GET/api/ess/change-requestsList change requests

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",
      "request_no": "REQ-000001",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "employee_no": "EMP-000001",
      "employee_name": "Example",
      "request_type": "text",
      "change_of": "text",
      "current_values": {},
      "requested_values": {},
      "requested_summary": "text",
      "reason": "text",
      "effective_date": "2026-10-30",
      "status": "draft"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ess/change-requests?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ess/change-requests/{id}Read one change of details

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",
  "request_no": "REQ-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_no": "EMP-000001",
  "employee_name": "Example",
  "request_type": "text",
  "change_of": "text",
  "current_values": {},
  "requested_values": {},
  "requested_summary": "text",
  "reason": "text",
  "effective_date": "2026-10-30",
  "status": "draft"
}

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

Sample request

curl "https://demo.tranxact.ai/api/ess/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ess/change-requests/{id}/decideDecide

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/ess/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decide" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ess/change-requestsPost change requests

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

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/ess/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/ess/change-requests/{id}Delete change requests

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/ess/change-requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a change of details, 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
request_notextread onlyRequest no
employee_iduuidread onlyEmployee id
employee_notextread onlyEmployee no
employee_nametextread onlyEmployee name
request_typetextread onlyRequest type
change_oftextread onlyChange of
current_valuesjsonbread onlyCurrent values
requested_valuesjsonbread onlyRequested values
requested_summarytextread onlyRequested summary
reasontextread onlyReason
effective_datedateread onlyEffective date
statustextread onlyStatus
raised_byuuidread onlyRaised by
raised_by_nametextread onlyRaised by name
approver_iduuidread onlyApprover id
decided_by_nametextread onlyDecided by name
decided_attimestamp with time zoneread onlyDecided at
decision_notetextread onlyDecision note
applied_attimestamp with time zoneread onlyApplied at
created_attimestamp with time zoneread onlyCreated at
carries_sealed_valuebooleanread onlyCarries sealed value

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 Employee Self Service › Change Requests 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.