HRMS · Leave
Leave Balances
Everything earned, less what has been taken and what is asked for but not yet decided.
/api/hrms/leave-balancesPublished as /api/v1/leave-balancesOverview
| 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 › Leave Balances 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.leave_entitlement · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The 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/leave-balancesList leave balances
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",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"leave_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"leave_year": 10,
"employee_no": "EMP-000001",
"employee_name": "Example",
"leave_code": "LEA-000001",
"leave_name": "Example",
"category": "text",
"unit": "text",
"accrual_method": "text",
"max_carryover": "1250.00",
"max_balance": "1250.00",
"opening_balance": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/leave-balances?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/leave-balances/{id}Read one leave balances
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",
"employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"leave_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"leave_year": 10,
"employee_no": "EMP-000001",
"employee_name": "Example",
"leave_code": "LEA-000001",
"leave_name": "Example",
"category": "text",
"unit": "text",
"accrual_method": "text",
"max_carryover": "1250.00",
"max_balance": "1250.00",
"opening_balance": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/leave-balances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/leave-balancesPost leave balances
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/leave-balances" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/leave-balances/{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/leave-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/leave-balances/{id}Put leave balances
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/leave-balances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/hrms/leave-balances/{id}Delete leave balances
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/leave-balances/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a leave balances, 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 |
employee_id | uuid | read only | Employee id |
leave_type_id | uuid | read only | Leave type id |
leave_year | integer | read only | Leave year |
employee_no | text | read only | Employee no |
employee_name | text | read only | Employee name |
leave_code | text | read only | Leave code |
leave_name | text | read only | Leave name |
category | text | read only | Category |
unit | text | read only | Unit |
accrual_method | text | read only | Accrual method |
max_carryover | numeric | read only | Max carryover |
max_balance | numeric | read only | Max balance |
opening_balance | numeric | read only | Opening balance |
carried_over | numeric | read only | Carried over |
accrued | numeric | read only | Accrued |
adjusted | numeric | read only | Adjusted |
taken | numeric | read only | Taken |
pending | numeric | read only | Pending |
forfeited | numeric | read only | Forfeited |
available | numeric | read only | Available |
standing | text | read only | Standing |
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 › Leave Balances 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.