TRANXACT.AI Help

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.

Type REST7 operationsBase path /api/crm/util-rate-plansPublished as /api/v1/util-rate-plans

Download specification (OpenAPI 3.1) Screen: Rate Plans

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 › 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.
Tablecrm.util_rate_plans · 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

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

GET/api/crm/util-rate-plansList rate plans

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",
      "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

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",
  "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.

FieldTypeRequiredDescription
codetextYesCode
nametextYesName
service_typetextYesService
Allowed: water sewer electric gas refuse stormwater
customer_classtextNoFor class — Blank: any class.
Allowed: residential commercial industrial municipal institutional
unittextNoUnit — gal, ccf, m3, kWh, therm, month ...
fixed_chargenumericNoCustomer charge per period
minimum_billnumericNoMinimum bill
summer_months_int4NoSummer months — Month numbers, e.g. 6, 7, 8, 9. Blank: no seasons.
tax_code_iduuidNoTax code
revenue_account_notextNoRevenue account — Blank: the company's utility revenue, else the chart's default.
effective_fromdateNoEffective from
effective_todateNoEffective to
statustextNoStatus
Allowed: draft active retired
notestextNoNotes
service_charge_account_notextNoService charge account — Where the customer (fixed) charge posts, e.g. 4410. Blank: the settings' service-charge account, else the revenue account.
cost_center_iduuidNoCost 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

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
codetextYesCode
nametextYesName
service_typetextYesService
Allowed: water sewer electric gas refuse stormwater
customer_classtextNoFor class — Blank: any class.
Allowed: residential commercial industrial municipal institutional
unittextNoUnit — gal, ccf, m3, kWh, therm, month ...
fixed_chargenumericNoCustomer charge per period
minimum_billnumericNoMinimum bill
summer_months_int4NoSummer months — Month numbers, e.g. 6, 7, 8, 9. Blank: no seasons.
tax_code_iduuidNoTax code
revenue_account_notextNoRevenue account — Blank: the company's utility revenue, else the chart's default.
effective_fromdateNoEffective from
effective_todateNoEffective to
statustextNoStatus
Allowed: draft active retired
notestextNoNotes
service_charge_account_notextNoService charge account — Where the customer (fixed) charge posts, e.g. 4410. Blank: the settings' service-charge account, else the revenue account.
cost_center_iduuidNoCost 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

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/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

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
codetextread, writeCode
nametextread, writeName
service_typetextread, writeService
Allowed: water sewer electric gas refuse stormwater
customer_classtextread, writeFor class — Blank: any class.
Allowed: residential commercial industrial municipal institutional
unittextread, writeUnit — gal, ccf, m3, kWh, therm, month ...
fixed_chargenumericread, writeCustomer charge per period
minimum_billnumericread, writeMinimum bill
summer_months_int4read, writeSummer months — Month numbers, e.g. 6, 7, 8, 9. Blank: no seasons.
tax_code_iduuidread, writeTax code
revenue_account_notextread, writeRevenue account — Blank: the company's utility revenue, else the chart's default.
effective_fromdateread, writeEffective from
effective_todateread, writeEffective to
statustextread, writeStatus
Allowed: draft active retired
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
service_charge_account_notextread, writeService charge account — Where the customer (fixed) charge posts, e.g. 4410. Blank: the settings' service-charge account, else the revenue account.
cost_center_iduuidread, writeCost 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_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 CRM › Rate Plans 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.