TRANXACT.AI Help

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.

Type REST13 operationsBase path /api/hrms/gl-filesPublished as /api/v1/gl-files

Download specification (OpenAPI 3.1) Screen: GL Interface Files

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 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.
Tablehr.gl_interface_runs · 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

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

GET/api/hrms/gl-filesList gl interface files

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

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

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

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/hrms/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/gl-files/{id}/resendResend

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/hrms/gl-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/resend" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/gl-files/{id}/reprocessReprocess

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

reason

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/reprocess" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
GET/api/hrms/gl-files/{id}/downloadDownload

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-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/download" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/gl-files/{id}/transmissionsTransmissions

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

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

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

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

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
run_notextread onlyRun no
interface_iduuidread onlyInterface id
payroll_run_iduuidread onlyPayroll run id
versionintegerread onlyVersion
modetextread onlyMode
statustextread onlyStatus
profiletextread onlyProfile
transporttextread onlyTransport
file_nametextread onlyFile name
content_typetextread onlyContent type
contenttextread onlyContent
checksum_sha256textread onlyChecksum sha256
record_countintegerread onlyRecord count
total_debitnumericread onlyTotal debit
total_creditnumericread onlyTotal credit
balancedbooleanread onlyBalanced
controls_okbooleanread onlyControls ok
control_totalsjsonbread onlyControl totals
exception_countintegerread onlyException count
triggertextread onlyTrigger
reasontextread onlyReason
supersedes_iduuidread onlySupersedes id
sent_attimestamp with time zoneread onlySent at
attemptsintegerread onlyAttempts
last_errortextread onlyLast error
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 Files 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.