TRANXACT.AI Help

HRMS · Parallel Payroll

Parallel Payroll Comparisons

Legacy register against a TRANXACT run, category by category and employee by employee, with a tolerance and a sign-off. Go-live is ready after two cycles in a row are signed off.

Type REST11 operationsBase path /api/hrms/parallel-comparisonsPublished as /api/v1/parallel-comparisons

Download specification (OpenAPI 3.1) Screen: Parallel Payroll Comparisons

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 › Parallel Payroll Comparisons 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.parallel_comparisons · 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

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

GET/api/hrms/parallel-comparisonsList parallel payroll comparisons

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",
      "comparison_no": "COM-000001",
      "register_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "cycle_no": 10,
      "tolerance_amount": "1250.00",
      "tolerance_pct": "1250.00",
      "status": "draft",
      "summary": {},
      "variance_count": 10,
      "employees_compared": 10,
      "within_tolerance": true
    }
  ],
  "count": 1
}

Sample request

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

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",
  "comparison_no": "COM-000001",
  "register_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "payroll_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "interface_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cycle_no": 10,
  "tolerance_amount": "1250.00",
  "tolerance_pct": "1250.00",
  "status": "draft",
  "summary": {},
  "variance_count": 10,
  "employees_compared": 10,
  "within_tolerance": true
}

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

Sample request

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

Request body

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

registerId, payrollRunId, interfaceId, toleranceAmount, tolerancePct, cycleNo

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/parallel-comparisons/compare" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"registerId":"value","payrollRunId":"value","interfaceId":"value","toleranceAmount":"value","tolerancePct":"value","cycleNo":"value"}'
GET/api/hrms/parallel-comparisons/{id}/variancesVariances

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/parallel-comparisons/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/variances" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/parallel-comparisons/readinessReadiness

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/parallel-comparisons/readiness" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/parallel-comparisons/{id}/sign-offSign off

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

note

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/parallel-comparisons/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/sign-off" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value"}'
POST/api/hrms/parallel-comparisons/{id}/rejectReject

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

note

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

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

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

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

Data model

Every field of a parallel comparison, 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
comparison_notextread onlyComparison no
register_iduuidread onlyRegister id
payroll_run_iduuidread onlyPayroll run id
interface_iduuidread onlyInterface id
cycle_nointegerread onlyCycle no
tolerance_amountnumericread onlyTolerance amount
tolerance_pctnumericread onlyTolerance pct
statustextread onlyStatus
summaryjsonbread onlySummary
variance_countintegerread onlyVariance count
employees_comparedintegerread onlyEmployees compared
within_tolerancebooleanread onlyWithin tolerance
signed_off_byuuidread onlySigned off by
signed_off_attimestamp with time zoneread onlySigned off at
sign_off_notetextread onlySign off note
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 › Parallel Payroll Comparisons 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.