TRANXACT.AI Help

HRMS · Pay Processing

Payroll Runs

Read and maintain payroll runs records (hr.payroll_runs).

Type REST18 operationsBase path /api/hrms/payroll-runsPublished as /api/v1/payroll-runs

Download specification (OpenAPI 3.1) Screen: Payroll Runs

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 › Payroll Runs 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.payroll_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

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

GET/api/hrms/payroll-runsList payroll runs

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",
      "run_no": "RUN-000001",
      "period_start": "2026-10-30",
      "period_end": "2026-10-30",
      "pay_date": "2026-10-30",
      "status": "draft",
      "total_gross": "1250.00",
      "total_net": "1250.00",
      "total_taxes": "1250.00",
      "total_deductions": "1250.00",
      "journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "calculated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "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",
  "status": "draft",
  "total_gross": "1250.00",
  "total_net": "1250.00",
  "total_taxes": "1250.00",
  "total_deductions": "1250.00",
  "journal_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "calculated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "approved_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/payroll-runs/{id}/linesLines

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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/lines" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/payroll-runsPost payroll runs

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/payroll-runs" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/payroll-runs/{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/payroll-runs/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/payroll-runs/{id}Put payroll runs

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

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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/payroll-runs/{parentId}/payslipsPayslips

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payslips" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/payroll-runs/{parentId}/payslipsPayslips

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payslips" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/hrms/payroll-runs/{parentId}/payslips/{lineId}Payslips

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payslips/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/payroll-runs/{parentId}/payslips/{lineId}Payslips

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/payslips/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/payroll-runs/calculateCalculate

Request body

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

employeeId, earningCode, amount, hours, reason, periodStart, periodEnd, payDate, payGroupId, payPeriodId, runType, missingTime, force, forceReason, employeeIds, earnings

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/payroll-runs/calculate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","earningCode":"value","amount":"value","hours":"value","reason":"value","periodStart":"value"}'
GET/api/hrms/payroll-runs/{id}/payslipsPayslips

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

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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/payroll-runs/{id}/approve-overrideApprove override

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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve-override" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/payroll-runs/{id}/send-backSend back

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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send-back" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/hrms/payroll-runs/{id}/cancelCancel

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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/hrms/payroll-runs/{id}/postPost

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/payroll-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a payroll runs, 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
run_notextread onlyRun no
period_startdateread onlyPeriod start
period_enddateread onlyPeriod end
pay_datedateread onlyPay date
statustextread onlyStatus
total_grossnumericread onlyTotal gross
total_netnumericread onlyTotal net
total_taxesnumericread onlyTotal taxes
total_deductionsnumericread onlyTotal deductions
journal_iduuidread onlyJournal id
calculated_byuuidread onlyCalculated by
approved_byuuidread onlyApproved by
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
cost_center_iduuidread onlyCost center id
profit_center_iduuidread onlyProfit center id
pay_group_iduuidread onlyPay group id
pay_period_iduuidread onlyPay period id
run_typetextread onlyRun type
tax_yearintegerread onlyTax year
quarterintegerread onlyQuarter
employer_taxesnumericread onlyEmployer taxes
employer_contributionsnumericread onlyEmployer contributions
employee_countintegerread onlyEmployee count
calculation_modetextread onlyCalculation mode
engine_nametextread onlyEngine name
paid_attimestamp with time zoneread onlyPaid at
reversal_ofuuidread onlyReversal of
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
fund_iduuidread onlyFund id
grant_iduuidread onlyGrant id
program_iduuidread onlyProgram id
function_iduuidread onlyFunction id
derivation_tracejsonbread onlyDerivation trace
left_outjsonbread onlyLeft out
ytd_posted_attimestamp with time zoneread onlyYtd posted at
paid_byuuidread onlyPaid by

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 › Payroll Runs 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.