CRM · Utility Field Service
Utility Service Orders
Field work at a premise — start, stop, transfer, meter install or exchange, re-read, disconnect, reconnect, leak, high bill — assigned to a crew member and completed with the read or the new meter.
/api/crm/util-service-ordersPublished as /api/v1/util-service-ordersDownload specification (OpenAPI 3.1) Screen: Utility Service Orders
Overview
| Package | CRM |
|---|---|
| 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 CRM › Utility Service 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. |
| Table | crm.util_service_orders · 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
10 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/util-service-ordersList utility service orders
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",
"order_no": "ORD-000001",
"order_type": "text",
"priority": "low",
"status": "draft",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agreement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"scheduled_date": "2026-10-30",
"assigned_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"description": "text",
"source": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/util-service-orders?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/util-service-orders/{id}Read one service order
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",
"order_no": "ORD-000001",
"order_type": "text",
"priority": "low",
"status": "draft",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agreement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"scheduled_date": "2026-10-30",
"assigned_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"description": "text",
"source": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-service-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-service-ordersCreate a service order
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
priority | text | No | Priority Allowed: low normal high emergency |
scheduled_date | date | No | Scheduled |
description | text | No | What to do |
Sample body
{
"priority": "low",
"scheduled_date": "2026-10-30",
"description": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"order_type": "text",
"priority": "low",
"status": "draft",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agreement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"scheduled_date": "2026-10-30",
"assigned_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"description": "text",
"source": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-service-orders" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"priority":"low","scheduled_date":"2026-10-30","description":"text"}'PUT/api/crm/util-service-orders/{id}Change a service order
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 |
|---|---|---|---|
priority | text | No | Priority Allowed: low normal high emergency |
scheduled_date | date | No | Scheduled |
description | text | No | What to do |
Sample body
{
"priority": "low",
"scheduled_date": "2026-10-30"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"order_no": "ORD-000001",
"order_type": "text",
"priority": "low",
"status": "draft",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"agreement_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"scheduled_date": "2026-10-30",
"assigned_user_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"description": "text",
"source": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/util-service-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"priority":"low","scheduled_date":"2026-10-30"}'DELETE/api/crm/util-service-orders/{id}Delete a service order
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/crm/util-service-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-service-orders/{id}/assignAssign
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):
assigned_user_id, scheduled_dateResponse
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/util-service-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/assign" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"assigned_user_id":"value","scheduled_date":"value"}'POST/api/crm/util-service-orders/{id}/startStart
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/crm/util-service-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/start" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-service-orders/{id}/completeComplete
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/crm/util-service-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/complete" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-service-orders/{id}/cancelCancel
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):
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/crm/util-service-orders/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/crm/util-service-orders/{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/crm/util-service-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 service order, 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 |
order_no | text | read only | Order no |
order_type | text | read only | Order type |
priority | text | read, write | Priority Allowed: low normal high emergency |
status | text | read only | Status |
service_account_id | uuid | read only | Service account id |
premise_id | uuid | read only | Premise id |
meter_id | uuid | read only | Meter id |
agreement_id | uuid | read only | Agreement id |
scheduled_date | date | read, write | Scheduled |
assigned_user_id | uuid | read only | Assigned user id |
description | text | read, write | What to do |
source | text | read only | Source |
request_id | uuid | read only | Request id |
alarm_id | uuid | read only | Alarm id |
exception_id | uuid | read only | Exception id |
started_at | timestamp with time zone | read only | Started at |
completed_at | timestamp with time zone | read only | Completed at |
completed_by | uuid | read only | Completed by |
completion_notes | text | read only | Completion notes |
completion_read | numeric | read only | Completion read |
new_meter_id | uuid | read only | New meter id |
new_meter_start_read | numeric | read only | New meter start read |
cancel_reason | text | read only | Cancel reason |
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 CRM › Utility Service Orders 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.