HRMS · Labor Distribution & GL Interface
GL Interface Files
Every file made, version by version, with its checksum and control totals -- never changed, never deleted. Resend sends the same file again; Reprocess makes the next version after a correction.
/api/hrms/gl-filesPublished as /api/v1/gl-filesDownload specification (OpenAPI 3.1) Screen: GL Interface Files
Overview
| Package | HRMS |
|---|---|
| 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 HRMS › GL Interface Files 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 | hr.gl_interface_runs · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
13 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/gl-filesList gl interface files
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",
"run_no": "RUN-000001",
"interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"version": 10,
"mode": "text",
"status": "draft",
"profile": "text",
"transport": "text",
"file_name": "Example",
"content_type": "text",
"content": "text",
"checksum_sha256": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/gl-files?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/gl-files/{id}Read one interface file
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",
"run_no": "RUN-000001",
"interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"version": 10,
"mode": "text",
"status": "draft",
"profile": "text",
"transport": "text",
"file_name": "Example",
"content_type": "text",
"content": "text",
"checksum_sha256": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/gl-files/generateGenerate
Request body
The keys this action reads (* = required; "one of" lists the only values):
interfaceId, payrollRunId, mode, reason, send; mode one of test|liveResponse
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/gl-files/generate" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"interfaceId":"value","payrollRunId":"value","mode":"value","reason":"value","send;":"value"}'POST/api/hrms/gl-files/send-dueSend due
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/gl-files/send-due" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/gl-files/{id}/sendSend
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/hrms/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/gl-files/{id}/resendResend
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/hrms/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resend" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/gl-files/{id}/reprocessReprocess
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):
reasonResponse
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/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/reprocess" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'GET/api/hrms/gl-files/{id}/downloadDownload
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/download" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/gl-files/{id}/transmissionsTransmissions
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transmissions" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/gl-filesPost gl interface files
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/gl-files" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/gl-files/{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/hrms/gl-files/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/gl-files/{id}Put gl interface files
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 PUT "https://demo.tranxact.ai/api/hrms/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/gl-files/{id}Delete gl interface files
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 DELETE "https://demo.tranxact.ai/api/hrms/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a interface file, 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 |
run_no | text | read only | Run no |
interface_id | uuid | read only | Interface id |
payroll_run_id | uuid | read only | Payroll run id |
version | integer | read only | Version |
mode | text | read only | Mode |
status | text | read only | Status |
profile | text | read only | Profile |
transport | text | read only | Transport |
file_name | text | read only | File name |
content_type | text | read only | Content type |
content | text | read only | Content |
checksum_sha256 | text | read only | Checksum sha256 |
record_count | integer | read only | Record count |
total_debit | numeric | read only | Total debit |
total_credit | numeric | read only | Total credit |
balanced | boolean | read only | Balanced |
controls_ok | boolean | read only | Controls ok |
control_totals | jsonb | read only | Control totals |
exception_count | integer | read only | Exception count |
trigger | text | read only | Trigger |
reason | text | read only | Reason |
supersedes_id | uuid | read only | Supersedes id |
sent_at | timestamp with time zone | read only | Sent at |
attempts | integer | read only | Attempts |
last_error | text | read only | Last error |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 HRMS › GL Interface Files 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.