CRM · Utilities
Service Accounts
A customer's utility account: class, cycle, contact, paperless and autopay, the life-support flag, and the deposit and credit the utility holds. Open one for its 360 view.
/api/crm/util-accountsPublished as /api/v1/util-accountsDownload specification (OpenAPI 3.1) Screen: Service Accounts
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 › Service Accounts 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_accounts · 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
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/util-accountsList service accounts
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",
"account_no": "ACC-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_class": "residential",
"status": "draft",
"billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"mailing_address": "text",
"email": "someone@example.com",
"phone": "+1 555 0100",
"language": "text",
"paperless": true,
"autopay": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/util-accounts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/util-accounts/{id}Read one service account
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",
"account_no": "ACC-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_class": "residential",
"status": "draft",
"billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"mailing_address": "text",
"email": "someone@example.com",
"phone": "+1 555 0100",
"language": "text",
"paperless": true,
"autopay": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-accountsCreate a service account
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
account_no | text | Yes | Account no |
customer_account_id | uuid | Yes | Customer — An existing CRM customer. For somebody new, use Open account with a new customer. |
contact_id | uuid | No | Contact id |
account_class | text | No | Class Allowed: residential commercial industrial municipal institutional |
billing_cycle_id | uuid | No | Billing cycle |
mailing_address | text | No | Mailing address — Blank: bills go to the service address. |
email | text | No | |
phone | text | No | Telephone |
language | text | No | Language — Two letters, e.g. en, es, ar. |
paperless | boolean | No | Paperless billing |
life_support | boolean | No | Life support / critical care — Never disconnected for non-payment while this is ticked. |
life_support_note | text | No | Life support note |
collection_hold_until | date | No | Hold collections until |
notes | text | No | Notes |
Sample body
{
"account_no": "ACC-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_class": "residential",
"billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"mailing_address": "text"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_no": "ACC-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_class": "residential",
"status": "draft",
"billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"mailing_address": "text",
"email": "someone@example.com",
"phone": "+1 555 0100",
"language": "text",
"paperless": true,
"autopay": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-accounts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_no":"ACC-000001","customer_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","contact_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","account_class":"residential","billing_cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","mailing_address":"text"}'PUT/api/crm/util-accounts/{id}Change a service account
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 |
|---|---|---|---|
account_no | text | Yes | Account no |
customer_account_id | uuid | Yes | Customer — An existing CRM customer. For somebody new, use Open account with a new customer. |
contact_id | uuid | No | Contact id |
account_class | text | No | Class Allowed: residential commercial industrial municipal institutional |
billing_cycle_id | uuid | No | Billing cycle |
mailing_address | text | No | Mailing address — Blank: bills go to the service address. |
email | text | No | |
phone | text | No | Telephone |
language | text | No | Language — Two letters, e.g. en, es, ar. |
paperless | boolean | No | Paperless billing |
life_support | boolean | No | Life support / critical care — Never disconnected for non-payment while this is ticked. |
life_support_note | text | No | Life support note |
collection_hold_until | date | No | Hold collections until |
notes | text | No | Notes |
Sample body
{
"account_no": "ACC-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_no": "ACC-000001",
"customer_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"contact_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"account_class": "residential",
"status": "draft",
"billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"mailing_address": "text",
"email": "someone@example.com",
"phone": "+1 555 0100",
"language": "text",
"paperless": true,
"autopay": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/util-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"account_no":"ACC-000001","customer_account_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"}'DELETE/api/crm/util-accounts/{id}Delete a service account
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-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-accounts/createCreate
Request body
The keys this action reads (* = required; "one of" lists the only values):
customer_name, name, customer_account_id, account_class, email, phone, address_line1, city, region, postal_code, billing_cycle_id, mailing_address, language, paperless, life_support, life_support_note, notes; account_class one of residential|commercial|industrial|municipal|institutionalResponse
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-accounts/create" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"customer_name":"value","name":"value","customer_account_id":"value","account_class":"value","email":"value","phone":"value"}'GET/api/crm/util-accounts/{id}/overviewOverview
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (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/util-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/overview" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-accounts/{id}/start-serviceStart service
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-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/start-service" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-accounts/{id}/stop-serviceStop service
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-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/stop-service" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-accounts/{id}/transferTransfer
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-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/transfer" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-accounts/{id}/closeClose
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-accounts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-accounts/{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-accounts/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 account, 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 |
account_no | text | read, write | Account no |
customer_account_id | uuid | read, write | Customer — An existing CRM customer. For somebody new, use Open account with a new customer. |
contact_id | uuid | read, write | Contact id |
account_class | text | read, write | Class Allowed: residential commercial industrial municipal institutional |
status | text | read only | Status |
billing_cycle_id | uuid | read, write | Billing cycle |
mailing_address | text | read, write | Mailing address — Blank: bills go to the service address. |
email | text | read, write | |
phone | text | read, write | Telephone |
language | text | read, write | Language — Two letters, e.g. en, es, ar. |
paperless | boolean | read, write | Paperless billing |
autopay | boolean | read only | Autopay |
life_support | boolean | read, write | Life support / critical care — Never disconnected for non-payment while this is ticked. |
life_support_note | text | read, write | Life support note |
deposit_held | numeric | read only | Deposit held |
credit_balance | numeric | read only | Credit balance |
collection_hold_until | date | read, write | Hold collections until |
opened_on | date | read only | Opened on |
closed_on | date | read only | Closed on |
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 CRM › Service Accounts 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.