HRMS · Leave
Holiday Calendars
The days off every leave request, timesheet, attendance check, pay date and due date counts. Each company starts with its own country’s public holidays and changes them here: add company holidays, move or rename one, remove one, or keep another calendar for a state, a business unit or a location. Dates marked estimated follow a lunar calendar — confirm them when they are announced.
/api/hrms/holiday-calendarsPublished as /api/v1/holiday-calendarsDownload specification (OpenAPI 3.1) Screen: Holiday Calendars
Overview
| Package | HRMS |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold HRMS › Holiday Calendars 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. |
| Table | hr.holiday_calendars · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
8 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/holiday-calendarsList holiday calendars
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"country": "US",
"region": "text",
"is_default": true,
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text",
"xf_num_1": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/holiday-calendars?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/holiday-calendars/{id}Read one holiday calendars
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"country": "US",
"region": "text",
"is_default": true,
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text",
"xf_num_1": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/holiday-calendars/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/holiday-calendarsCreate a holiday calendars
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code — e.g. IN-MH-PUNE, US-PLANT2 |
name | text | Yes | Name |
country | text | No | Country — Whose public holidays it follows. Its weekend is the country’s unless you set one below. |
region | text | No | State / region — A state’s own holidays as well as the country’s (India, the UK, Canada, Australia). Employees who work in this state keep this calendar unless one is chosen for them. |
is_default | boolean | No | Company default for its country — The calendar of everybody in this country no other calendar applies to. One per country. |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example",
"country": "US",
"region": "text",
"is_default": true,
"is_active": true
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"country": "US",
"region": "text",
"is_default": true,
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text",
"xf_num_1": "1250.00"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/holiday-calendars" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","country":"US","region":"text","is_default":true,"is_active":true}'PUT/api/hrms/holiday-calendars/{id}Change a holiday calendars
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code — e.g. IN-MH-PUNE, US-PLANT2 |
name | text | Yes | Name |
country | text | No | Country — Whose public holidays it follows. Its weekend is the country’s unless you set one below. |
region | text | No | State / region — A state’s own holidays as well as the country’s (India, the UK, Canada, Australia). Employees who work in this state keep this calendar unless one is chosen for them. |
is_default | boolean | No | Company default for its country — The calendar of everybody in this country no other calendar applies to. One per country. |
is_active | boolean | No | Active |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"country": "US",
"region": "text",
"is_default": true,
"is_active": true,
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"xf_text_1": "text",
"xf_text_2": "text",
"xf_text_3": "text",
"xf_text_4": "text",
"xf_text_5": "text",
"xf_num_1": "1250.00"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/holiday-calendars/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/hrms/holiday-calendars/{id}Delete a holiday calendars
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/holiday-calendars/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/holiday-calendars/{id}/holidaysHolidays
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/holiday-calendars/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/holidays" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/holiday-calendars/{id}/holidaysHolidays
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
holiday_date*, name, is_paid, hoursResponse
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/holiday-calendars/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/holidays" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"holiday_date":"value","name":"value","is_paid":"value","hours":"value"}'POST/api/hrms/holiday-calendars/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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, withLinesResponse
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/holiday-calendars/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 holiday calendars, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
code | text | read, write | Code — e.g. IN-MH-PUNE, US-PLANT2 |
name | text | read, write | Name |
country | text | read, write | Country — Whose public holidays it follows. Its weekend is the country’s unless you set one below. |
region | text | read, write | State / region — A state’s own holidays as well as the country’s (India, the UK, Canada, Australia). Employees who work in this state keep this calendar unless one is chosen for them. |
is_default | boolean | read, write | Company default for its country — The calendar of everybody in this country no other calendar applies to. One per country. |
is_active | boolean | read, write | Active |
org_unit_id | uuid | read only | For business unit — Everyone in this unit, and the units under it, keeps this calendar unless one is chosen for them. The company’s top unit is the whole company. |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold HRMS › Holiday Calendars for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused 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.