TRANXACT.AI Help

HRMS · Recruiting & Onboarding

Offers

Offers out to candidates, and where each one is in its approval and response cycle.

Type REST11 operationsBase path /api/hrms/offersPublished as /api/v1/offers

Download specification (OpenAPI 3.1) Screen: Offers

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 › 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.
Tablehr.offers · 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

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

GET/api/hrms/offersList offers

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

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

FieldTypeRequiredDescription
application_iduuidYesApplication id
position_iduuidNoPosition id
grade_iduuidNoGrade id
employment_typetextNoEmployment type
base_paynumericYesBase pay
pay_typetextNoPay type
Allowed: salary hourly
bonus_percentnumericNoBonus %
sign_on_bonusnumericNoSign-on bonus
equity_unitsnumericNoEquity units
start_datedateYesStart date
expires_ondateNoExpires on
justificationtextNoJustification — Required reading if the pay sits outside the grade range.
statustextNoStatus

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

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
application_iduuidYesApplication id
position_iduuidNoPosition id
grade_iduuidNoGrade id
employment_typetextNoEmployment type
base_paynumericYesBase pay
pay_typetextNoPay type
Allowed: salary hourly
bonus_percentnumericNoBonus %
sign_on_bonusnumericNoSign-on bonus
equity_unitsnumericNoEquity units
start_datedateYesStart date
expires_ondateNoExpires on
justificationtextNoJustification — Required reading if the pay sits outside the grade range.
statustextNoStatus

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

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/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/hrms/offers/{id}/letterLetter

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/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/letter" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/offers/{id}/approveApprove

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/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"
POST/api/hrms/offers/{id}/sendSend

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

templateId, letter_template_id, message

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/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

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

workCountry, workState*, employeeNo, signedByName, signatureMethod

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/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

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

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/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

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
offer_notextread onlyOffer no
application_iduuidread, writeApplication id
position_iduuidread, writePosition id
grade_iduuidread, writeGrade id
employment_typetextread, writeEmployment type
base_paynumericread, writeBase pay
pay_typetextread, writePay type
Allowed: salary hourly
currencytextread onlyCurrency
bonus_percentnumericread, writeBonus %
sign_on_bonusnumericread, writeSign-on bonus
equity_unitsnumericread, writeEquity units
start_datedateread, writeStart date
expires_ondateread, writeExpires on
compa_rationumericread onlyCompa ratio
outside_rangebooleanread onlyOutside range
justificationtextread, writeJustification — Required reading if the pay sits outside the grade range.
statustextread, writeStatus
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
sent_attimestamp with time zoneread onlySent at
responded_attimestamp with time zoneread onlyResponded at
decline_reasontextread onlyDecline reason
signed_attimestamp with time zoneread onlySigned at
signature_methodtextread onlySignature method
signed_by_nametextread onlySigned by name
hired_employee_iduuidread onlyHired employee id
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
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
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
letter_template_iduuidread onlyLetter template id
letter_bodytextread onlyLetter body
letter_document_iduuidread onlyLetter document id
esign_envelope_iduuidread onlyEsign envelope id
signed_document_iduuidread onlySigned document id
signature_statustextread onlySignature status

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 › Offers 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.