TRANXACT.AI Help

Manufacturing · Maintenance

Meter Readings

What turns "every 2,000 hours" into a date. A reading below the previous one is recorded as a RESET rather than as a negative — a replaced meter would otherwise poison every average built on it.

Type REST7 operationsBase path /api/mfg/meter-readingsPublished as /api/v1/meter-readings

Download specification (OpenAPI 3.1) Screen: Meter Readings

Overview

PackageManufacturing
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 Manufacturing › Meter Readings 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.
Tablemfg.meter_readings · 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/mfg/meter-readingsList meter readings

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": "1250.00",
      "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "meter_type": "text",
      "reading_value": "1250.00",
      "delta_value": "1250.00",
      "is_reset": true,
      "uom": "text",
      "reading_at": "2026-10-30T09:00:00Z",
      "source": "text",
      "read_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "device_ref": "text",
      "notes": "text",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "xf_text_1": "text"
    }
  ],
  "count": 1
}

Sample request

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

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "1250.00",
  "equipment_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "meter_type": "text",
  "reading_value": "1250.00",
  "delta_value": "1250.00",
  "is_reset": true,
  "uom": "text",
  "reading_at": "2026-10-30T09:00:00Z",
  "source": "text",
  "read_by": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "device_ref": "text",
  "notes": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "xf_text_1": "text"
}

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

Sample request

curl "https://demo.tranxact.ai/api/mfg/meter-readings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/meter-readingsPost meter readings

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/mfg/meter-readings" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/meter-readings/{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/mfg/meter-readings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'
PUT/api/mfg/meter-readings/{id}Put meter readings

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/mfg/meter-readings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
DELETE/api/mfg/meter-readings/{id}Delete meter readings

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/mfg/meter-readings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/mfg/meter-readings/recordRecord

Request body

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

value, equipmentId, meterType, uom, source, deviceRef, notes; meterType one of running_hours|cycles|units_produced|distance|starts|energy; source one of manual|plc|iot|confirmation|import|calculated

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/mfg/meter-readings/record" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"value":"value","equipmentId":"value","meterType":"value","uom":"value","source":"value","deviceRef":"value"}'

Data model

Every field of a meter reading, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
idbigintread onlyId
org_iduuidread onlyOrg id
equipment_iduuidread onlyEquipment id
meter_typetextread onlyMeter type
reading_valuenumericread onlyReading value
delta_valuenumericread onlyDelta value
is_resetbooleanread onlyIs reset
uomtextread onlyUom
reading_attimestamp with time zoneread onlyReading at
sourcetextread onlySource
read_byuuidread onlyRead by
device_reftextread onlyDevice ref
notestextread onlyNotes
org_unit_iduuidread onlyOrg unit id
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
created_attimestamp with time zoneread onlyCreated at
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

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 Manufacturing › Meter Readings 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.