Contract term capture (input)

This page is returned when Connect cannot automatically detect the term of your customer’s contract. You can extend this page’s functionality by including contract_start_date and contract_end_date.

Preview
Code

The contract_end_date and contract_start_date format:

If date is known, submit it in RFC3339 format (i.e. UTC) 2024-06-15T00:00:00Z
If no information is available, submit null
If contract has no end date, submit contract_term_type as UNTIL_TERMINATED

{
  "connect_token": "cot_6587fa4362341be5b524de3b",
  "route": "contract_term_capture",
  "direction": "IMPORT",
  "type": "COMMODITY",
  "live_mode": false,
  "actions": [
    "BACK"
  ],
  "data": {
    "provider": {
      "id": "prv_65de3071e0c5570f767f06f1",
      "display_name": "SSE",
      "logo_url": "https://s.flatpeak.com/570f767f06f1.png"
    },
    "contract_start_date": null,
    "contract_end_date": null,
    "contract_term_type": ""
  }
}

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

Error Code	Error Description
`date_format_invalid`	Incorrect date format.
`data_json_invalid`	Data does not conform to the JSON schema.

Tariff name capture Retrieve a price

⌘I

Connect tariff

Schedule energy

Calculate cost

Contract term capture (input)

Connect tariff

Schedule energy

Calculate cost

Documentation Index