TRANXACT.AI Help

HRMS · Compensation

Equity Grants

Read and maintain equity grants records (hr.equity_grants).

Type REST6 operationsBase path /api/hrms/equity-grantsPublished as /api/v1/equity-grants

Download specification (OpenAPI 3.1) Screen: Equity Grants

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 › Equity Grants 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.equity_grants · 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/equity-grantsList equity grants

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",
      "grant_no": "GRA-000001",
      "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "instrument": "text",
      "grant_date": "2026-10-30",
      "units": "1250.00",
      "strike_price": "1250.00",
      "grant_price": "1250.00",
      "vest_start": "2026-10-30",
      "vest_months": 10,
      "cliff_months": 10,
      "vest_frequency": "monthly",
      "units_vested": "1250.00",
      "units_exercised": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grant_no": "GRA-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "instrument": "text",
  "grant_date": "2026-10-30",
  "units": "1250.00",
  "strike_price": "1250.00",
  "grant_price": "1250.00",
  "vest_start": "2026-10-30",
  "vest_months": 10,
  "cliff_months": 10,
  "vest_frequency": "monthly",
  "units_vested": "1250.00",
  "units_exercised": "1250.00"
}

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

Sample request

curl "https://demo.tranxact.ai/api/hrms/equity-grants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/equity-grantsCreate a equity grants

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
employee_iduuidYesEmployee
instrumenttextNoInstrument
grant_datedateYesGrant date
unitsnumericYesUnits
strike_pricenumericNoStrike price
grant_pricenumericNoGrant price
vest_startdateNoVesting starts
vest_monthsintegerNoVests over, months
cliff_monthsintegerNoCliff, months
vest_frequencytextNoVests
Allowed: monthly quarterly annual cliff_only
units_vestednumericNoUnits vested
expires_ondateNoExpires
statustextNoStatus

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grant_date": "2026-10-30",
  "units": "1250.00",
  "instrument": "text",
  "strike_price": "1250.00",
  "grant_price": "1250.00",
  "vest_start": "2026-10-30"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grant_no": "GRA-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "instrument": "text",
  "grant_date": "2026-10-30",
  "units": "1250.00",
  "strike_price": "1250.00",
  "grant_price": "1250.00",
  "vest_start": "2026-10-30",
  "vest_months": 10,
  "cliff_months": 10,
  "vest_frequency": "monthly",
  "units_vested": "1250.00",
  "units_exercised": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/hrms/equity-grants" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","grant_date":"2026-10-30","units":"1250.00","instrument":"text","strike_price":"1250.00","grant_price":"1250.00","vest_start":"2026-10-30"}'
PUT/api/hrms/equity-grants/{id}Change a equity grants

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
employee_iduuidYesEmployee
instrumenttextNoInstrument
grant_datedateYesGrant date
unitsnumericYesUnits
strike_pricenumericNoStrike price
grant_pricenumericNoGrant price
vest_startdateNoVesting starts
vest_monthsintegerNoVests over, months
cliff_monthsintegerNoCliff, months
vest_frequencytextNoVests
Allowed: monthly quarterly annual cliff_only
units_vestednumericNoUnits vested
expires_ondateNoExpires
statustextNoStatus

Sample body

{
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grant_date": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "grant_no": "GRA-000001",
  "employee_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "instrument": "text",
  "grant_date": "2026-10-30",
  "units": "1250.00",
  "strike_price": "1250.00",
  "grant_price": "1250.00",
  "vest_start": "2026-10-30",
  "vest_months": 10,
  "cliff_months": 10,
  "vest_frequency": "monthly",
  "units_vested": "1250.00",
  "units_exercised": "1250.00"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/hrms/equity-grants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"employee_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","grant_date":"2026-10-30"}'
DELETE/api/hrms/equity-grants/{id}Delete a equity grants

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/equity-grants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/equity-grants/{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/equity-grants/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 equity grants, 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
grant_notextread onlyGrant no
employee_iduuidread, writeEmployee
instrumenttextread, writeInstrument
grant_datedateread, writeGrant date
unitsnumericread, writeUnits
strike_pricenumericread, writeStrike price
grant_pricenumericread, writeGrant price
vest_startdateread, writeVesting starts
vest_monthsintegerread, writeVests over, months
cliff_monthsintegerread, writeCliff, months
vest_frequencytextread, writeVests
Allowed: monthly quarterly annual cliff_only
units_vestednumericread, writeUnits vested
units_exercisednumericread onlyUnits exercised
units_forfeitednumericread onlyUnits forfeited
expires_ondateread, writeExpires
statustextread, writeStatus
cycle_iduuidread onlyCycle id
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 › Equity Grants 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.