Index

api/v1/meterreadheader

Path: api/v1/meterreadheader

This API is JSON:API compliant.

This endpoint supports the following methods:
GET

The resource type for this endpoint is MeterReadHeader
The identifier is meterreadheaderno

The MeterReadHeader resource type attributes are as follows:

{
"meterReadCapture":string
"dateIn":string
"readDate":string
"billDate":string
"custRef":string
"readType":string
"readStatus":string
"pageRequestName":string
"isPrimary":boolean
"meterReads": [{
"meterTypeName":string
optional
"actualMeterRead":number Note: Will not be returned in the response if value is null.
optional
"effectiveMeterRead":number Note: Will not be returned in the response if value is null.
optional
"qty":number Note: Will not be returned in the response if value is null.
optional
"lineTotalTF":number Note: Will not be returned in the response if value is null.
optional
"lineTotalTP":number Note: Will not be returned in the response if value is null.
}]
}

Example GET (Return specific)

Path: api/v1/meterreadheader/30

Response:

{
  "data": {
    "id": "3",
    "type": "MeterReadHeader",
    "attributes": {
      "linkedObjectNo": "28",
      "linkedObjectTYpe": "asset",
      "meterReadCapture": "Submission",
      "dateIn": "2025-10-28",
      "readDate": "2025-10-22",
      "billDate": null,
      "custRef": null,
      "readType": "NormalRead",
      "createdCardNo": 1,
      "readStatus": "Active",
      "pageRequestName": null,
      "isPrimary": true,
      "meterReads": [
        {
          "meterTypeName": "Black",
          "actualMeterRead": 3000.0
        },
        {
          "meterTypeName": "Colour",
          "actualMeterRead": 1275.0
        }
      ]
    },
    "links": {
      "self": "/jim_webapi_nonmulticompany/api/v1/meterreadheader/3"
    }
  }
}