CRM · Utility Billing
Rate Plans
What each service costs: the customer charge, block rates (with summer and winter blocks), fees, a minimum bill, the tax code the company's tax engine rates, and the dates it applies.
/api/crm/util-rate-plansPublished as /api/v1/util-rate-plansOverview
| 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 › Rate Plans 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_rate_plans · 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
7 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/util-rate-plansList rate plans
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",
"code": "COD-000001",
"name": "Example",
"service_type": "water",
"customer_class": "residential",
"unit": "text",
"fixed_charge": "1250.00",
"minimum_bill": "1250.00",
"summer_months": [],
"tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"revenue_account_no": "REV-000001",
"effective_from": "2026-10-30",
"effective_to": "2026-10-30"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/util-rate-plans?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/util-rate-plans/{id}Read one util rate plans
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",
"code": "COD-000001",
"name": "Example",
"service_type": "water",
"customer_class": "residential",
"unit": "text",
"fixed_charge": "1250.00",
"minimum_bill": "1250.00",
"summer_months": [],
"tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"revenue_account_no": "REV-000001",
"effective_from": "2026-10-30",
"effective_to": "2026-10-30"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-rate-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-rate-plansCreate a util rate plans
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
service_type | text | Yes | Service Allowed: water sewer electric gas refuse stormwater |
customer_class | text | No | For class — Blank: any class. Allowed: residential commercial industrial municipal institutional |
unit | text | No | Unit — gal, ccf, m3, kWh, therm, month ... |
fixed_charge | numeric | No | Customer charge per period |
minimum_bill | numeric | No | Minimum bill |
summer_months | _int4 | No | Summer months — Month numbers, e.g. 6, 7, 8, 9. Blank: no seasons. |
tax_code_id | uuid | No | Tax code |
revenue_account_no | text | No | Revenue account — Blank: the company's utility revenue, else the chart's default. |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
status | text | No | Status Allowed: draft active retired |
notes | text | No | Notes |
service_charge_account_no | text | No | Service charge account — Where the customer (fixed) charge posts, e.g. 4410. Blank: the settings' service-charge account, else the revenue account. |
cost_center_id | uuid | No | Cost center — Every charge of this plan posts under it, so a fund-accounting company derives the fund (water to the water fund). Blank: the settings' cost center. |
Sample body
{
"code": "COD-000001",
"name": "Example",
"service_type": "water",
"customer_class": "residential",
"unit": "text",
"fixed_charge": "1250.00",
"minimum_bill": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"service_type": "water",
"customer_class": "residential",
"unit": "text",
"fixed_charge": "1250.00",
"minimum_bill": "1250.00",
"summer_months": [],
"tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"revenue_account_no": "REV-000001",
"effective_from": "2026-10-30",
"effective_to": "2026-10-30"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/util-rate-plans" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","service_type":"water","customer_class":"residential","unit":"text","fixed_charge":"1250.00","minimum_bill":"1250.00"}'PUT/api/crm/util-rate-plans/{id}Change a util rate plans
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 |
|---|---|---|---|
code | text | Yes | Code |
name | text | Yes | Name |
service_type | text | Yes | Service Allowed: water sewer electric gas refuse stormwater |
customer_class | text | No | For class — Blank: any class. Allowed: residential commercial industrial municipal institutional |
unit | text | No | Unit — gal, ccf, m3, kWh, therm, month ... |
fixed_charge | numeric | No | Customer charge per period |
minimum_bill | numeric | No | Minimum bill |
summer_months | _int4 | No | Summer months — Month numbers, e.g. 6, 7, 8, 9. Blank: no seasons. |
tax_code_id | uuid | No | Tax code |
revenue_account_no | text | No | Revenue account — Blank: the company's utility revenue, else the chart's default. |
effective_from | date | No | Effective from |
effective_to | date | No | Effective to |
status | text | No | Status Allowed: draft active retired |
notes | text | No | Notes |
service_charge_account_no | text | No | Service charge account — Where the customer (fixed) charge posts, e.g. 4410. Blank: the settings' service-charge account, else the revenue account. |
cost_center_id | uuid | No | Cost center — Every charge of this plan posts under it, so a fund-accounting company derives the fund (water to the water fund). Blank: the settings' cost center. |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"service_type": "water",
"customer_class": "residential",
"unit": "text",
"fixed_charge": "1250.00",
"minimum_bill": "1250.00",
"summer_months": [],
"tax_code_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"revenue_account_no": "REV-000001",
"effective_from": "2026-10-30",
"effective_to": "2026-10-30"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/util-rate-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/crm/util-rate-plans/{id}Delete a util rate plans
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-rate-plans/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/util-rate-plans/cost-centersCost centers
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-rate-plans/cost-centers" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-rate-plans/{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-rate-plans/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 util rate plans, 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 |
code | text | read, write | Code |
name | text | read, write | Name |
service_type | text | read, write | Service Allowed: water sewer electric gas refuse stormwater |
customer_class | text | read, write | For class — Blank: any class. Allowed: residential commercial industrial municipal institutional |
unit | text | read, write | Unit — gal, ccf, m3, kWh, therm, month ... |
fixed_charge | numeric | read, write | Customer charge per period |
minimum_bill | numeric | read, write | Minimum bill |
summer_months | _int4 | read, write | Summer months — Month numbers, e.g. 6, 7, 8, 9. Blank: no seasons. |
tax_code_id | uuid | read, write | Tax code |
revenue_account_no | text | read, write | Revenue account — Blank: the company's utility revenue, else the chart's default. |
effective_from | date | read, write | Effective from |
effective_to | date | read, write | Effective to |
status | text | read, write | Status Allowed: draft active retired |
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 |
service_charge_account_no | text | read, write | Service charge account — Where the customer (fixed) charge posts, e.g. 4410. Blank: the settings' service-charge account, else the revenue account. |
cost_center_id | uuid | read, write | Cost center — Every charge of this plan posts under it, so a fund-accounting company derives the fund (water to the water fund). Blank: the settings' cost center. |
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 › Rate Plans 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.