TRANXACT.AI Help

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.

Type REST13 operationsBase path /api/hrms/gl-interfacesPublished as /api/v1/gl-interfaces

Download specification (OpenAPI 3.1) Screen: GL Interfaces

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

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

GET/api/hrms/gl-interfacesList gl interfaces

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

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

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
profiletextNoTarget system profile
Allowed: Yardi Voyager -- journal ETL (CSV) Generic journal (CSV) Generic journal (JSON)
modetextNoMode
is_activebooleanNoActive
detail_leveltextNoDetail
Allowed: By account and dimension By employee as well
liability_splittextNoLiabilities
Allowed: Split like the cost (each property balances) At company level (default property)
dimensions_textNoDimensions carried — Comma separated: property, department, program, fund, grant, cost_center, job.
default_property_codetextNoDefault property / entity code — The target code for amounts with no property of their own.
entity_codetextNoEntity code
journal_prefixtextNoJournal prefix
book_codetextNoBook — Yardi: Accrual or Cash, as the receiving database names them.
person_codetextNoPerson code
column_overridesjsonbNoColumn headings — Rename any heading to match the receiving ETL template, such as {"AMOUNT":"Amount"}.
account_patterntextNoAccount code pattern — A regular expression every target account must match.
property_patterntextNoProperty code pattern
require_valid_listbooleanNoCodes must be on the valid-code list
scheduletextNoSchedule
Allowed: After each payroll is posted (and caught up daily) Manual
transporttextNoTransport
Allowed: Download SFTP HTTPS API
sftp_hosttextNoSFTP host
sftp_portintegerNoSFTP port
sftp_usernametextNoSFTP user
sftp_authtextNoSFTP sign-in — The key or password itself is set with Set credentials, sealed, and never shown again.
Allowed: Private key Password
sftp_host_key_sha256textNoPinned host key (SHA256) — Use Fetch host key, compare it with what the receiving side publishes, then pin it.
sftp_directorytextNoFolder (live)
sftp_test_directorytextNoFolder (test)
https_urltextNoHTTPS URL (live)
https_test_urltextNoHTTPS URL (test)
https_header_nametextNoToken header
file_name_patterntextNoFile name — {code}, {run_no}, {version}, {test}, {mode}, {pay_date}, {ext}.
notify_emailstextNoNotify emails
notestextNoNotes
scope_pay_group_ids_uuidNoOnly these pay groups — Empty: every pay group. A payroll run of another pay group is not sent to this interface.
scope_org_unit_iduuidNoOnly 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

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
nametextYesName
profiletextNoTarget system profile
Allowed: Yardi Voyager -- journal ETL (CSV) Generic journal (CSV) Generic journal (JSON)
modetextNoMode
is_activebooleanNoActive
detail_leveltextNoDetail
Allowed: By account and dimension By employee as well
liability_splittextNoLiabilities
Allowed: Split like the cost (each property balances) At company level (default property)
dimensions_textNoDimensions carried — Comma separated: property, department, program, fund, grant, cost_center, job.
default_property_codetextNoDefault property / entity code — The target code for amounts with no property of their own.
entity_codetextNoEntity code
journal_prefixtextNoJournal prefix
book_codetextNoBook — Yardi: Accrual or Cash, as the receiving database names them.
person_codetextNoPerson code
column_overridesjsonbNoColumn headings — Rename any heading to match the receiving ETL template, such as {"AMOUNT":"Amount"}.
account_patterntextNoAccount code pattern — A regular expression every target account must match.
property_patterntextNoProperty code pattern
require_valid_listbooleanNoCodes must be on the valid-code list
scheduletextNoSchedule
Allowed: After each payroll is posted (and caught up daily) Manual
transporttextNoTransport
Allowed: Download SFTP HTTPS API
sftp_hosttextNoSFTP host
sftp_portintegerNoSFTP port
sftp_usernametextNoSFTP user
sftp_authtextNoSFTP sign-in — The key or password itself is set with Set credentials, sealed, and never shown again.
Allowed: Private key Password
sftp_host_key_sha256textNoPinned host key (SHA256) — Use Fetch host key, compare it with what the receiving side publishes, then pin it.
sftp_directorytextNoFolder (live)
sftp_test_directorytextNoFolder (test)
https_urltextNoHTTPS URL (live)
https_test_urltextNoHTTPS URL (test)
https_header_nametextNoToken header
file_name_patterntextNoFile name — {code}, {run_no}, {version}, {test}, {mode}, {pay_date}, {ext}.
notify_emailstextNoNotify emails
notestextNoNotes
scope_pay_group_ids_uuidNoOnly these pay groups — Empty: every pay group. A payroll run of another pay group is not sent to this interface.
scope_org_unit_iduuidNoOnly 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

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/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

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):

privateKey

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

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):

pin, expect

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

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):

payrollRunId, mode

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

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):

confirmation

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

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

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

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
profiletextread, writeTarget system profile
Allowed: Yardi Voyager -- journal ETL (CSV) Generic journal (CSV) Generic journal (JSON)
modetextread, writeMode
is_activebooleanread, writeActive
detail_leveltextread, writeDetail
Allowed: By account and dimension By employee as well
liability_splittextread, writeLiabilities
Allowed: Split like the cost (each property balances) At company level (default property)
dimensions_textread, writeDimensions carried — Comma separated: property, department, program, fund, grant, cost_center, job.
default_property_codetextread, writeDefault property / entity code — The target code for amounts with no property of their own.
entity_codetextread, writeEntity code
journal_prefixtextread, writeJournal prefix
book_codetextread, writeBook — Yardi: Accrual or Cash, as the receiving database names them.
person_codetextread, writePerson code
column_overridesjsonbread, writeColumn headings — Rename any heading to match the receiving ETL template, such as {"AMOUNT":"Amount"}.
account_patterntextread, writeAccount code pattern — A regular expression every target account must match.
property_patterntextread, writeProperty code pattern
require_valid_listbooleanread, writeCodes must be on the valid-code list
scheduletextread, writeSchedule
Allowed: After each payroll is posted (and caught up daily) Manual
transporttextread, writeTransport
Allowed: Download SFTP HTTPS API
sftp_hosttextread, writeSFTP host
sftp_portintegerread, writeSFTP port
sftp_usernametextread, writeSFTP user
sftp_authtextread, writeSFTP sign-in — The key or password itself is set with Set credentials, sealed, and never shown again.
Allowed: Private key Password
sftp_host_key_sha256textread, writePinned host key (SHA256) — Use Fetch host key, compare it with what the receiving side publishes, then pin it.
sftp_directorytextread, writeFolder (live)
sftp_test_directorytextread, writeFolder (test)
https_urltextread, writeHTTPS URL (live)
https_test_urltextread, writeHTTPS URL (test)
https_header_nametextread, writeToken header
file_name_patterntextread, writeFile name — {code}, {run_no}, {version}, {test}, {mode}, {pay_date}, {ext}.
notify_emailstextread, writeNotify emails
go_live_attimestamp with time zoneread onlyGo live at
go_live_byuuidread onlyGo live by
last_test_run_iduuidread onlyLast test run id
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
scope_pay_group_ids_uuidread, writeOnly these pay groups — Empty: every pay group. A payroll run of another pay group is not sent to this interface.
scope_org_unit_iduuidread, writeOnly this business unit — The pay groups of this unit and the units under it. Empty: every unit.
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 › GL Interfaces 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.