HRMS · US Employment Forms
FMLA Settings
How this company applies FMLA: the entitlement, the 12-month method (one for everybody), whether paid leave runs at the same time, the eligibility rule, and whether the worksite has 50 employees within 75 miles.
/api/hrms/fmla-settingsPublished as /api/v1/fmla-settingsOverview
| 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 › FMLA Settings 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.fmla_settings · 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
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/fmla-settingsList fmla settings
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"entitlement_weeks": "1250.00",
"caregiver_weeks": "1250.00",
"year_method": "Calendar year",
"fixed_year_start": "text",
"concurrent_paid_leave": true,
"min_service_months": 10,
"min_hours": "1250.00",
"worksite_50_in_75": true,
"default_hours_per_week": "1250.00",
"certification_days": 10,
"leave_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hr_contact": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/fmla-settings?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/fmla-settings/{id}Read one fmla settings
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",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"entitlement_weeks": "1250.00",
"caregiver_weeks": "1250.00",
"year_method": "Calendar year",
"fixed_year_start": "text",
"concurrent_paid_leave": true,
"min_service_months": 10,
"min_hours": "1250.00",
"worksite_50_in_75": true,
"default_hours_per_week": "1250.00",
"certification_days": 10,
"leave_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hr_contact": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/fmla-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/fmla-settingsCreate a fmla settings
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
entitlement_weeks | numeric | No | Entitlement (weeks) |
caregiver_weeks | numeric | No | Military caregiver entitlement (weeks) |
year_method | text | No | 12-month method Allowed: Calendar year A fixed leave year 12 months forward from the first day of FMLA leave 12 months back from each day of leave |
fixed_year_start | text | No | Leave year starts (MM-DD) |
concurrent_paid_leave | boolean | No | Paid leave runs at the same time as FMLA leave |
min_service_months | integer | No | Months of service needed |
min_hours | numeric | No | Hours worked in the last 12 months needed |
worksite_50_in_75 | boolean | No | The worksite has 50 or more employees within 75 miles |
default_hours_per_week | numeric | No | Workweek when an employee has none recorded (hours) |
certification_days | integer | No | Days to return the certification |
leave_type_id | uuid | No | Leave plan FMLA leave is booked on |
hr_contact | text | No | HR contact on the notices |
notes | text | No | Notes |
Sample body
{
"entitlement_weeks": "1250.00",
"caregiver_weeks": "1250.00",
"year_method": "Calendar year",
"fixed_year_start": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"entitlement_weeks": "1250.00",
"caregiver_weeks": "1250.00",
"year_method": "Calendar year",
"fixed_year_start": "text",
"concurrent_paid_leave": true,
"min_service_months": 10,
"min_hours": "1250.00",
"worksite_50_in_75": true,
"default_hours_per_week": "1250.00",
"certification_days": 10,
"leave_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hr_contact": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/fmla-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"entitlement_weeks":"1250.00","caregiver_weeks":"1250.00","year_method":"Calendar year","fixed_year_start":"text"}'PUT/api/hrms/fmla-settings/{id}Change a fmla settings
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 |
|---|---|---|---|
entitlement_weeks | numeric | No | Entitlement (weeks) |
caregiver_weeks | numeric | No | Military caregiver entitlement (weeks) |
year_method | text | No | 12-month method Allowed: Calendar year A fixed leave year 12 months forward from the first day of FMLA leave 12 months back from each day of leave |
fixed_year_start | text | No | Leave year starts (MM-DD) |
concurrent_paid_leave | boolean | No | Paid leave runs at the same time as FMLA leave |
min_service_months | integer | No | Months of service needed |
min_hours | numeric | No | Hours worked in the last 12 months needed |
worksite_50_in_75 | boolean | No | The worksite has 50 or more employees within 75 miles |
default_hours_per_week | numeric | No | Workweek when an employee has none recorded (hours) |
certification_days | integer | No | Days to return the certification |
leave_type_id | uuid | No | Leave plan FMLA leave is booked on |
hr_contact | text | No | HR contact on the notices |
notes | text | No | Notes |
Sample body
{
"entitlement_weeks": "1250.00",
"caregiver_weeks": "1250.00"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"entitlement_weeks": "1250.00",
"caregiver_weeks": "1250.00",
"year_method": "Calendar year",
"fixed_year_start": "text",
"concurrent_paid_leave": true,
"min_service_months": 10,
"min_hours": "1250.00",
"worksite_50_in_75": true,
"default_hours_per_week": "1250.00",
"certification_days": 10,
"leave_type_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"hr_contact": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/fmla-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"entitlement_weeks":"1250.00","caregiver_weeks":"1250.00"}'DELETE/api/hrms/fmla-settings/{id}Delete a fmla settings
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/fmla-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/fmla-settings/{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/fmla-settings/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 fmla settings, 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 |
org_unit_id | uuid | read only | Org unit id |
entitlement_weeks | numeric | read, write | Entitlement (weeks) |
caregiver_weeks | numeric | read, write | Military caregiver entitlement (weeks) |
year_method | text | read, write | 12-month method Allowed: Calendar year A fixed leave year 12 months forward from the first day of FMLA leave 12 months back from each day of leave |
fixed_year_start | text | read, write | Leave year starts (MM-DD) |
concurrent_paid_leave | boolean | read, write | Paid leave runs at the same time as FMLA leave |
min_service_months | integer | read, write | Months of service needed |
min_hours | numeric | read, write | Hours worked in the last 12 months needed |
worksite_50_in_75 | boolean | read, write | The worksite has 50 or more employees within 75 miles |
default_hours_per_week | numeric | read, write | Workweek when an employee has none recorded (hours) |
certification_days | integer | read, write | Days to return the certification |
leave_type_id | uuid | read, write | Leave plan FMLA leave is booked on |
hr_contact | text | read, write | HR contact on the notices |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
updated_at | timestamp with time zone | read only | Updated at |
created_by | uuid | read only | Created by |
updated_by | uuid | read only | Updated by |
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 |
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 › FMLA Settings 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.