TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/hrms/fmla-settingsPublished as /api/v1/fmla-settings

Download specification (OpenAPI 3.1) Screen: FMLA Settings

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 › 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.
Tablehr.fmla_settings · kept per company (and organisational unit where it has one)
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/fmla-settingsList fmla settings

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",
      "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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
entitlement_weeksnumericNoEntitlement (weeks)
caregiver_weeksnumericNoMilitary caregiver entitlement (weeks)
year_methodtextNo12-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_starttextNoLeave year starts (MM-DD)
concurrent_paid_leavebooleanNoPaid leave runs at the same time as FMLA leave
min_service_monthsintegerNoMonths of service needed
min_hoursnumericNoHours worked in the last 12 months needed
worksite_50_in_75booleanNoThe worksite has 50 or more employees within 75 miles
default_hours_per_weeknumericNoWorkweek when an employee has none recorded (hours)
certification_daysintegerNoDays to return the certification
leave_type_iduuidNoLeave plan FMLA leave is booked on
hr_contacttextNoHR contact on the notices
notestextNoNotes

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

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
entitlement_weeksnumericNoEntitlement (weeks)
caregiver_weeksnumericNoMilitary caregiver entitlement (weeks)
year_methodtextNo12-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_starttextNoLeave year starts (MM-DD)
concurrent_paid_leavebooleanNoPaid leave runs at the same time as FMLA leave
min_service_monthsintegerNoMonths of service needed
min_hoursnumericNoHours worked in the last 12 months needed
worksite_50_in_75booleanNoThe worksite has 50 or more employees within 75 miles
default_hours_per_weeknumericNoWorkweek when an employee has none recorded (hours)
certification_daysintegerNoDays to return the certification
leave_type_iduuidNoLeave plan FMLA leave is booked on
hr_contacttextNoHR contact on the notices
notestextNoNotes

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

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/fmla-settings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/fmla-settings/{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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
entitlement_weeksnumericread, writeEntitlement (weeks)
caregiver_weeksnumericread, writeMilitary caregiver entitlement (weeks)
year_methodtextread, write12-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_starttextread, writeLeave year starts (MM-DD)
concurrent_paid_leavebooleanread, writePaid leave runs at the same time as FMLA leave
min_service_monthsintegerread, writeMonths of service needed
min_hoursnumericread, writeHours worked in the last 12 months needed
worksite_50_in_75booleanread, writeThe worksite has 50 or more employees within 75 miles
default_hours_per_weeknumericread, writeWorkweek when an employee has none recorded (hours)
certification_daysintegerread, writeDays to return the certification
leave_type_iduuidread, writeLeave plan FMLA leave is booked on
hr_contacttextread, writeHR contact on the notices
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
created_byuuidread onlyCreated by
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 › FMLA Settings 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.