PUT
/
meters
/
direct
curl --request PUT \
  --url https://api.flatpeak.com/meters/direct \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "location_id": "loc_641b90b758fb8e6293716e40",
    "device_id": "dev_65e6d8334c8d715963d99db3",
    "session_reference_id": "SESSION1234567890",
    "record_reference_id": "MET1234567890",
    "direction": "IMPORT",
    "measurand": "TRANSFERRED",
    "units": "W",
    "value": 20567,
    "start_time": "2022-02-01T10:30:00Z",
    "end_time": "2022-02-01T11:00:00Z"
  }
]'
{
  "id": "bat_65e42b7827c0526548432b9f",
  "object": "meter_batch",
  "records_submitted": 18379,
  "records_accepted": 18378,
  "records_processed": 32,
  "time_created": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
headerrequired

Authenticate with bearer_token you obtained from /login endpoint.

Body

application/json ยท object[]
location_id
string
required

FlatPeak location_id that you are submitting metering records for.

device_id
string

FlatPeak device_id you are submitting metering records for. If you provided both location_id and device_id your records will be attribited to device_id.

session_reference_id
string

A reference for a group of metering records, for example, a charging session ID.

record_reference_id
string

A reference for this metering record, for example, meter log ID.

direction
string

Indicates metering direction. Set to IMPORT or EXPORT. Defaults to IMPORT.

measurand
string

Possible options are OFFERED or TRANSFERRED. Currently only TRANSFERRED is supported.

units
string
required

Units of measure, supported values are W, KW, WH, KWH.

value
number
required

Amount of energy measured.

start_time
string
required

Metering record start time.

end_time
string
required

Metering record end time.

Response

200 - application/json
id
string

FlatPeak ID for this submission.

object
string

Object name, i.e. meter_batch.

records_submitted
integer

Number of received metering records.

records_accepted
integer

Number of accepted metering records.

records_processed
integer

Number of processed metering records.

time_created
string

Time when this object was created.

Was this page helpful?

Retrieve a tariff elementCheck batch status