HRMS · Services and actions
Leave
The leave service of HRMS: 7 operation(s).
/api/hrms/leaveOverview
| 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 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/leave/balance/{employeeId}Balance
Path parameters
| Name | Type | Description |
|---|---|---|
employeeId | string (uuid) | The record's employeeId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/hrms/leave/balance/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/leave/accrueAccrue
Request body
The keys this action reads (* = required; "one of" lists the only values):
asOf, methodResponse
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/accrue" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"asOf":"value","method":"value"}'POST/api/hrms/leave/adjustAdjust
Request body
The keys this action reads (* = required; "one of" lists the only values):
employeeId*, leaveTypeId, quantity, reason, yearResponse
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/adjust" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employeeId":"value","leaveTypeId":"value","quantity":"value","reason":"value","year":"value"}'POST/api/hrms/leave/carry-overCarry over
Request body
The keys this action reads (* = required; "one of" lists the only values):
fromYearResponse
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/carry-over" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"fromYear":"value"}'POST/api/hrms/leave/expire-carry-overExpire carry over
Request body
The keys this action reads (* = required; "one of" lists the only values):
asOfResponse
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/expire-carry-over" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"asOf":"value"}'POST/api/hrms/leave/requestRequest
Request body
The keys this action reads (* = required; "one of" lists the only values):
employeeId*, leaveTypeId, startDate, endDate, notes, halfDayStart, halfDayEndResponse
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/request" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"employeeId":"value","leaveTypeId":"value","startDate":"value","endDate":"value","notes":"value","halfDayStart":"value"}'POST/api/hrms/leave/requests/{id}/decideRequests decide
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):
approve, reasonResponse
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/requests/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decide" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"approve":"value","reason":"value"}'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 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.