TRANXACT.AI Help

HRMS · US Employment Forms

FMLA Cases

Family and Medical Leave Act requests: eligibility when asked, the certification, your designation, and the hours used against the 12-week (or 26-week) entitlement. Designating here also decides the request in the self-service inbox. Medical certifications are filed on the case, not on the employee file.

Type REST15 operationsBase path /api/hrms/fmla-casesPublished as /api/v1/fmla-cases

Download specification (OpenAPI 3.1) Screen: FMLA Cases

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 Cases 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_cases · kept per company (and organisational unit where it has one)
RecordRead only; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

15 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/hrms/fmla-casesList fmla cases

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",
      "case_no": "CAS-000001",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "reason": "text",
      "family_relation": "text",
      "leave_pattern": "text",
      "start_date": "2026-10-30",
      "end_date": "2026-10-30",
      "reduced_hours_per_week": "1250.00",
      "intermittent_estimate": "text",
      "employee_note": "text",
      "status": "draft",
      "eligible": true
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/hrms/fmla-cases?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/fmla-cases/{id}Read one fmla case

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",
  "case_no": "CAS-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "reason": "text",
  "family_relation": "text",
  "leave_pattern": "text",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "reduced_hours_per_week": "1250.00",
  "intermittent_estimate": "text",
  "employee_note": "text",
  "status": "draft",
  "eligible": true
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/hrms/fmla-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/fmla-cases/eligibilityEligibility

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/fmla-cases/eligibility" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/fmla-cases/startStart

Request body

The keys this action reads (* = required; "one of" lists the only values):

employeeId, employee_id, reason, familyRelation, family_relation, leavePattern, leave_pattern, startDate, start_date, endDate, end_date, reducedHoursPerWeek, reduced_hours_per_week, intermittentEstimate, note

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-cases/start" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employeeId":"value","employee_id":"value","reason":"value","familyRelation":"value","family_relation":"value","leavePattern":"value"}'
POST/api/hrms/fmla-cases/{id}/designateDesignate

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):

approve, decision, note, comment

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-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/designate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"approve":"value","decision":"value","note":"value","comment":"value"}'
POST/api/hrms/fmla-cases/{id}/certificationCertification

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):

status, file, note; status one of received|complete|insufficient|not_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/fmla-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/certification" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"status":"value","file":"value","note;":"value"}'
GET/api/hrms/fmla-cases/{id}/usageUsage

Path parameters

NameTypeDescription
idstring (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/fmla-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/usage" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/fmla-cases/{id}/usageUsage

Path parameters

NameTypeDescription
idstring (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 POST "https://demo.tranxact.ai/api/hrms/fmla-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/usage" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/fmla-cases/{id}/usage/{usageId}/voidUsage void

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.
usageIdstring (uuid)The record's usageId, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

reason

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-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/usage/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/void" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"value"}'
POST/api/hrms/fmla-cases/{id}/closeClose

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):

note

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-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"note":"value"}'
GET/api/hrms/fmla-cases/{id}/notice/{which}Notice

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.
whichstring (uuid)The record's which, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/hrms/fmla-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/notice/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/fmla-casesPost fmla cases

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/fmla-cases" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/fmla-cases/{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-cases/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/fmla-cases/{id}Put fmla cases

Path parameters

NameTypeDescription
idstring (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/fmla-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/hrms/fmla-cases/{id}Delete fmla cases

Path parameters

NameTypeDescription
idstring (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/fmla-cases/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a fmla case, 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
case_notextread onlyCase no
employee_iduuidread onlyEmployee id
reasontextread onlyReason
family_relationtextread onlyFamily relation
leave_patterntextread onlyLeave pattern
start_datedateread onlyStart date
end_datedateread onlyEnd date
reduced_hours_per_weeknumericread onlyReduced hours per week
intermittent_estimatetextread onlyIntermittent estimate
employee_notetextread onlyEmployee note
statustextread onlyStatus
eligiblebooleanread onlyEligible
eligibilityjsonbread onlyEligibility
hours_per_weeknumericread onlyHours per week
entitlement_hoursnumericread onlyEntitlement hours
certification_duedateread onlyCertification due
certification_document_iduuidread onlyCertification document id
certification_received_attimestamp with time zoneread onlyCertification received at
certification_statustextread onlyCertification status
eligibility_notice_iduuidread onlyEligibility notice id
designation_notice_iduuidread onlyDesignation notice id
designated_byuuidread onlyDesignated by
designated_attimestamp with time zoneread onlyDesignated at
decision_notetextread onlyDecision note
requested_byuuidread onlyRequested by
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 Cases 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.