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.
/api/ats/placementsPublished as /api/v1/placementsOverview
| Package | Talent & Contingent Workforce |
|---|---|
| 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 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. |
| Table | ats.placements · 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
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/ats/placementsList placements
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",
"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
| Name | Type | Description |
|---|---|---|
id | string (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.
| Field | Type | Required | Description |
|---|---|---|---|
location_id | uuid | No | Office |
job_order_id | uuid | No | Job order |
submission_id | uuid | No | Submission id |
offer_id | uuid | No | Offer id |
candidate_id | uuid | Yes | Worker |
client_id | uuid | Yes | Client |
msp_program_id | uuid | No | Programme |
placement_type | text | No | Engagement type |
employment_classification | text | No | Worker classification — Decides how the worker is paid: an employee joins a payroll run; a contractor or corp-to-corp becomes a payable. |
supplier_id | uuid | No | Supplied by |
job_title | text | No | Role title |
start_date | date | Yes | Starts |
end_date | date | No | Ends |
actual_end_date | date | No | Actually ended |
status | text | No | Status |
currency | text | No | Currency |
rate_unit | text | No | Rate unit Allowed: hour day week month year fixed |
bill_rate | numeric | No | Bill rate |
pay_rate | numeric | No | Pay rate |
ot_bill_rate | numeric | No | Overtime bill rate |
ot_pay_rate | numeric | No | Overtime pay rate |
burden_pct | numeric | No | Employer burden % |
msp_fee_pct | numeric | No | Programme fee % |
hours_per_week | numeric | No | Hours a week |
annual_salary | numeric | No | Annual salary |
placement_fee | numeric | No | Placement fee |
fee_pct | numeric | No | Fee % |
guarantee_days | integer | No | Guarantee (days) |
work_order_id | uuid | No | Work order |
client_po_no | text | No | Client PO number |
employee_id | uuid | No | Employee record |
recruiter_id | uuid | No | Recruiter |
account_manager_id | uuid | No | Account manager |
cost_center_id | uuid | No | Cost center |
termination_reason | text | No | Termination reason |
termination_notice_date | date | No | Termination notice date |
external_ref | text | No | Reference over there |
notes | text | No | Notes |
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
| 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 |
|---|---|---|---|
location_id | uuid | No | Office |
job_order_id | uuid | No | Job order |
submission_id | uuid | No | Submission id |
offer_id | uuid | No | Offer id |
candidate_id | uuid | Yes | Worker |
client_id | uuid | Yes | Client |
msp_program_id | uuid | No | Programme |
placement_type | text | No | Engagement type |
employment_classification | text | No | Worker classification — Decides how the worker is paid: an employee joins a payroll run; a contractor or corp-to-corp becomes a payable. |
supplier_id | uuid | No | Supplied by |
job_title | text | No | Role title |
start_date | date | Yes | Starts |
end_date | date | No | Ends |
actual_end_date | date | No | Actually ended |
status | text | No | Status |
currency | text | No | Currency |
rate_unit | text | No | Rate unit Allowed: hour day week month year fixed |
bill_rate | numeric | No | Bill rate |
pay_rate | numeric | No | Pay rate |
ot_bill_rate | numeric | No | Overtime bill rate |
ot_pay_rate | numeric | No | Overtime pay rate |
burden_pct | numeric | No | Employer burden % |
msp_fee_pct | numeric | No | Programme fee % |
hours_per_week | numeric | No | Hours a week |
annual_salary | numeric | No | Annual salary |
placement_fee | numeric | No | Placement fee |
fee_pct | numeric | No | Fee % |
guarantee_days | integer | No | Guarantee (days) |
work_order_id | uuid | No | Work order |
client_po_no | text | No | Client PO number |
employee_id | uuid | No | Employee record |
recruiter_id | uuid | No | Recruiter |
account_manager_id | uuid | No | Account manager |
cost_center_id | uuid | No | Cost center |
termination_reason | text | No | Termination reason |
termination_notice_date | date | No | Termination notice date |
external_ref | text | No | Reference over there |
notes | text | No | Notes |
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
| 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/ats/placements/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/ats/placements/{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/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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (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
| 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):
endDate*, billRate, payRate, 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/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
| 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):
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
| 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):
conversionDate, annualSalary, conversionFee, employeeNoResponse
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
| 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/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.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
location_id | uuid | read, write | Office |
placement_no | text | read only | Placement no |
job_order_id | uuid | read, write | Job order |
submission_id | uuid | read, write | Submission id |
offer_id | uuid | read, write | Offer id |
candidate_id | uuid | read, write | Worker |
client_id | uuid | read, write | Client |
msp_program_id | uuid | read, write | Programme |
placement_type | text | read, write | Engagement type |
employment_classification | text | read, write | Worker classification — Decides how the worker is paid: an employee joins a payroll run; a contractor or corp-to-corp becomes a payable. |
supplier_id | uuid | read, write | Supplied by |
job_title | text | read, write | Role title |
start_date | date | read, write | Starts |
end_date | date | read, write | Ends |
actual_end_date | date | read, write | Actually ended |
status | text | read, write | Status |
currency | text | read, write | Currency |
rate_unit | text | read, write | Rate unit Allowed: hour day week month year fixed |
bill_rate | numeric | read, write | Bill rate |
pay_rate | numeric | read, write | Pay rate |
ot_bill_rate | numeric | read, write | Overtime bill rate |
ot_pay_rate | numeric | read, write | Overtime pay rate |
burden_pct | numeric | read, write | Employer burden % |
msp_fee_pct | numeric | read, write | Programme fee % |
gross_margin_amount | numeric | read only | Gross margin amount |
gross_margin_pct | numeric | read only | Gross margin pct |
net_margin_amount | numeric | read only | Net margin amount |
hours_per_week | numeric | read, write | Hours a week |
annual_salary | numeric | read, write | Annual salary |
placement_fee | numeric | read, write | Placement fee |
fee_pct | numeric | read, write | Fee % |
guarantee_days | integer | read, write | Guarantee (days) |
conversion_date | date | read only | Conversion date |
conversion_fee | numeric | read only | Conversion fee |
work_order_id | uuid | read, write | Work order |
client_po_no | text | read, write | Client PO number |
employee_id | uuid | read, write | Employee record |
recruiter_id | uuid | read, write | Recruiter |
account_manager_id | uuid | read, write | Account manager |
cost_center_id | uuid | read, write | Cost center |
termination_reason | text | read, write | Termination reason |
termination_notice_date | date | read, write | Termination notice date |
external_ref | text | read, write | Reference over there |
notes | text | read, write | Notes |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
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 |
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 Talent & Contingent Workforce › Placements 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.