api/v1/meterreadheader

Path: api/v1/meterreadheader

This API is JSON:API compliant.

This endpoint supports the following methods:
GET

This endpoint requires an OAuth bearer token, and returns errors in a standard shape. See API Conventions for authentication, error responses and paging, which apply to every endpoint.

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

Attributes

The MeterReadHeader resource type attributes are as follows:

Read-only — a tick means the value is set by Jim2 and cannot be changed through the API: it is returned in responses, but any value you send for it in a POST or PATCH is rejected.

Attribute names are case-sensitive and must be sent and read exactly as shown. The API mixes capitalisation styles — some names are PascalCase (e.g. Status, CustRef, DateDue) and others camelCase (e.g. dateIn, priceLevel) — so copy each name verbatim rather than assuming one convention. Filter names (in the filter list on the GET example) may differ from the attribute names.

Monetary and quantity values are decimal numbers whose number of decimal places depends on your Jim2 configuration. They are returned as JSON numbers with their scale preserved. Parse them as decimal / fixed-point values, not floating-point, to preserve precision.

Attribute	Type	Description
billDate	string	The date the meter read was billed, as an ISO date.
custRef	string	The customer's reference for the meter read.
dateIn	string	The date the meter read was created, as an ISO date.
isPrimary	boolean	Whether this is the primary meter read.
meterReadCapture	string	How the meter read was captured.
meterReads	array of object	The individual meter readings captured in this meter read. See the meterReads section below.
pageRequestName	string	The page request name.
readDate	string	The date the meter was read, as an ISO date.
readStatus	string	The meter read status.
readType	string	The meter read type.

Attribute

Type

Description

billDate

string

The date the meter read was billed, as an ISO date.

custRef

string

The customer's reference for the meter read.

dateIn

string

The date the meter read was created, as an ISO date.

isPrimary

boolean

Whether this is the primary meter read.

meterReadCapture

string

How the meter read was captured.

meterReads

array of object

The individual meter readings captured in this meter read.
See the meterReads section below.

pageRequestName

string

The page request name.

readDate

string

The date the meter was read, as an ISO date.

readStatus

string

The meter read status.

readType

string

The meter read type.

meterReads

Attributes of each element in the meterReads array.

Attribute	Type	Description
actualMeterRead	number	The actual meter reading captured. Note: Will not be returned in the response if value is null.
effectiveMeterRead	number	The effective meter reading used for billing. Note: Will not be returned in the response if value is null.
lineTotalTF	number	The line total excluding tax (tax-free). Note: Will not be returned in the response if value is null.
lineTotalTP	number	The line total including tax (tax-paid). Note: Will not be returned in the response if value is null.
meterTypeName	string	The meter type name.
qty	number	The billable quantity derived from the reading. Note: Will not be returned in the response if value is null.

Attribute

Type

Description

actualMeterRead

number

The actual meter reading captured.
Note: Will not be returned in the response if value is null.

effectiveMeterRead

number

The effective meter reading used for billing.
Note: Will not be returned in the response if value is null.

lineTotalTF

number

The line total excluding tax (tax-free).
Note: Will not be returned in the response if value is null.

lineTotalTP

number

The line total including tax (tax-paid).
Note: Will not be returned in the response if value is null.

meterTypeName

string

The meter type name.

qty

number

The billable quantity derived from the reading.
Note: Will not be returned in the response if value is null.

Example GET (Return specific)

Path: api/v1/meterreadheader/30

Response:

This example shows the maximum set of fields the endpoint can return, all populated. A real response only contains the data that applies to that record, so fields that are empty or not relevant are omitted — do not assume every field shown here will be present in every response.

{
  "data": {
    "id": "3",
    "type": "MeterReadHeader",
    "attributes": {
      "meterReadCapture": "Submission",
      "dateIn": "2025-10-28",
      "readDate": "2025-10-22",
      "billDate": "2025-10-31",
      "custRef": "MR-CR-0031",
      "readType": "NormalRead",
      "readStatus": "Active",
      "pageRequestName": "Monthly Meter Read",
      "isPrimary": true,
      "meterReads": [
        {
          "meterTypeName": "Black",
          "actualMeterRead": 3000.0,
          "effectiveMeterRead": 3000.0,
          "qty": 500.0,
          "lineTotalTF": 25.00,
          "lineTotalTP": 27.50
        },
        {
          "meterTypeName": "Colour",
          "actualMeterRead": 1275.0,
          "effectiveMeterRead": 1275.0,
          "qty": 200.0,
          "lineTotalTF": 40.00,
          "lineTotalTP": 44.00
        }
      ]
    },
    "relationships": {
      "createdby": {
        "data": {
          "type": "CardFile",
          "id": "1"
        }
      },
      "linkedobject": {
        "data": {
          "type": "Asset",
          "id": "28"
        }
      }
    },
    "links": {
      "self": "/jim_webapi_nonmulticompany/api/v1/meterreadheader/3"
    }
  }
}