HRMS · Recruiting & Onboarding
Offers
Offers out to candidates, and where each one is in its approval and response cycle.
/api/hrms/offersPublished as /api/v1/offersOverview
| 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 › Offers 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.offers · 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
11 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/hrms/offersList offers
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",
"offer_no": "OFF-000001",
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employment_type": "text",
"base_pay": "1250.00",
"pay_type": "salary",
"currency": "USD",
"bonus_percent": "1250.00",
"sign_on_bonus": "1250.00",
"equity_units": "1250.00",
"start_date": "2026-10-30",
"expires_on": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/hrms/offers?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/offers/{id}Read one offers
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",
"offer_no": "OFF-000001",
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employment_type": "text",
"base_pay": "1250.00",
"pay_type": "salary",
"currency": "USD",
"bonus_percent": "1250.00",
"sign_on_bonus": "1250.00",
"equity_units": "1250.00",
"start_date": "2026-10-30",
"expires_on": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/hrms/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/offersCreate a offers
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
application_id | uuid | Yes | Application id |
position_id | uuid | No | Position id |
grade_id | uuid | No | Grade id |
employment_type | text | No | Employment type |
base_pay | numeric | Yes | Base pay |
pay_type | text | No | Pay type Allowed: salary hourly |
bonus_percent | numeric | No | Bonus % |
sign_on_bonus | numeric | No | Sign-on bonus |
equity_units | numeric | No | Equity units |
start_date | date | Yes | Start date |
expires_on | date | No | Expires on |
justification | text | No | Justification — Required reading if the pay sits outside the grade range. |
status | text | No | Status |
Sample body
{
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"base_pay": "1250.00",
"start_date": "2026-10-30",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employment_type": "text",
"pay_type": "salary"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"offer_no": "OFF-000001",
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employment_type": "text",
"base_pay": "1250.00",
"pay_type": "salary",
"currency": "USD",
"bonus_percent": "1250.00",
"sign_on_bonus": "1250.00",
"equity_units": "1250.00",
"start_date": "2026-10-30",
"expires_on": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/hrms/offers" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"application_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","base_pay":"1250.00","start_date":"2026-10-30","position_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","grade_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","employment_type":"text","pay_type":"salary"}'PUT/api/hrms/offers/{id}Change a offers
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 |
|---|---|---|---|
application_id | uuid | Yes | Application id |
position_id | uuid | No | Position id |
grade_id | uuid | No | Grade id |
employment_type | text | No | Employment type |
base_pay | numeric | Yes | Base pay |
pay_type | text | No | Pay type Allowed: salary hourly |
bonus_percent | numeric | No | Bonus % |
sign_on_bonus | numeric | No | Sign-on bonus |
equity_units | numeric | No | Equity units |
start_date | date | Yes | Start date |
expires_on | date | No | Expires on |
justification | text | No | Justification — Required reading if the pay sits outside the grade range. |
status | text | No | Status |
Sample body
{
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"base_pay": "1250.00"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"offer_no": "OFF-000001",
"application_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"position_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"grade_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"employment_type": "text",
"base_pay": "1250.00",
"pay_type": "salary",
"currency": "USD",
"bonus_percent": "1250.00",
"sign_on_bonus": "1250.00",
"equity_units": "1250.00",
"start_date": "2026-10-30",
"expires_on": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/hrms/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"application_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","base_pay":"1250.00"}'DELETE/api/hrms/offers/{id}Delete a offers
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/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/hrms/offers/{id}/letterLetter
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/letter" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/offers/{id}/approveApprove
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
-H "Authorization: Bearer $TOKEN"POST/api/hrms/offers/{id}/sendSend
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):
templateId, letter_template_id, messageResponse
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/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/send" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"templateId":"value","letter_template_id":"value","message":"value"}'POST/api/hrms/offers/{id}/acceptAccept
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):
workCountry, workState*, employeeNo, signedByName, signatureMethodResponse
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/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/accept" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"workCountry":"value","workState":"value","employeeNo":"value","signedByName":"value","signatureMethod":"value"}'POST/api/hrms/offers/{id}/declineDecline
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):
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/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/decline" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/hrms/offers/{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/offers/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 offers, 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 |
offer_no | text | read only | Offer no |
application_id | uuid | read, write | Application id |
position_id | uuid | read, write | Position id |
grade_id | uuid | read, write | Grade id |
employment_type | text | read, write | Employment type |
base_pay | numeric | read, write | Base pay |
pay_type | text | read, write | Pay type Allowed: salary hourly |
currency | text | read only | Currency |
bonus_percent | numeric | read, write | Bonus % |
sign_on_bonus | numeric | read, write | Sign-on bonus |
equity_units | numeric | read, write | Equity units |
start_date | date | read, write | Start date |
expires_on | date | read, write | Expires on |
compa_ratio | numeric | read only | Compa ratio |
outside_range | boolean | read only | Outside range |
justification | text | read, write | Justification — Required reading if the pay sits outside the grade range. |
status | text | read, write | Status |
approved_by | uuid | read only | Approved by |
approved_at | timestamp with time zone | read only | Approved at |
sent_at | timestamp with time zone | read only | Sent at |
responded_at | timestamp with time zone | read only | Responded at |
decline_reason | text | read only | Decline reason |
signed_at | timestamp with time zone | read only | Signed at |
signature_method | text | read only | Signature method |
signed_by_name | text | read only | Signed by name |
hired_employee_id | uuid | read only | Hired employee id |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
org_unit_id | uuid | read only | Org unit id |
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 |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
letter_template_id | uuid | read only | Letter template id |
letter_body | text | read only | Letter body |
letter_document_id | uuid | read only | Letter document id |
esign_envelope_id | uuid | read only | Esign envelope id |
signed_document_id | uuid | read only | Signed document id |
signature_status | text | read only | Signature status |
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 › Offers 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.