TRANXACT.AI Help

HRMS · Pay Processing

Year to Date

What every tax rule actually reads: the wage bases, the thresholds and the limits are all year-to-date questions.

Type REST6 operationsBase path /api/hrms/ytd-balancesPublished as /api/v1/ytd-balances

Download specification (OpenAPI 3.1) Screen: Year to Date

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 › Year to Date 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.ytd_balances · 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

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

GET/api/hrms/ytd-balancesList year to date

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",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "tax_year": 10,
      "gross_pay": "1250.00",
      "fit_wages": "1250.00",
      "fit_withheld": "1250.00",
      "ss_wages": "1250.00",
      "ss_withheld": "1250.00",
      "medicare_wages": "1250.00",
      "medicare_withheld": "1250.00",
      "addl_medicare_withheld": "1250.00",
      "sit_wages": "1250.00",
      "sit_withheld": "1250.00",
      "local_withheld": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "tax_year": 10,
  "gross_pay": "1250.00",
  "fit_wages": "1250.00",
  "fit_withheld": "1250.00",
  "ss_wages": "1250.00",
  "ss_withheld": "1250.00",
  "medicare_wages": "1250.00",
  "medicare_withheld": "1250.00",
  "addl_medicare_withheld": "1250.00",
  "sit_wages": "1250.00",
  "sit_withheld": "1250.00",
  "local_withheld": "1250.00"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/ytd-balances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/ytd-balancesPost year to date

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/ytd-balances" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/ytd-balances/{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/ytd-balances/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/ytd-balances/{id}Put year to date

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

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

Data model

Every field of a ytd balances, 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
employee_iduuidread onlyEmployee id
tax_yearintegerread onlyTax year
gross_paynumericread onlyGross pay
fit_wagesnumericread onlyFit wages
fit_withheldnumericread onlyFit withheld
ss_wagesnumericread onlySs wages
ss_withheldnumericread onlySs withheld
medicare_wagesnumericread onlyMedicare wages
medicare_withheldnumericread onlyMedicare withheld
addl_medicare_withheldnumericread onlyAddl medicare withheld
sit_wagesnumericread onlySit wages
sit_withheldnumericread onlySit withheld
local_withheldnumericread onlyLocal withheld
futa_wagesnumericread onlyFuta wages
suta_wagesnumericread onlySuta wages
pretax_401knumericread onlyPretax 401k
roth_401knumericread onlyRoth 401k
pretax_medicalnumericread onlyPretax medical
dependent_carenumericread onlyDependent care
hsa_employeenumericread onlyHsa employee
hsa_employernumericread onlyHsa employer
imputed_incomenumericread onlyImputed income
net_paynumericread onlyNet pay
employer_ssnumericread onlyEmployer ss
employer_medicarenumericread onlyEmployer medicare
employer_futanumericread onlyEmployer futa
employer_sutanumericread onlyEmployer suta
work_statetextread onlyWork state
updated_attimestamp with time zoneread onlyUpdated at
org_unit_iduuidread onlyOrg unit id
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_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_byuuidread onlyUpdated 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 › Year to Date 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.