Skip to main content

A volume for one aggregate timeseries and one Imbalance Settlement Period (ISP).

​
external_id
string
required
​
finality
enum<string>
required

The settlement data comes in different levels of "finality". Each market has its own names for these levels, and all of them map to this common ladder. When one settlement period has more than one record, use the record with the highest finality, then the latest known_at.

Available finalities

  • preliminary — The first level, sent before the market has all the data.

  • revised — The level used for corrections to the preliminary data.

  • final — The level used for settlement and invoicing.

  • correction — The level used for corrections when the final value was wrong. A correction replaces the final value.

Available options:
preliminary,
revised,
final,
correction
Example:

"final"

​
flow_direction
enum<string>
required
Available options:
consumption,
production
​
isp_resolution_minutes
integer
required
​
isp_time
string<date-time>
required
​
known_at
string<date-time>
required
​
quality
enum<string>
required

How the volume was arrived at, in ascending order of trust. When one settlement period carries several records, prefer the highest quality.

Available allocation qualities

  • provisional — A placeholder the sender intends to replace.

  • estimated — Substituted because no reading was available: profiled, interpolated, or copied from a comparable period. Expect it to be superseded.

  • calculated — Derived by a defined computation rather than read

  • measured — Read off the meter.

Available options:
provisional,
estimated,
calculated,
measured
Example:

"calculated"

​
volume_wh
integer
required