TRANXACT.AI Help

Talent & Contingent Workforce · Workers on Assignment

Work Orders

The client’s authority to spend, with a ceiling on it. Hours worked past the budget are hours nobody will pay for, which is why the spend is tracked here.

Type REST6 operationsBase path /api/ats/work-ordersPublished as /api/v1/work-orders

Download specification (OpenAPI 3.1) Screen: Work Orders

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 › Work Orders 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.work_orders · 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

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

GET/api/ats/work-ordersList work orders

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",
      "work_order_no": "WOR-000001",
      "title": "Example",
      "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "sow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "work_order_type": "staffing",
      "start_date": "2026-10-30",
      "end_date": "2026-10-30",
      "currency": "USD",
      "budget_amount": "1250.00",
      "spend_to_date": "1250.00"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "work_order_no": "WOR-000001",
  "title": "Example",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_order_type": "staffing",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "currency": "USD",
  "budget_amount": "1250.00",
  "spend_to_date": "1250.00"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
titletextYesTitle
client_iduuidYesClient
msp_program_iduuidNoProgramme
placement_iduuidNoPlacement
sow_iduuidNoStatement of work
work_order_typetextNoType
Allowed: staffing sow services payrolling
start_datedateNoFrom
end_datedateNoTo
currencytextNoCurrency
budget_amountnumericNoBudget
max_hoursnumericNoHours ceiling
po_numbertextNoPO number
approvertextNoApproved by
approved_attimestamp with time zoneNoApproved
statustextNoStatus
Allowed: draft pending_approval approved active exhausted closed cancelled
external_reftextNoReference over there
notestextNoNotes

Sample body

{
  "title": "Example",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_order_type": "staffing"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_order_no": "WOR-000001",
  "title": "Example",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_order_type": "staffing",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "currency": "USD",
  "budget_amount": "1250.00",
  "spend_to_date": "1250.00"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/ats/work-orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Example","client_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","msp_program_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","placement_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","sow_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","work_order_type":"staffing"}'
PUT/api/ats/work-orders/{id}Change a work orders

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
titletextYesTitle
client_iduuidYesClient
msp_program_iduuidNoProgramme
placement_iduuidNoPlacement
sow_iduuidNoStatement of work
work_order_typetextNoType
Allowed: staffing sow services payrolling
start_datedateNoFrom
end_datedateNoTo
currencytextNoCurrency
budget_amountnumericNoBudget
max_hoursnumericNoHours ceiling
po_numbertextNoPO number
approvertextNoApproved by
approved_attimestamp with time zoneNoApproved
statustextNoStatus
Allowed: draft pending_approval approved active exhausted closed cancelled
external_reftextNoReference over there
notestextNoNotes

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_order_no": "WOR-000001",
  "title": "Example",
  "client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "msp_program_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "placement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "sow_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_order_type": "staffing",
  "start_date": "2026-10-30",
  "end_date": "2026-10-30",
  "currency": "USD",
  "budget_amount": "1250.00",
  "spend_to_date": "1250.00"
}

Sample request

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

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/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/work-orders/{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/work-orders/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 work orders, 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
work_order_notextread onlyWork order no
titletextread, writeTitle
client_iduuidread, writeClient
msp_program_iduuidread, writeProgramme
placement_iduuidread, writePlacement
sow_iduuidread, writeStatement of work
work_order_typetextread, writeType
Allowed: staffing sow services payrolling
start_datedateread, writeFrom
end_datedateread, writeTo
currencytextread, writeCurrency
budget_amountnumericread, writeBudget
spend_to_datenumericread onlySpend to date
max_hoursnumericread, writeHours ceiling
hours_to_datenumericread onlyHours to date
po_numbertextread, writePO number
approvertextread, writeApproved by
approved_attimestamp with time zoneread, writeApproved
statustextread, writeStatus
Allowed: draft pending_approval approved active exhausted closed cancelled
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 › Work Orders 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.