TRANXACT.AI Help

CRM · Utility Meters & Reads

Meter Reads

Every read from every source — the reader, an AMR file, an IoT device, the field, the portal, an estimate — with its consumption and what billed it.

Type REST7 operationsBase path /api/crm/util-readsPublished as /api/v1/util-reads

Download specification (OpenAPI 3.1) Screen: Meter Reads

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 › Meter Reads 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_reads · kept per company (and organisational unit where it has one)
RecordRead only; 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-readsList meter reads

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",
      "meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "read_at": "2026-10-30T09:00:00Z",
      "reading": "1250.00",
      "consumption": "1250.00",
      "source": "text",
      "read_type": "text",
      "status": "draft",
      "rolled_over": true,
      "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "import_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "billed_bill_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
    }
  ],
  "count": 1
}

Sample request

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

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",
  "meter_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "premise_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "read_at": "2026-10-30T09:00:00Z",
  "reading": "1250.00",
  "consumption": "1250.00",
  "source": "text",
  "read_type": "text",
  "status": "draft",
  "rolled_over": true,
  "device_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "import_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "billed_bill_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73"
}

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

Sample request

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

Request body

The keys this action reads (* = required; "one of" lists the only values):

source, meter_id, serial_no, read_at, reading, read_type, note; source one of manual|amr|field|portal; read_type one of actual|start|final

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-reads/record" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"source":"value","meter_id":"value","serial_no":"value","read_at":"value","reading":"value","read_type":"value"}'
POST/api/crm/util-readsPost meter reads

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-reads" \
  -H "Authorization: Bearer $TOKEN"
POST/api/crm/util-reads/{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-reads/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-reads/{id}Put meter reads

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 PUT "https://demo.tranxact.ai/api/crm/util-reads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/crm/util-reads/{id}Delete meter reads

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 DELETE "https://demo.tranxact.ai/api/crm/util-reads/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"

Data model

Every field of a meter read, 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
meter_iduuidread onlyMeter id
premise_iduuidread onlyPremise id
read_attimestamp with time zoneread onlyRead at
readingnumericread onlyReading
consumptionnumericread onlyConsumption
sourcetextread onlySource
read_typetextread onlyRead type
statustextread onlyStatus
rolled_overbooleanread onlyRolled over
device_iduuidread onlyDevice id
import_iduuidread onlyImport id
billed_bill_iduuidread onlyBilled bill id
notetextread onlyNote
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 › Meter Reads 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.