TRANXACT.AI Help

HRMS · Statutory Regimes

Regime Components

The parts of a statutory regime: an income tax on slabs, a social contribution, an employer cost.

Type REST6 operationsBase path /api/hrms/regime-componentsPublished as /api/v1/regime-components

Download specification (OpenAPI 3.1) Screen: Regime Components

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 › Regime Components 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_components
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/regime-componentsList regime components

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",
      "profile_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "kind": "Income tax on slabs",
      "code": "COD-000001",
      "name": "Example",
      "base": "gross",
      "employee_rate": "1250.00",
      "employer_rate": "1250.00",
      "wage_floor_monthly": "1250.00",
      "wage_ceiling_monthly": "1250.00",
      "annual_allowance": "1250.00",
      "annual_rebate": "1250.00",
      "gl_account_no": "GL-000001",
      "sort_order": 10
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "profile_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "kind": "Income tax on slabs",
  "code": "COD-000001",
  "name": "Example",
  "base": "gross",
  "employee_rate": "1250.00",
  "employer_rate": "1250.00",
  "wage_floor_monthly": "1250.00",
  "wage_ceiling_monthly": "1250.00",
  "annual_allowance": "1250.00",
  "annual_rebate": "1250.00",
  "gl_account_no": "GL-000001",
  "sort_order": 10
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
profile_iduuidYesRegime
kindtextYesKind
Allowed: Income tax on slabs Social contribution Employer cost
codetextYesCode
nametextNoName
basetextNoWorked out on
Allowed: gross taxable basic
employee_ratenumericNoEmployee rate %
employer_ratenumericNoEmployer rate %
wage_floor_monthlynumericNoMonthly wage floor
wage_ceiling_monthlynumericNoMonthly wage ceiling
annual_allowancenumericNoTax-free allowance a year
annual_rebatenumericNoTax rebate a year
gl_account_notextNoGL account
sort_orderintegerNoOrder
is_activebooleanNoActive

Sample body

{
  "profile_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "kind": "Income tax on slabs",
  "code": "COD-000001",
  "name": "Example",
  "base": "gross",
  "employee_rate": "1250.00",
  "employer_rate": "1250.00"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "profile_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "kind": "Income tax on slabs",
  "code": "COD-000001",
  "name": "Example",
  "base": "gross",
  "employee_rate": "1250.00",
  "employer_rate": "1250.00",
  "wage_floor_monthly": "1250.00",
  "wage_ceiling_monthly": "1250.00",
  "annual_allowance": "1250.00",
  "annual_rebate": "1250.00",
  "gl_account_no": "GL-000001",
  "sort_order": 10
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/regime-components" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"profile_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","kind":"Income tax on slabs","code":"COD-000001","name":"Example","base":"gross","employee_rate":"1250.00","employer_rate":"1250.00"}'
PUT/api/hrms/regime-components/{id}Change a regime components

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
profile_iduuidYesRegime
kindtextYesKind
Allowed: Income tax on slabs Social contribution Employer cost
codetextYesCode
nametextNoName
basetextNoWorked out on
Allowed: gross taxable basic
employee_ratenumericNoEmployee rate %
employer_ratenumericNoEmployer rate %
wage_floor_monthlynumericNoMonthly wage floor
wage_ceiling_monthlynumericNoMonthly wage ceiling
annual_allowancenumericNoTax-free allowance a year
annual_rebatenumericNoTax rebate a year
gl_account_notextNoGL account
sort_orderintegerNoOrder
is_activebooleanNoActive

Sample body

{
  "profile_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "kind": "Income tax on slabs"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "profile_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "kind": "Income tax on slabs",
  "code": "COD-000001",
  "name": "Example",
  "base": "gross",
  "employee_rate": "1250.00",
  "employer_rate": "1250.00",
  "wage_floor_monthly": "1250.00",
  "wage_ceiling_monthly": "1250.00",
  "annual_allowance": "1250.00",
  "annual_rebate": "1250.00",
  "gl_account_no": "GL-000001",
  "sort_order": 10
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/regime-components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"profile_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","kind":"Income tax on slabs"}'
DELETE/api/hrms/regime-components/{id}Delete a regime components

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-components/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/regime-components/{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/regime-components/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 regime components, 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
profile_iduuidread, writeRegime
kindtextread, writeKind
Allowed: Income tax on slabs Social contribution Employer cost
codetextread, writeCode
nametextread, writeName
basetextread, writeWorked out on
Allowed: gross taxable basic
employee_ratenumericread, writeEmployee rate %
employer_ratenumericread, writeEmployer rate %
wage_floor_monthlynumericread, writeMonthly wage floor
wage_ceiling_monthlynumericread, writeMonthly wage ceiling
annual_allowancenumericread, writeTax-free allowance a year
annual_rebatenumericread, writeTax rebate a year
gl_account_notextread, writeGL account
sort_orderintegerread, writeOrder
is_activebooleanread, writeActive
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 › Regime Components 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.