Skip to main content

Fields

characteristics : GenericScalar

The market-supply-characteristic scope, as a code-to-value map.

marketName : String

The market name the contracted volume applies to.

maximum : Decimal

Optional upper bound around the value (e.g. a tolerance cap).

measurementPeriod : String

The measurement cadence of the quantity (WHOLE_PERIOD, DAILY or HOURLY).

minimum : Decimal

Optional lower bound around the value (e.g. a take-or-pay floor).

unit : String

The unit for the commodity provided by the contracted volume.

validFrom : DateTime

When the contracted volume is valid from.

validTo : DateTime

When the contracted volume is valid to.

value : Decimal

The decimal value of the quantity provided by the contracted volume.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "characteristics": "abc123" | 1 | 1.0 | true | ["abc123"] | AccountType, "marketName": "image-administration-continue-policy-seven", "maximum": "1.0", "measurementPeriod": "despite-computer-town-best-some", "minimum": "1.0", "unit": "there-chair-strategy-change-amount", "validFrom": "1986-03-19T20:59:40.653865+00:00", "validTo": "1989-07-03T16:39:27.916856+00:00", "value": "1.0" }