Rate Input

Connect requests you to provide a manual tariff input screen for FIXED or TIME_OF_DAY tariff structure.

FIXED tariff rate

This page enables the customer to enter their tariff when they are on a fixed (flat) rate.

Preview
Code

cost shall be returned in large currency units.

{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "rate_fixed_input",
  "direction": "IMPORT",
  "type": "COMMODITY",
  "live_mode": false,
  "actions": [
    "BACK"
  ],
  "data": {
    "currency_code": "GBP",
    "provider": {
      "id": "prv_65de30082a7c56d2297cbe3d",
      "display_name": "OVO Energy",
      "logo_url": "https://s.flatpeak.com/c56d2297cbe3d.png"
    },
    "cost": 0
  }
}

When you POST the response, Connect may return any of these validation errors:

Error Code	Error Description
`cost_value_zero`	Tariff rate (cost) cannot be zero.
`cost_value_negative`	Tariff rate (cost) must be greater than zero.
`data_json_invalid`	Data does not conform to the JSON schema.

TIME_OF_DAY tariff rate

This page lets the customer enter their tariff if it changes throughout the day.

Preview
Code

hours.valid_from and hours.valid_to shall be returned as entered. hours.cost shall be returned in large currency units.

{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "rate_tod_capture",
  "direction": "IMPORT",
  "type": "COMMODITY",
  "live_mode": false,
  "data": {
    "currency_code": "GBP",
    "provider": {
      "id": "prv_65de3167136dda41ceba3c2f",
      "display_name": "EDF",
      "logo_url": "https://s.flatpeak.com/dda41ceba3c2f.png"
    },
    "hours": [
      {
        "cost": 0,
        "valid_from": "00:00:00",
        "valid_to": "00:00:00"
      }
    ]
  }
}

When you POST the response, Connect may return any of these validation errors:

Error Code	Error Description
`cost_value_zero`	Tariff rate (cost) cannot be zero.
`cost_value_negative`	Tariff rate (cost) must be greater than zero.
`valid_from_invalid`	Time period start must be in format HH:mm:ss.
`valid_to_invalid`	Time period end must be in format HH:mm:ss.
`gap_in_time_period`	Gap between XX and YY is found in the time period.
`incomplete_time_period`	Time period must cover the full 24 hours.
`data_json_invalid`	Data does not conform to the JSON schema.

Supported actions:

Action	Result
`BACK`	Returns previous page.
`CLOSE`	Returns `callback_url` you specified when creating the Connect token.

Plan Structure Surcharge Input

⌘I

Service Methods

Connect Tariff

Get Energy Price

Schedule Energy

Submit Telemetry

Calculate Energy Cost

Providers