TRANXACT.AI Help

HRMS · Payroll Tax

Payroll Tax Calendar

What is due and when. The deposit and the return are separate rows because they are separate obligations with separate penalties.

Type REST6 operationsBase path /api/hrms/payroll-tax-calendarPublished as /api/v1/payroll-tax-calendar

Download specification (OpenAPI 3.1) Screen: Payroll Tax Calendar

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 Tax Calendar 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_tax_calendar · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; 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/payroll-tax-calendarList payroll tax calendar

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",
      "registration_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "obligation_kind": "text",
      "event_kind": "text",
      "period_kind": "text",
      "period_code": "PER-000001",
      "period_from": "2026-10-30",
      "period_to": "2026-10-30",
      "due_date": "2026-10-30",
      "form_code": "FOR-000001",
      "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "status": "due",
      "completed_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "registration_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "obligation_kind": "text",
  "event_kind": "text",
  "period_kind": "text",
  "period_code": "PER-000001",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "due_date": "2026-10-30",
  "form_code": "FOR-000001",
  "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "due",
  "completed_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-tax-calendar/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/payroll-tax-calendarCreate a payroll tax obligation

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
statustextNoStatus
Allowed: due in_progress deposited filed late waived not_required
notestextNoNotes

Sample body

{
  "status": "due",
  "notes": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "registration_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "obligation_kind": "text",
  "event_kind": "text",
  "period_kind": "text",
  "period_code": "PER-000001",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "due_date": "2026-10-30",
  "form_code": "FOR-000001",
  "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "due",
  "completed_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/payroll-tax-calendar" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"due","notes":"text"}'
PUT/api/hrms/payroll-tax-calendar/{id}Change a payroll tax obligation

Path parameters

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

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
statustextNoStatus
Allowed: due in_progress deposited filed late waived not_required
notestextNoNotes

Sample body

{
  "status": "due",
  "notes": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "registration_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "obligation_kind": "text",
  "event_kind": "text",
  "period_kind": "text",
  "period_code": "PER-000001",
  "period_from": "2026-10-30",
  "period_to": "2026-10-30",
  "due_date": "2026-10-30",
  "form_code": "FOR-000001",
  "run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "status": "due",
  "completed_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/payroll-tax-calendar/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"due","notes":"text"}'
DELETE/api/hrms/payroll-tax-calendar/{id}Delete a payroll tax obligation

Path parameters

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

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/hrms/payroll-tax-calendar/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/payroll-tax-calendar/{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-tax-calendar/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a payroll tax obligation, 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
registration_iduuidread onlyRegistration id
obligation_kindtextread onlyObligation kind
event_kindtextread onlyEvent kind
period_kindtextread onlyPeriod kind
period_codetextread onlyPeriod code
period_fromdateread onlyPeriod from
period_todateread onlyPeriod to
due_datedateread onlyDue date
form_codetextread onlyForm code
run_iduuidread onlyRun id
statustextread, writeStatus
Allowed: due in_progress deposited filed late waived not_required
completed_attimestamp with time zoneread onlyCompleted at
amountnumericread onlyAmount
notestextread, writeNotes
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_attimestamp with time zoneread onlyUpdated at
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 › Payroll Tax Calendar 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.