TRANXACT.AI Help

CRM · Utility Billing

Bill Runs

A cycle billed in four steps: preview, review the exceptions, approve (somebody other than who previewed it), post to the receivable.

Type REST10 operationsBase path /api/crm/util-bill-runsPublished as /api/v1/util-bill-runs

Download specification (OpenAPI 3.1) Screen: Bill Runs

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 › Bill Runs 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_bill_runs · 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

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

GET/api/crm/util-bill-runsList bill runs

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",
      "run_no": "RUN-000001",
      "billing_cycle_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",
      "status": "draft",
      "bill_count": 10,
      "exception_count": 10,
      "total_amount": "1250.00",
      "prepared_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "prepared_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/crm/util-bill-runs?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/crm/util-bill-runs/{id}Read one bill run

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",
  "run_no": "RUN-000001",
  "billing_cycle_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",
  "status": "draft",
  "bill_count": 10,
  "exception_count": 10,
  "total_amount": "1250.00",
  "prepared_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "prepared_at": "2026-10-30T09:00:00Z"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/crm/util-bill-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-bill-runsCreate a bill run

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
run_notextYesRun no
billing_cycle_iduuidNoBilling cycle
period_startdateYesService from
period_enddateYesService to
bill_datedateNoBill date
due_datedateNoDue date — Blank: the cycle's due days after the bill date.
notestextNoNotes

Sample body

{
  "run_no": "RUN-000001",
  "period_start": "2026-10-30",
  "period_end": "2026-10-30",
  "billing_cycle_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "bill_date": "2026-10-30",
  "due_date": "2026-10-30",
  "notes": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_no": "RUN-000001",
  "billing_cycle_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",
  "status": "draft",
  "bill_count": 10,
  "exception_count": 10,
  "total_amount": "1250.00",
  "prepared_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "prepared_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/util-bill-runs" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"run_no":"RUN-000001","period_start":"2026-10-30","period_end":"2026-10-30","billing_cycle_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","bill_date":"2026-10-30","due_date":"2026-10-30","notes":"text"}'
PUT/api/crm/util-bill-runs/{id}Change a bill run

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
run_notextYesRun no
billing_cycle_iduuidNoBilling cycle
period_startdateYesService from
period_enddateYesService to
bill_datedateNoBill date
due_datedateNoDue date — Blank: the cycle's due days after the bill date.
notestextNoNotes

Sample body

{
  "run_no": "RUN-000001",
  "period_start": "2026-10-30"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "run_no": "RUN-000001",
  "billing_cycle_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",
  "status": "draft",
  "bill_count": 10,
  "exception_count": 10,
  "total_amount": "1250.00",
  "prepared_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "prepared_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/util-bill-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"run_no":"RUN-000001","period_start":"2026-10-30"}'
DELETE/api/crm/util-bill-runs/{id}Delete a bill run

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-bill-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-bill-runs/{id}/previewPreview

Path parameters

NameTypeDescription
idstring (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-bill-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/preview" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-bill-runs/{id}/approveApprove

Path parameters

NameTypeDescription
idstring (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-bill-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/approve" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-bill-runs/{id}/postPost

Path parameters

NameTypeDescription
idstring (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-bill-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/post" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-bill-runs/{id}/cancelCancel

Path parameters

NameTypeDescription
idstring (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-bill-runs/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/cancel" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-bill-runs/{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-bill-runs/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 bill run, 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
run_notextread, writeRun no
billing_cycle_iduuidread, writeBilling cycle
period_startdateread, writeService from
period_enddateread, writeService to
bill_datedateread, writeBill date
due_datedateread, writeDue date — Blank: the cycle's due days after the bill date.
statustextread onlyStatus
bill_countintegerread onlyBill count
exception_countintegerread onlyException count
total_amountnumericread onlyTotal amount
prepared_byuuidread onlyPrepared by
prepared_attimestamp with time zoneread onlyPrepared at
approved_byuuidread onlyApproved by
approved_attimestamp with time zoneread onlyApproved at
posted_byuuidread onlyPosted by
posted_attimestamp with time zoneread onlyPosted at
notestextread, writeNotes
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
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 › Bill Runs 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.