TRANXACT.AI Help

Talent & Contingent Workforce · Workers on Assignment

Placements

The assignment. Everything downstream hangs off it — the timesheet, the invoice, the pay record, the margin and the compliance clock.

Type REST14 operationsBase path /api/ats/placementsPublished as /api/v1/placements

Download specification (OpenAPI 3.1) Screen: Placements

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 › Placements 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.placements · 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

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

GET/api/ats/placementsList placements

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",
      "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "placement_no": "PLA-000001",
      "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "offer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "placement_type": "text",
      "employment_classification": "text",
      "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "job_title": "Example"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_no": "PLA-000001",
  "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_type": "text",
  "employment_classification": "text",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_title": "Example"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
location_iduuidNoOffice
job_order_iduuidNoJob order
submission_iduuidNoSubmission id
offer_iduuidNoOffer id
candidate_iduuidYesWorker
client_iduuidYesClient
msp_program_iduuidNoProgramme
placement_typetextNoEngagement type
employment_classificationtextNoWorker classification — Decides how the worker is paid: an employee joins a payroll run; a contractor or corp-to-corp becomes a payable.
supplier_iduuidNoSupplied by
job_titletextNoRole title
start_datedateYesStarts
end_datedateNoEnds
actual_end_datedateNoActually ended
statustextNoStatus
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
bill_ratenumericNoBill rate
pay_ratenumericNoPay rate
ot_bill_ratenumericNoOvertime bill rate
ot_pay_ratenumericNoOvertime pay rate
burden_pctnumericNoEmployer burden %
msp_fee_pctnumericNoProgramme fee %
hours_per_weeknumericNoHours a week
annual_salarynumericNoAnnual salary
placement_feenumericNoPlacement fee
fee_pctnumericNoFee %
guarantee_daysintegerNoGuarantee (days)
work_order_iduuidNoWork order
client_po_notextNoClient PO number
employee_iduuidNoEmployee record
recruiter_iduuidNoRecruiter
account_manager_iduuidNoAccount manager
cost_center_iduuidNoCost center
termination_reasontextNoTermination reason
termination_notice_datedateNoTermination notice date
external_reftextNoReference over there
notestextNoNotes

Sample body

{
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "start_date": "2026-10-30",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_no": "PLA-000001",
  "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_type": "text",
  "employment_classification": "text",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_title": "Example"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ats/placements" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"candidate_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","client_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","start_date":"2026-10-30","location_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","job_order_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","submission_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","offer_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
PUT/api/ats/placements/{id}Change a placements

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
location_iduuidNoOffice
job_order_iduuidNoJob order
submission_iduuidNoSubmission id
offer_iduuidNoOffer id
candidate_iduuidYesWorker
client_iduuidYesClient
msp_program_iduuidNoProgramme
placement_typetextNoEngagement type
employment_classificationtextNoWorker classification — Decides how the worker is paid: an employee joins a payroll run; a contractor or corp-to-corp becomes a payable.
supplier_iduuidNoSupplied by
job_titletextNoRole title
start_datedateYesStarts
end_datedateNoEnds
actual_end_datedateNoActually ended
statustextNoStatus
currencytextNoCurrency
rate_unittextNoRate unit
Allowed: hour day week month year fixed
bill_ratenumericNoBill rate
pay_ratenumericNoPay rate
ot_bill_ratenumericNoOvertime bill rate
ot_pay_ratenumericNoOvertime pay rate
burden_pctnumericNoEmployer burden %
msp_fee_pctnumericNoProgramme fee %
hours_per_weeknumericNoHours a week
annual_salarynumericNoAnnual salary
placement_feenumericNoPlacement fee
fee_pctnumericNoFee %
guarantee_daysintegerNoGuarantee (days)
work_order_iduuidNoWork order
client_po_notextNoClient PO number
employee_iduuidNoEmployee record
recruiter_iduuidNoRecruiter
account_manager_iduuidNoAccount manager
cost_center_iduuidNoCost center
termination_reasontextNoTermination reason
termination_notice_datedateNoTermination notice date
external_reftextNoReference over there
notestextNoNotes

Sample body

{
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "location_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_no": "PLA-000001",
  "job_order_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "submission_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "offer_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "candidate_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_type": "text",
  "employment_classification": "text",
  "supplier_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "job_title": "Example"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/ats/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"candidate_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","client_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'
DELETE/api/ats/placements/{id}Delete a placements

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/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/placements/{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/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
GET/api/ats/placements/{parentId}/ratesRates

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ats/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rates" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/placements/{parentId}/ratesRates

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, 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/ats/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rates" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/ats/placements/{parentId}/rates/{lineId}Rates

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/ats/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/ats/placements/{parentId}/rates/{lineId}Rates

Path parameters

NameTypeDescription
parentIdstring (uuid)The record's parentId, as a list returns it.
lineIdstring (uuid)The record's lineId, 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/ats/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rates/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/placements/{id}/extendExtend

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

endDate*, billRate, payRate, 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/ats/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/extend" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"endDate":"value","billRate":"value","payRate":"value","reason":"value"}'
POST/api/ats/placements/{id}/terminateTerminate

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

force, completed, endDate, 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/ats/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/terminate" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"force":"value","completed":"value","endDate":"value","reason":"value"}'
POST/api/ats/placements/{id}/convertConvert

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

conversionDate, annualSalary, conversionFee, employeeNo

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/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/convert" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"conversionDate":"value","annualSalary":"value","conversionFee":"value","employeeNo":"value"}'
POST/api/ats/placements/{id}/compliance-checklistCompliance checklist

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/ats/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/compliance-checklist" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a placements, 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
location_iduuidread, writeOffice
placement_notextread onlyPlacement no
job_order_iduuidread, writeJob order
submission_iduuidread, writeSubmission id
offer_iduuidread, writeOffer id
candidate_iduuidread, writeWorker
client_iduuidread, writeClient
msp_program_iduuidread, writeProgramme
placement_typetextread, writeEngagement type
employment_classificationtextread, writeWorker classification — Decides how the worker is paid: an employee joins a payroll run; a contractor or corp-to-corp becomes a payable.
supplier_iduuidread, writeSupplied by
job_titletextread, writeRole title
start_datedateread, writeStarts
end_datedateread, writeEnds
actual_end_datedateread, writeActually ended
statustextread, writeStatus
currencytextread, writeCurrency
rate_unittextread, writeRate unit
Allowed: hour day week month year fixed
bill_ratenumericread, writeBill rate
pay_ratenumericread, writePay rate
ot_bill_ratenumericread, writeOvertime bill rate
ot_pay_ratenumericread, writeOvertime pay rate
burden_pctnumericread, writeEmployer burden %
msp_fee_pctnumericread, writeProgramme fee %
gross_margin_amountnumericread onlyGross margin amount
gross_margin_pctnumericread onlyGross margin pct
net_margin_amountnumericread onlyNet margin amount
hours_per_weeknumericread, writeHours a week
annual_salarynumericread, writeAnnual salary
placement_feenumericread, writePlacement fee
fee_pctnumericread, writeFee %
guarantee_daysintegerread, writeGuarantee (days)
conversion_datedateread onlyConversion date
conversion_feenumericread onlyConversion fee
work_order_iduuidread, writeWork order
client_po_notextread, writeClient PO number
employee_iduuidread, writeEmployee record
recruiter_iduuidread, writeRecruiter
account_manager_iduuidread, writeAccount manager
cost_center_iduuidread, writeCost center
termination_reasontextread, writeTermination reason
termination_notice_datedateread, writeTermination notice date
external_reftextread, writeReference over there
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 › Placements 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.