HRMS · Labor Distribution & GL Interface
GL Interfaces
Where payroll goes in the general ledger that receives it: the target system profile (Yardi Voyager journal ETL, or a generic CSV / JSON journal), its codes, the schedule and the transport. A new interface sends TEST files until Go live.
/api/hrms/gl-interfacesPublished as /api/v1/gl-interfacesOverview
| 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 Interfaces 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_interfaces · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; 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-interfacesList gl interfaces
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",
"code": "COD-000001",
"name": "Example",
"profile": "Yardi Voyager -- journal ETL (CSV)",
"mode": "text",
"is_active": true,
"detail_level": "By account and dimension",
"liability_split": "Split like the cost (each property balances)",
"dimensions": [],
"default_property_code": "DEF-000001",
"entity_code": "ENT-000001",
"journal_prefix": "text",
"book_code": "BOO-000001"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/gl-interfaces?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/gl-interfaces/{id}Read one gl interface
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",
"code": "COD-000001",
"name": "Example",
"profile": "Yardi Voyager -- journal ETL (CSV)",
"mode": "text",
"is_active": true,
"detail_level": "By account and dimension",
"liability_split": "Split like the cost (each property balances)",
"dimensions": [],
"default_property_code": "DEF-000001",
"entity_code": "ENT-000001",
"journal_prefix": "text",
"book_code": "BOO-000001"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/gl-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/gl-interfacesCreate a gl interface
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
profile | text | No | Target system profile Allowed: Yardi Voyager -- journal ETL (CSV) Generic journal (CSV) Generic journal (JSON) |
mode | text | No | Mode |
is_active | boolean | No | Active |
detail_level | text | No | Detail Allowed: By account and dimension By employee as well |
liability_split | text | No | Liabilities Allowed: Split like the cost (each property balances) At company level (default property) |
dimensions | _text | No | Dimensions carried — Comma separated: property, department, program, fund, grant, cost_center, job. |
default_property_code | text | No | Default property / entity code — The target code for amounts with no property of their own. |
entity_code | text | No | Entity code |
journal_prefix | text | No | Journal prefix |
book_code | text | No | Book — Yardi: Accrual or Cash, as the receiving database names them. |
person_code | text | No | Person code |
column_overrides | jsonb | No | Column headings — Rename any heading to match the receiving ETL template, such as {"AMOUNT":"Amount"}. |
account_pattern | text | No | Account code pattern — A regular expression every target account must match. |
property_pattern | text | No | Property code pattern |
require_valid_list | boolean | No | Codes must be on the valid-code list |
schedule | text | No | Schedule Allowed: After each payroll is posted (and caught up daily) Manual |
transport | text | No | Transport Allowed: Download SFTP HTTPS API |
sftp_host | text | No | SFTP host |
sftp_port | integer | No | SFTP port |
sftp_username | text | No | SFTP user |
sftp_auth | text | No | SFTP sign-in — The key or password itself is set with Set credentials, sealed, and never shown again. Allowed: Private key Password |
sftp_host_key_sha256 | text | No | Pinned host key (SHA256) — Use Fetch host key, compare it with what the receiving side publishes, then pin it. |
sftp_directory | text | No | Folder (live) |
sftp_test_directory | text | No | Folder (test) |
https_url | text | No | HTTPS URL (live) |
https_test_url | text | No | HTTPS URL (test) |
https_header_name | text | No | Token header |
file_name_pattern | text | No | File name — {code}, {run_no}, {version}, {test}, {mode}, {pay_date}, {ext}. |
notify_emails | text | No | Notify emails |
notes | text | No | Notes |
scope_pay_group_ids | _uuid | No | Only these pay groups — Empty: every pay group. A payroll run of another pay group is not sent to this interface. |
scope_org_unit_id | uuid | No | Only this business unit — The pay groups of this unit and the units under it. Empty: every unit. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"profile": "Yardi Voyager -- journal ETL (CSV)",
"mode": "text",
"is_active": true,
"detail_level": "By account and dimension"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"profile": "Yardi Voyager -- journal ETL (CSV)",
"mode": "text",
"is_active": true,
"detail_level": "By account and dimension",
"liability_split": "Split like the cost (each property balances)",
"dimensions": [],
"default_property_code": "DEF-000001",
"entity_code": "ENT-000001",
"journal_prefix": "text",
"book_code": "BOO-000001"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/gl-interfaces" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","profile":"Yardi Voyager -- journal ETL (CSV)","mode":"text","is_active":true,"detail_level":"By account and dimension"}'PUT/api/hrms/gl-interfaces/{id}Change a gl interface
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
profile | text | No | Target system profile Allowed: Yardi Voyager -- journal ETL (CSV) Generic journal (CSV) Generic journal (JSON) |
mode | text | No | Mode |
is_active | boolean | No | Active |
detail_level | text | No | Detail Allowed: By account and dimension By employee as well |
liability_split | text | No | Liabilities Allowed: Split like the cost (each property balances) At company level (default property) |
dimensions | _text | No | Dimensions carried — Comma separated: property, department, program, fund, grant, cost_center, job. |
default_property_code | text | No | Default property / entity code — The target code for amounts with no property of their own. |
entity_code | text | No | Entity code |
journal_prefix | text | No | Journal prefix |
book_code | text | No | Book — Yardi: Accrual or Cash, as the receiving database names them. |
person_code | text | No | Person code |
column_overrides | jsonb | No | Column headings — Rename any heading to match the receiving ETL template, such as {"AMOUNT":"Amount"}. |
account_pattern | text | No | Account code pattern — A regular expression every target account must match. |
property_pattern | text | No | Property code pattern |
require_valid_list | boolean | No | Codes must be on the valid-code list |
schedule | text | No | Schedule Allowed: After each payroll is posted (and caught up daily) Manual |
transport | text | No | Transport Allowed: Download SFTP HTTPS API |
sftp_host | text | No | SFTP host |
sftp_port | integer | No | SFTP port |
sftp_username | text | No | SFTP user |
sftp_auth | text | No | SFTP sign-in — The key or password itself is set with Set credentials, sealed, and never shown again. Allowed: Private key Password |
sftp_host_key_sha256 | text | No | Pinned host key (SHA256) — Use Fetch host key, compare it with what the receiving side publishes, then pin it. |
sftp_directory | text | No | Folder (live) |
sftp_test_directory | text | No | Folder (test) |
https_url | text | No | HTTPS URL (live) |
https_test_url | text | No | HTTPS URL (test) |
https_header_name | text | No | Token header |
file_name_pattern | text | No | File name — {code}, {run_no}, {version}, {test}, {mode}, {pay_date}, {ext}. |
notify_emails | text | No | Notify emails |
notes | text | No | Notes |
scope_pay_group_ids | _uuid | No | Only these pay groups — Empty: every pay group. A payroll run of another pay group is not sent to this interface. |
scope_org_unit_id | uuid | No | Only this business unit — The pay groups of this unit and the units under it. Empty: every unit. |
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",
"profile": "Yardi Voyager -- journal ETL (CSV)",
"mode": "text",
"is_active": true,
"detail_level": "By account and dimension",
"liability_split": "Split like the cost (each property balances)",
"dimensions": [],
"default_property_code": "DEF-000001",
"entity_code": "ENT-000001",
"journal_prefix": "text",
"book_code": "BOO-000001"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/gl-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/gl-interfaces/{id}Delete a gl interface
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/hrms/gl-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/gl-interfaces/optionsOptions
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/gl-interfaces/options" \
-H "Authorization: Bearer $TOKEN"PUT/api/hrms/gl-interfaces/{id}/credentialsCredentials
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):
privateKeyResponse
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-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/credentials" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"privateKey":"value"}'POST/api/hrms/gl-interfaces/{id}/host-keyHost key
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):
pin, expectResponse
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-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/host-key" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"pin":"value","expect":"value"}'POST/api/hrms/gl-interfaces/{id}/previewPreview
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):
payrollRunId, modeResponse
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-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"payrollRunId":"value","mode":"value"}'POST/api/hrms/gl-interfaces/{id}/go-liveGo live
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):
confirmationResponse
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-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/go-live" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"confirmation":"value"}'GET/api/hrms/gl-interfaces/{id}/specificationSpecification
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-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/specification" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/gl-interfaces/{id}/workbookWorkbook
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-interfaces/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/workbook" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/gl-interfaces/{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-interfaces/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 gl interface, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
profile | text | read, write | Target system profile Allowed: Yardi Voyager -- journal ETL (CSV) Generic journal (CSV) Generic journal (JSON) |
mode | text | read, write | Mode |
is_active | boolean | read, write | Active |
detail_level | text | read, write | Detail Allowed: By account and dimension By employee as well |
liability_split | text | read, write | Liabilities Allowed: Split like the cost (each property balances) At company level (default property) |
dimensions | _text | read, write | Dimensions carried — Comma separated: property, department, program, fund, grant, cost_center, job. |
default_property_code | text | read, write | Default property / entity code — The target code for amounts with no property of their own. |
entity_code | text | read, write | Entity code |
journal_prefix | text | read, write | Journal prefix |
book_code | text | read, write | Book — Yardi: Accrual or Cash, as the receiving database names them. |
person_code | text | read, write | Person code |
column_overrides | jsonb | read, write | Column headings — Rename any heading to match the receiving ETL template, such as {"AMOUNT":"Amount"}. |
account_pattern | text | read, write | Account code pattern — A regular expression every target account must match. |
property_pattern | text | read, write | Property code pattern |
require_valid_list | boolean | read, write | Codes must be on the valid-code list |
schedule | text | read, write | Schedule Allowed: After each payroll is posted (and caught up daily) Manual |
transport | text | read, write | Transport Allowed: Download SFTP HTTPS API |
sftp_host | text | read, write | SFTP host |
sftp_port | integer | read, write | SFTP port |
sftp_username | text | read, write | SFTP user |
sftp_auth | text | read, write | SFTP sign-in — The key or password itself is set with Set credentials, sealed, and never shown again. Allowed: Private key Password |
sftp_host_key_sha256 | text | read, write | Pinned host key (SHA256) — Use Fetch host key, compare it with what the receiving side publishes, then pin it. |
sftp_directory | text | read, write | Folder (live) |
sftp_test_directory | text | read, write | Folder (test) |
https_url | text | read, write | HTTPS URL (live) |
https_test_url | text | read, write | HTTPS URL (test) |
https_header_name | text | read, write | Token header |
file_name_pattern | text | read, write | File name — {code}, {run_no}, {version}, {test}, {mode}, {pay_date}, {ext}. |
notify_emails | text | read, write | Notify emails |
go_live_at | timestamp with time zone | read only | Go live at |
go_live_by | uuid | read only | Go live by |
last_test_run_id | uuid | read only | Last test run id |
notes | text | read, write | Notes |
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 |
scope_pay_group_ids | _uuid | read, write | Only these pay groups — Empty: every pay group. A payroll run of another pay group is not sent to this interface. |
scope_org_unit_id | uuid | read, write | Only this business unit — The pay groups of this unit and the units under it. Empty: every unit. |
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 Interfaces 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.