TRANXACT.AI Help

HRMS · Labor Distribution & GL Interface

GL Interface Mappings

Which target account (and property, segments) each payroll amount goes to. The most specific rule wins: a code before *, then each dimension it names, then priority.

Type REST6 operationsBase path /api/hrms/gl-mappingsPublished as /api/v1/gl-mappings

Download specification (OpenAPI 3.1) Screen: GL Interface Mappings

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 Interface Mappings 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_interface_mappings · 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

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

GET/api/hrms/gl-mappingsList gl interface mappings

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",
      "interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "source_kind": "Earnings (wage expense)",
      "source_code": "SOU-000001",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "department": "text",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "fund_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "target_account": "text",
      "target_property": "text",
      "segment_1": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_kind": "Earnings (wage expense)",
  "source_code": "SOU-000001",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "department": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fund_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "target_account": "text",
  "target_property": "text",
  "segment_1": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/gl-mappings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/gl-mappingsCreate a gl mapping

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
interface_iduuidYesInterface
source_kindtextYesAmount
Allowed: Earnings (wage expense) Employer taxes (expense) Employer benefit costs (expense) Employee taxes withheld (liability) Employee deductions (liability) Employer taxes owed (liability) Employer benefit costs owed (liability) Net pay owed (liability)
source_codetextNoEarning, tax or deduction code — * for any code.
cost_center_iduuidNoCost center
departmenttextNoDepartment — As the position names it, such as MAINT.
location_iduuidNoProperty / site
fund_iduuidNoFund
grant_iduuidNoGrant — A grant brings its own fund.
program_iduuidNoProgram
job_iduuidNoJob / class
target_accounttextYesTarget account
target_propertytextNoTarget property — Empty: the crosswalk of the property, or the default.
segment_1textNoSegment 1
segment_2textNoSegment 2
descriptiontextNoDescription
priorityintegerNoPriority
is_activebooleanNoActive

Sample body

{
  "interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_kind": "Earnings (wage expense)",
  "target_account": "text",
  "source_code": "SOU-000001",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "department": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_kind": "Earnings (wage expense)",
  "source_code": "SOU-000001",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "department": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fund_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "target_account": "text",
  "target_property": "text",
  "segment_1": "text"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/gl-mappings" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"interface_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","source_kind":"Earnings (wage expense)","target_account":"text","source_code":"SOU-000001","cost_center_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","department":"text","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/hrms/gl-mappings/{id}Change a gl mapping

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
interface_iduuidYesInterface
source_kindtextYesAmount
Allowed: Earnings (wage expense) Employer taxes (expense) Employer benefit costs (expense) Employee taxes withheld (liability) Employee deductions (liability) Employer taxes owed (liability) Employer benefit costs owed (liability) Net pay owed (liability)
source_codetextNoEarning, tax or deduction code — * for any code.
cost_center_iduuidNoCost center
departmenttextNoDepartment — As the position names it, such as MAINT.
location_iduuidNoProperty / site
fund_iduuidNoFund
grant_iduuidNoGrant — A grant brings its own fund.
program_iduuidNoProgram
job_iduuidNoJob / class
target_accounttextYesTarget account
target_propertytextNoTarget property — Empty: the crosswalk of the property, or the default.
segment_1textNoSegment 1
segment_2textNoSegment 2
descriptiontextNoDescription
priorityintegerNoPriority
is_activebooleanNoActive

Sample body

{
  "interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_kind": "Earnings (wage expense)"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "source_kind": "Earnings (wage expense)",
  "source_code": "SOU-000001",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "department": "text",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "fund_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grant_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "target_account": "text",
  "target_property": "text",
  "segment_1": "text"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/gl-mappings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"interface_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","source_kind":"Earnings (wage expense)"}'
DELETE/api/hrms/gl-mappings/{id}Delete a gl mapping

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-mappings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/gl-mappings/{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-mappings/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 mapping, 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
interface_iduuidread, writeInterface
source_kindtextread, writeAmount
Allowed: Earnings (wage expense) Employer taxes (expense) Employer benefit costs (expense) Employee taxes withheld (liability) Employee deductions (liability) Employer taxes owed (liability) Employer benefit costs owed (liability) Net pay owed (liability)
source_codetextread, writeEarning, tax or deduction code — * for any code.
cost_center_iduuidread, writeCost center
departmenttextread, writeDepartment — As the position names it, such as MAINT.
location_iduuidread, writeProperty / site
fund_iduuidread, writeFund
grant_iduuidread, writeGrant — A grant brings its own fund.
program_iduuidread, writeProgram
job_iduuidread, writeJob / class
target_accounttextread, writeTarget account
target_propertytextread, writeTarget property — Empty: the crosswalk of the property, or the default.
segment_1textread, writeSegment 1
segment_2textread, writeSegment 2
descriptiontextread, writeDescription
priorityintegerread, writePriority
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
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 › GL Interface Mappings 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.