TRANXACT.AI Help

HRMS · Pay Processing

Pay Files

Each payroll run’s net-pay file for the bank, every version kept with its checksum and control totals. Made from Payroll Runs > Create pay file.

Type REST12 operationsBase path /api/hrms/pay-filesPublished as /api/v1/pay-files

Download specification (OpenAPI 3.1) Screen: Pay 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 › Pay 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.pay_file_board · 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

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

GET/api/hrms/pay-filesList pay 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",
      "payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "run_no": "RUN-000001",
      "period_start": "2026-10-30",
      "period_end": "2026-10-30",
      "pay_date": "2026-10-30",
      "run_status": "draft",
      "paid_at": "2026-10-30T09:00:00Z",
      "version": 10,
      "format": "text",
      "format_label": "text",
      "status": "draft",
      "file_name": "Example",
      "sha256": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_no": "RUN-000001",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "pay_date": "2026-10-30",
  "run_status": "draft",
  "paid_at": "2026-10-30T09:00:00Z",
  "version": 10,
  "format": "text",
  "format_label": "text",
  "status": "draft",
  "file_name": "Example",
  "sha256": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/pay-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/pay-files/previewPreview

Request body

The keys this action reads (* = required; "one of" lists the only values):

runId, format

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/pay-files/preview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"runId":"value","format":"value"}'
POST/api/hrms/pay-files/createCreate

Request body

The keys this action reads (* = required; "one of" lists the only values):

runId, format, effectiveDate; format one of nacha|neft_csv|wps_sif|pain001

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/pay-files/create" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"runId":"value","format":"value","effectiveDate;":"value"}'
GET/api/hrms/pay-files/{id}/exceptionsExceptions

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

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

replace, reason, firstCheckNo; checks: [{ employeeId, employeeNo, checkNo, check_number }]

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/pay-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/checks" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"replace":"value","reason":"value","firstCheckNo;":"value","employeeNo":"value","checkNo":"value","check_number":"value"}'
GET/api/hrms/pay-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/pay-files/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/download" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/pay-files/{id}/confirmConfirm

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

Data model

Every field of a pay 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
payroll_run_iduuidread onlyPayroll run id
run_notextread onlyRun no
period_startdateread onlyPeriod start
period_enddateread onlyPeriod end
pay_datedateread onlyPay date
run_statustextread onlyRun status
paid_attimestamp with time zoneread onlyPaid at
versionintegerread onlyVersion
formattextread onlyFormat
format_labeltextread onlyFormat label
statustextread onlyStatus
file_nametextread onlyFile name
sha256textread onlySha256
entry_countintegerread onlyEntry count
employee_countintegerread onlyEmployee count
total_amountnumericread onlyTotal amount
currencytextread onlyCurrency
entry_hashtextread onlyEntry hash
block_countintegerread onlyBlock count
line_countintegerread onlyLine count
effective_datedateread onlyEffective date
controlsjsonbread onlyControls
exception_countintegerread onlyException count
exceptionsjsonbread onlyExceptions
created_attimestamp with time zoneread onlyCreated at
created_by_nametextread onlyCreated by name
confirmed_attimestamp with time zoneread onlyConfirmed at
confirmed_by_nametextread onlyConfirmed by name
downloadsintegerread onlyDownloads

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 › Pay 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.