CRM · Utility Billing
Utility Bills
Every bill: the run it came from, the account, the charges, what was owed before, what is due, and the AR invoice it became.
/api/crm/util-billsPublished as /api/v1/util-billsOverview
| 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 Bills 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_bills · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
14 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/util-billsList utility bills
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",
"bill_no": "BIL-000001",
"bill_kind": "text",
"bill_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"bill_date": "2026-10-30",
"due_date": "2026-10-30",
"currency": "USD",
"previous_balance": "1250.00",
"credit_applied": "1250.00",
"deposit_applied": "1250.00"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/util-bills?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/util-bills/{id}Read one utility bill
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",
"bill_no": "BIL-000001",
"bill_kind": "text",
"bill_run_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"service_account_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"period_start": "2026-10-30",
"period_end": "2026-10-30",
"bill_date": "2026-10-30",
"due_date": "2026-10-30",
"currency": "USD",
"previous_balance": "1250.00",
"credit_applied": "1250.00",
"deposit_applied": "1250.00"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/util-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-bills/{id}/acceptAccept
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):
noteResponse
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-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/accept" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/crm/util-bills/{id}/holdHold
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):
noteResponse
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-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/hold" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/crm/util-bills/{id}/releaseRelease
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):
noteResponse
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-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/release" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"note":"value"}'POST/api/crm/util-bills/{id}/postPost
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-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-bills/{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-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'POST/api/crm/util-bills/{id}/rebillRebill
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-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/rebill" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"reason":"value"}'GET/api/crm/util-bills/{id}/detailDetail
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-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/detail" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/util-bills/{id}/pdfPdf
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-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/pdf" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-billsPost utility bills
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-bills" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/util-bills/{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-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/crm/util-bills/{id}Put utility bills
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 PUT "https://demo.tranxact.ai/api/crm/util-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/crm/util-bills/{id}Delete utility bills
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 DELETE "https://demo.tranxact.ai/api/crm/util-bills/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a utility bill, 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 |
bill_no | text | read only | Bill no |
bill_kind | text | read only | Bill kind |
bill_run_id | uuid | read only | Bill run id |
service_account_id | uuid | read only | Service account id |
period_start | date | read only | Period start |
period_end | date | read only | Period end |
bill_date | date | read only | Bill date |
due_date | date | read only | Due date |
currency | text | read only | Currency |
previous_balance | numeric | read only | Previous balance |
credit_applied | numeric | read only | Credit applied |
deposit_applied | numeric | read only | Deposit applied |
subtotal | numeric | read only | Subtotal |
tax_total | numeric | read only | Tax total |
total | numeric | read only | Total |
amount_due | numeric | read only | Amount due |
usage_summary | jsonb | read only | Usage summary |
status | text | read only | Status |
exception_reason | text | read only | Exception reason |
ar_invoice_id | uuid | read only | Ar invoice id |
rebill_of_id | uuid | read only | Rebill of id |
cancel_reason | text | read only | Cancel reason |
charge_reason | text | read only | Charge reason |
autopay_mandate_id | uuid | read only | Autopay mandate id |
emailed_at | timestamp with time zone | read only | Emailed at |
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 Bills 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.