TRANXACT.AI Help

Talent & Contingent Workforce · Pipeline

Placement Offers

The terms put to a candidate. Accepting one is what creates the assignment, its work order and its compliance checklist.

Type REST7 operationsBase path /api/ats/offersPublished as /api/v1/offers

Download specification (OpenAPI 3.1) Screen: Placement Offers

Overview

PackageTalent & Contingent Workforce
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 Talent & Contingent Workforce › Placement 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.
Tableats.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

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

GET/api/ats/offersList placement 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",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "offer_no": "OFF-000001",
      "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "offer_type": "text",
      "employment_classification": "text",
      "currency": "USD",
      "rate_unit": "hour",
      "bill_rate": "1250.00",
      "pay_rate": "1250.00",
      "salary": "1250.00",
      "fee_amount": "1250.00",
      "start_date": "2026-10-30",
      "end_date": "2026-10-30"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/ats/offers?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ats/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",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_no": "OFF-000001",
  "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_type": "text",
  "employment_classification": "text",
  "currency": "USD",
  "rate_unit": "hour",
  "bill_rate": "1250.00",
  "pay_rate": "1250.00",
  "salary": "1250.00",
  "fee_amount": "1250.00",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
submission_iduuidYesSubmission
offer_typetextNoType
employment_classificationtextNoWorker classification
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
bill_ratenumericNoBill rate
pay_ratenumericNoPay rate
salarynumericNoSalary
fee_amountnumericNoPlacement fee
start_datedateNoStarts
end_datedateNoEnds
expiry_datedateNoOffer expires
statustextNoStatus
Allowed: draft approved sent accepted declined expired rescinded cancelled
sent_attimestamp with time zoneNoSent
responded_attimestamp with time zoneNoResponded
decline_reasontextNoDecline reason
termstextNoTerms
notestextNoNotes

Sample body

{
  "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_type": "text",
  "employment_classification": "text",
  "currency": "USD",
  "rate_unit": "hour"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_no": "OFF-000001",
  "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_type": "text",
  "employment_classification": "text",
  "currency": "USD",
  "rate_unit": "hour",
  "bill_rate": "1250.00",
  "pay_rate": "1250.00",
  "salary": "1250.00",
  "fee_amount": "1250.00",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ats/offers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"submission_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","offer_type":"text","employment_classification":"text","currency":"USD","rate_unit":"hour"}'
PUT/api/ats/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
submission_iduuidYesSubmission
offer_typetextNoType
employment_classificationtextNoWorker classification
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
bill_ratenumericNoBill rate
pay_ratenumericNoPay rate
salarynumericNoSalary
fee_amountnumericNoPlacement fee
start_datedateNoStarts
end_datedateNoEnds
expiry_datedateNoOffer expires
statustextNoStatus
Allowed: draft approved sent accepted declined expired rescinded cancelled
sent_attimestamp with time zoneNoSent
responded_attimestamp with time zoneNoResponded
decline_reasontextNoDecline reason
termstextNoTerms
notestextNoNotes

Sample body

{
  "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_type": "text"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_no": "OFF-000001",
  "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_type": "text",
  "employment_classification": "text",
  "currency": "USD",
  "rate_unit": "hour",
  "bill_rate": "1250.00",
  "pay_rate": "1250.00",
  "salary": "1250.00",
  "fee_amount": "1250.00",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ats/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"submission_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","offer_type":"text"}'
DELETE/api/ats/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/ats/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/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/ats/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
POST/api/ats/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):

startDate, burdenPct, workOrder, poNumber

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/ats/offers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/accept" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"startDate":"value","burdenPct":"value","workOrder":"value","poNumber":"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
org_unit_iduuidread onlyOrg unit id
offer_notextread onlyOffer no
submission_iduuidread, writeSubmission
offer_typetextread, writeType
employment_classificationtextread, writeWorker classification
currencytextread, writeCurrency
rate_unittextread, writeRate unit
Allowed: hour day week month year fixed
bill_ratenumericread, writeBill rate
pay_ratenumericread, writePay rate
salarynumericread, writeSalary
fee_amountnumericread, writePlacement fee
start_datedateread, writeStarts
end_datedateread, writeEnds
expiry_datedateread, writeOffer expires
statustextread, writeStatus
Allowed: draft approved sent accepted declined expired rescinded cancelled
sent_attimestamp with time zoneread, writeSent
responded_attimestamp with time zoneread, writeResponded
decline_reasontextread, writeDecline reason
termstextread, writeTerms
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
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 Talent & Contingent Workforce › Placement 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.