TRANXACT.AI Help

HRMS · Statutory Regimes

Statutory Regimes

Add a country to payroll by configuration: income tax slabs, social contributions, employer costs and the returns it files. The United States, India and Saudi Arabia keep their built-in regimes. The sample regime is a disabled worked example: copy it under your own country code.

Type REST10 operationsBase path /api/hrms/regime-profilesPublished as /api/v1/regime-profiles

Download specification (OpenAPI 3.1) Screen: Statutory Regimes

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 › Statutory Regimes 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.regime_profiles · 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

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

GET/api/hrms/regime-profilesList statutory regimes

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",
      "country": "US",
      "code": "COD-000001",
      "name": "Example",
      "currency": "USD",
      "status": "draft",
      "effective_from": "2026-10-30",
      "effective_to": "2026-10-30",
      "is_sample": true,
      "description": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "updated_at": "2026-10-30T09:00:00Z",
      "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "country": "US",
  "code": "COD-000001",
  "name": "Example",
  "currency": "USD",
  "status": "draft",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "is_sample": true,
  "description": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z",
  "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/regime-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/regime-profilesCreate a statutory regime

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
countrytextYesCountry code — Two letters, e.g. AE, GB. Not US, IN or SA.
codetextYesCode
nametextYesName
currencytextNoCurrency
effective_fromdateNoEffective from
effective_todateNoEffective to
descriptiontextNoDescription

Sample body

{
  "country": "US",
  "code": "COD-000001",
  "name": "Example",
  "currency": "USD",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "description": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "country": "US",
  "code": "COD-000001",
  "name": "Example",
  "currency": "USD",
  "status": "draft",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "is_sample": true,
  "description": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z",
  "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/regime-profiles" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"country":"US","code":"COD-000001","name":"Example","currency":"USD","effective_from":"2026-10-30","effective_to":"2026-10-30","description":"text"}'
PUT/api/hrms/regime-profiles/{id}Change a statutory regime

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
countrytextYesCountry code — Two letters, e.g. AE, GB. Not US, IN or SA.
codetextYesCode
nametextYesName
currencytextNoCurrency
effective_fromdateNoEffective from
effective_todateNoEffective to
descriptiontextNoDescription

Sample body

{
  "country": "US",
  "code": "COD-000001"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "country": "US",
  "code": "COD-000001",
  "name": "Example",
  "currency": "USD",
  "status": "draft",
  "effective_from": "2026-10-30",
  "effective_to": "2026-10-30",
  "is_sample": true,
  "description": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "created_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "updated_at": "2026-10-30T09:00:00Z",
  "updated_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/regime-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"country":"US","code":"COD-000001"}'
DELETE/api/hrms/regime-profiles/{id}Delete a statutory regime

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

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

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

gross, basic, taxable, frequency

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/regime-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"gross":"value","basic":"value","taxable":"value","frequency":"value"}'
POST/api/hrms/regime-profiles/{id}/enableEnable

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

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/regime-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/disable" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/regime-profiles/{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):

country, code*, name, currency; country one of US|IN|SA

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/regime-profiles/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"country":"value","code":"value","name":"value","currency;":"value"}'

Data model

Every field of a statutory regime, 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
countrytextread, writeCountry code — Two letters, e.g. AE, GB. Not US, IN or SA.
codetextread, writeCode
nametextread, writeName
currencytextread, writeCurrency
statustextread onlyStatus
effective_fromdateread, writeEffective from
effective_todateread, writeEffective to
is_samplebooleanread onlyIs sample
descriptiontextread, writeDescription
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 › Statutory Regimes 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.