Create a schedule

Authorizations

Authorization

string

header

required

Authenticate with bearer_token you obtained from /login endpoint.

Body

application/json

location_id

string

required

FlatPeak locaiton ID for which you want to generate the schedule.

max_power

object

required

Maximum speed of power transfer for that location.

data

object[]

This object that contains device schedule requests.

shaving_threshold

object

Tariff cap. Specifies up to what price you are willing to pay to buy (or, in reverse, sell) energy.

Response

200 - application/json

account_id

string

required

FlatPeak account ID.

currency_code

string

required

Currency code for cost of energy measure. Always returned in large currency units.

string

required

FlatPeak schedule id.

live_mode

boolean

required

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

location_id

string

required

FlatPeak location ID where this schedule applies.

location_timezone

string

required

The timezone at the location, in 'tz database format'. I.e. 'Europe/Berlin'.

max_power

object

required

Maximum speed of power transfer for that location.

object

string

required

Represents the object’s type.

savings

object

required

Savings provided by the schedule by applying (1) tariff shaving and (2) tariff based optimisation. The shaving is applied first.

tariff

object

required

Monetary cost of energy in the schedule.

time_created

string

required

Time when this object was created, in UTC.

data

object[]

This object that contains device schedules.

shaving_threshold

object

Tariff cap. Specifies up to what price you are willing to pay to buy (or, in reverse, sell) energy.