TRANXACT.AI Help

CRM · Service

Field Work Orders

Read and maintain work orders records (crm.work_orders).

Type REST17 operationsBase path /api/crm/work-ordersPublished as /api/v1/work-orders

Download specification (OpenAPI 3.1) Screen: Field Work Orders

Overview

PackageCRM
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 CRM › Field 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.
Tablecrm.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

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

GET/api/crm/work-ordersList field 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",
      "wo_no": "WO-000001",
      "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "work_type": "text",
      "priority": "text",
      "status": "open",
      "scheduled_at": "2026-10-30T09:00:00Z",
      "technician_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "summary": "text",
      "completion_notes": "text",
      "created_at": "2026-10-30T09:00:00Z",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/crm/work-orders?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/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",
  "wo_no": "WO-000001",
  "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_type": "text",
  "priority": "text",
  "status": "open",
  "scheduled_at": "2026-10-30T09:00:00Z",
  "technician_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "summary": "text",
  "completion_notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
case_iduuidNoCase id
account_iduuidYesAccount id
work_typetextNoWork type
prioritytextNoPriority
statustextNoStatus
Allowed: open scheduled dispatched in_progress completed cancelled
scheduled_attimestamp with time zoneNoScheduled
technician_iduuidNoTechnician
summarytextYesSummary
completion_notestextNoCompletion notes
required_skilltextNoSkill needed — Field dispatch sends a technician with this skill (Technician Skills).

Sample body

{
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "summary": "text",
  "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_type": "text",
  "priority": "text",
  "status": "open"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wo_no": "WO-000001",
  "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_type": "text",
  "priority": "text",
  "status": "open",
  "scheduled_at": "2026-10-30T09:00:00Z",
  "technician_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "summary": "text",
  "completion_notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/work-orders" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","summary":"text","case_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","work_type":"text","priority":"text","status":"open"}'
PUT/api/crm/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
case_iduuidNoCase id
account_iduuidYesAccount id
work_typetextNoWork type
prioritytextNoPriority
statustextNoStatus
Allowed: open scheduled dispatched in_progress completed cancelled
scheduled_attimestamp with time zoneNoScheduled
technician_iduuidNoTechnician
summarytextYesSummary
completion_notestextNoCompletion notes
required_skilltextNoSkill needed — Field dispatch sends a technician with this skill (Technician Skills).

Sample body

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

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "wo_no": "WO-000001",
  "case_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "work_type": "text",
  "priority": "text",
  "status": "open",
  "scheduled_at": "2026-10-30T09:00:00Z",
  "technician_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "summary": "text",
  "completion_notes": "text",
  "created_at": "2026-10-30T09:00:00Z",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "cost_center_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

Sample request

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

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/work-orders/{parentId}/tasksTasks

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/work-orders/{parentId}/tasks/{lineId}Tasks

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/work-orders/{parentId}/tasks/{lineId}Tasks

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/tasks/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/work-orders/{parentId}/partsParts

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parts" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/work-orders/{parentId}/partsParts

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parts" \
  -H "Authorization: Bearer $TOKEN"
PUT/api/crm/work-orders/{parentId}/parts/{lineId}Parts

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/work-orders/{parentId}/parts/{lineId}Parts

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

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parts" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/work-orders/{id}/partsParts

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/parts" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/work-orders/{id}/completeComplete

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

completionNotes

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/crm/work-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"completionNotes":"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
wo_notextread onlyWo no
case_iduuidread, writeCase id
account_iduuidread, writeAccount id
work_typetextread, writeWork type
prioritytextread, writePriority
statustextread, writeStatus
Allowed: open scheduled dispatched in_progress completed cancelled
scheduled_attimestamp with time zoneread, writeScheduled
technician_iduuidread, writeTechnician
summarytextread, writeSummary
completion_notestextread, writeCompletion notes
created_attimestamp with time zoneread onlyCreated at
org_unit_iduuidread onlyOrg unit id
cost_center_iduuidread onlyCost center id
profit_center_iduuidread onlyProfit center id
location_iduuidread onlyLocation id
warehouse_iduuidread onlyWarehouse 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
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
required_skilltextread, writeSkill needed — Field dispatch sends a technician with this skill (Technician Skills).

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 CRM › Field 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.