TRANXACT.AI Help

CRM · Utility Meters & Reads

Meters

Every meter: serial, service, make and model, size, unit, multiplier and dials, how it is read, where it is installed and its last read.

Type REST6 operationsBase path /api/crm/util-metersPublished as /api/v1/util-meters

Download specification (OpenAPI 3.1) Screen: Meters

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 › Meters 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_meters · 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

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

GET/api/crm/util-metersList meters

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",
      "serial_no": "SER-000001",
      "service_type": "water",
      "make": "text",
      "model": "text",
      "size": "text",
      "unit": "text",
      "multiplier": "1250.00",
      "dials": 10,
      "read_type": "manual",
      "status": "draft",
      "premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "installed_on": "2026-10-30"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "serial_no": "SER-000001",
  "service_type": "water",
  "make": "text",
  "model": "text",
  "size": "text",
  "unit": "text",
  "multiplier": "1250.00",
  "dials": 10,
  "read_type": "manual",
  "status": "draft",
  "premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "installed_on": "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-meters/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-metersCreate a util meters

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
serial_notextYesSerial
service_typetextYesService
Allowed: water sewer electric gas refuse stormwater
maketextNoMake
modeltextNoModel
sizetextNoSize
unittextNoUnit — gal, ccf, m3, kWh, therm ...
multipliernumericNoMultiplier
dialsintegerNoDials — The register rolls over after this many digits.
read_typetextNoRead by
Allowed: manual amr ami
notestextNoNotes

Sample body

{
  "serial_no": "SER-000001",
  "service_type": "water",
  "make": "text",
  "model": "text",
  "size": "text",
  "unit": "text"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "serial_no": "SER-000001",
  "service_type": "water",
  "make": "text",
  "model": "text",
  "size": "text",
  "unit": "text",
  "multiplier": "1250.00",
  "dials": 10,
  "read_type": "manual",
  "status": "draft",
  "premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "installed_on": "2026-10-30"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/crm/util-meters" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"serial_no":"SER-000001","service_type":"water","make":"text","model":"text","size":"text","unit":"text"}'
PUT/api/crm/util-meters/{id}Change a util meters

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
serial_notextYesSerial
service_typetextYesService
Allowed: water sewer electric gas refuse stormwater
maketextNoMake
modeltextNoModel
sizetextNoSize
unittextNoUnit — gal, ccf, m3, kWh, therm ...
multipliernumericNoMultiplier
dialsintegerNoDials — The register rolls over after this many digits.
read_typetextNoRead by
Allowed: manual amr ami
notestextNoNotes

Sample body

{
  "serial_no": "SER-000001",
  "service_type": "water"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "serial_no": "SER-000001",
  "service_type": "water",
  "make": "text",
  "model": "text",
  "size": "text",
  "unit": "text",
  "multiplier": "1250.00",
  "dials": 10,
  "read_type": "manual",
  "status": "draft",
  "premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "installed_on": "2026-10-30"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/crm/util-meters/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"serial_no":"SER-000001","service_type":"water"}'
DELETE/api/crm/util-meters/{id}Delete a util meters

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-meters/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-meters/{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-meters/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 meters, 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
serial_notextread, writeSerial
service_typetextread, writeService
Allowed: water sewer electric gas refuse stormwater
maketextread, writeMake
modeltextread, writeModel
sizetextread, writeSize
unittextread, writeUnit — gal, ccf, m3, kWh, therm ...
multipliernumericread, writeMultiplier
dialsintegerread, writeDials — The register rolls over after this many digits.
read_typetextread, writeRead by
Allowed: manual amr ami
statustextread onlyStatus
premise_iduuidread onlyPremise id
installed_ondateread onlyInstalled on
last_readingnumericread onlyLast reading
last_read_attimestamp with time zoneread onlyLast read 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 › Meters 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.