Origin Energy · Schema

ScheduleOrder

EnergyAustraliaUtilitiesElectricityGasEnergy RetailConsumer Data RightSmart MeteringSolarDERDemand ResponseEnergy Markets

Properties

Name Type Description
payload object

The payload to be used during creation.

task_params object

The parameters that control when and how Kraken will execute this task.

View JSON Schema on GitHub

JSON Schema

origin-energy-schedule-order-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/origin-energy/main/json-schema/origin-energy-schedule-order-schema.json",
  "title": "ScheduleOrder",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/origin-energy-orders-api-openapi.yml#/components/schemas/ScheduleOrder",
  "type": "object",
  "properties": {
    "payload": {
      "allOf": [
        {
          "$ref": "#/$defs/Order"
        }
      ],
      "description": "<p>The payload to be used during creation.</p>"
    },
    "task_params": {
      "allOf": [
        {
          "$ref": "#/$defs/TaskParameters"
        }
      ],
      "description": "<p>The parameters that control when and how Kraken will execute this task.</p>"
    }
  },
  "required": [
    "payload",
    "task_params"
  ],
  "$defs": {
    "AccountReference": {
      "type": "object",
      "properties": {
        "namespace": {
          "type": "string",
          "description": "<p>The namespace refers to the particular context the reference exists in. For example, <code>tentacle-energy.allpay-client-reference-numbers</code>.</p>",
          "maxLength": 50,
          "x-validators": [
            {
              "name": "Validate account reference namespace",
              "description": "Validate that the account reference namespace matches an available account reference namespace in Kraken.",
              "possible_errors": [
                "invalid_reference_namespace"
              ]
            }
          ]
        },
        "value": {
          "type": "string",
          "description": "<p>The unique identifier for the account.</p>",
          "maxLength": 100
        }
      },
      "required": [
        "namespace",
        "value"
      ],
      "x-validators": [
        {
          "name": "Validate account reference does not already exist",
          "description": "Validate that the account reference does not already exist for any account in Kraken.",
          "possible_errors": [
            "reference_already_exists"
          ]
        }
      ]
    },
    "Address": {
      "type": "object",
      "properties": {
        "administrative_area": {
          "type": "string",
          "default": "",
          "description": "<p>The top-level administrative subdivision. For example a US state, Australian state/territory, Italian region, UK constituent nation or Japanese prefecture.</p>",
          "maxLength": 512
        },
        "country": {
          "type": "string",
          "description": "<p>The ISO 3166-1-alpha-2 code of the country that this address belongs to, for example AU (Australia) or GB (Great Britain).</p>",
          "maxLength": 2
        },
        "delivery_point_identifier": {
          "type": "string",
          "description": "<p>The unique country specific identifier for an address. For example the UPRN in the UK or G-NAF ID in Australia.</p>",
          "maxLength": 11,
          "x-validators": [
            {
              "name": "Validate delivery point identifier",
              "description": "Validate that the delivery point identifier contains only capital letters and numbers.",
              "possible_errors": [
                "invalid_delivery_point_identifier"
              ]
            }
          ]
        },
        "dependent_locality": {
          "type": "string",
          "default": "",
          "description": "<p>Dependent localities, neighbourhoods or boroughs. These are sometimes included in an address when the delivery point is outside the boundary of the main postal town that serves it.</p>",
          "maxLength": 512
        },
        "locality": {
          "type": "string",
          "default": "",
          "description": "<p>The city/town portion of an address. For example a US city, Australian suburb/town, Italian comune or UK postal town.</p>",
          "maxLength": 512
        },
        "name": {
          "type": "string",
          "default": "",
          "description": "<p>The recipient's name.</p>",
          "deprecated": true
        },
        "organization": {
          "type": "string",
          "default": "",
          "description": "<p>The company or organization to which the address belongs.</p>",
          "deprecated": true
        },
        "postal_code": {
          "type": "string",
          "default": "",
          "description": "<p>The code assigned to a geographical area representing a group of addresses. For example a US ZIP code, Australian postcode, Italian CAP code or UK postcode.</p>",
          "maxLength": 512
        },
        "sorting_code": {
          "type": "string",
          "default": "",
          "description": "<p>This is a non-geographic code used for recipients of large quantities of post, such as companies or government departments. An example is the French CEDEX code.</p>",
          "maxLength": 512
        },
        "street_address": {
          "type": "string",
          "default": "",
          "description": "<p>Free text field for the address. Either this field or the <code>structured_address</code> field should be provided, not both.</p>"
        },
        "structured_street_address": {
          "type": [
            "object",
            "null"
          ],
          "description": "<p>Structured address object. Fields for this object are territory dependent. Please speak to the tech team about uses of this field. Either this field or the <code>street_address</code> should be provided, not both.</p>"
        }
      },
      "required": [
        "country"
      ],
      "x-validators": [
        {
          "name": "Validate and normalize postcode",
          "description": "Validate the postal code and normalize it to a standard format.",
          "possible_errors": [
            "invalid_postcode"
          ]
        },
        {
          "name": "Validate address",
          "description": "Validate that the address is in the correct format.",
          "possible_errors": [
            "invalid_address"
          ]
        }
      ]
    },
    "AgreementIntermediaryDetails": {
      "type": "object",
      "properties": {
        "external_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "<p>An external identifier for the intermediary relationship. This can be used to store a reference to this relationship in an external system (e.g., the source system during migration).</p>",
          "maxLength": 255
        },
        "portfolio_number": {
          "type": "string",
          "description": "<p>The number of the intermediary portfolio to link this agreement to. The portfolio must exist before creating the agreement.</p>",
          "x-validators": [
            {
              "name": "Validate the portfolio number",
              "description": "Validate that the portfolio number matches the expected format (P- followed by 8 uppercase alphanumeric characters).",
              "possible_errors": [
                "invalid_portfolio_number"
              ]
            }
          ]
        }
      },
      "required": [
        "portfolio_number"
      ]
    },
    "AusAgreementAddOn": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "<p>Code for addon that must have been configured for the product in kraken.</p>",
          "x-validators": [
            {
              "name": "data-import--validation--contract-addon-has-valid-code--display-name",
              "description": "data-import--validation--contract-addon-has-valid-code--help-text",
              "possible_errors": [
                "addon_code_not_found"
              ]
            }
          ]
        }
      },
      "required": [
        "code"
      ]
    },
    "AusEEPAExportContractedVolumeConfiguration": {
      "type": "object",
      "properties": {
        "term_type": {
          "type": "string",
          "description": "<p>The type of the contract term.</p>"
        },
        "is_variable": {
          "type": "boolean",
          "default": true,
          "description": "<p>Whether the contract term is variable in Kraken or not. If not, it must be amended by a new contract.</p>"
        },
        "periods": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/AusEEPAExportContractedVolumePeriod"
          },
          "description": "<p>A list of EEPA export contracted volume periods.</p>",
          "minItems": 1,
          "x-validators": [
            {
              "name": "Validate EEPA export contracted volume periods",
              "description": "Validate that the EEPA export contracted volume periods form a valid term: no overlapping general periods, and no supply point repeated across overlapping periods.",
              "possible_errors": [
                "invalid_eepa_export_contracted_volume"
              ]
            }
          ]
        }
      },
      "required": [
        "periods",
        "term_type"
      ]
    },
    "AusEEPAExportContractedVolumePeriod": {
      "type": "object",
      "properties": {
        "supply_point_external_identifiers": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          },
          "description": "<p>The external identifiers (NMIs) of the supply points this period applies to. Leave null to apply to all supply points not covered by a more specific period; when provided the list must not be empty.</p>",
          "minItems": 1
        },
        "unit": {
          "type": "string",
          "description": "<p>The unit for the contracted export volume (e.g. kWh).</p>"
        },
        "valid_from_date": {
          "type": "string",
          "format": "date",
          "description": "<p>The date the period is valid from (inclusive).</p>"
        },
        "valid_to_date": {
          "type": "string",
          "format": "date",
          "description": "<p>The date the period is valid to (exclusive; the period ends before this date).</p>"
        },
        "value": {
          "type": "string",
          "format": "decimal",
          "pattern": "^-?\\d{0,7}(?:\\.\\d{0,4})?$",
          "description": "<p>The contracted export volume cap for the period.</p>"
        }
      },
      "required": [
        "supply_point_external_identifiers",
        "unit",
        "valid_from_date",
        "valid_to_date",
        "value"
      ],
      "x-validators": [
        {
          "name": "Convert supply point external identifiers to IDs",
          "description": "Convert each supply point external identifier (NMI) to the internal supply point ID by looking up the supply point in the database. A null value is left unchanged and applies the period to all supply points.",
          "possible_errors": [
            "supply_point_not_found"
          ]
        },
        {
          "name": "Validate <code>⁨valid_to⁩</code> not before <code>⁨valid_from⁩</code>",
          "description": "Validates that <code>⁨valid_to⁩</code>, if given, is on or later than <code>⁨valid_from⁩</code>.",
          "possible_errors": [
            "start_date_later_than_end_date"
          ]
        }
      ]
    },
    "AusElectricityAgreement": {
      "type": "object",
      "properties": {
        "market_name": {
          "enum": [
            "AUS_ELECTRICITY"
          ],
          "type": "string",
          "x-spec-enum-id": "497cd6e4782e8889",
          "description": "<p>The market name of the supply point.</p>",
          "x-enum-descriptions": {
            "AUS_ELECTRICITY": "AUS_ELECTRICITY"
          }
        },
        "account_reference": {
          "type": "string",
          "description": "<p>The identifier of the account that owns this supply point. Must match one of the contract's subject accounts.</p>"
        },
        "agreed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "<p>The datetime the agreement was agreed at.</p>"
        },
        "business_contract_identifier": {
          "type": [
            "string",
            "null"
          ],
          "description": "<p>The identifier of the business contract this agreement should be linked to.</p>"
        },
        "characteristics": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/ProductCharacteristic"
          },
          "description": "<p>Characteristics of the agreed product that the customer has chosen.</p>",
          "x-validators": [
            {
              "name": "Validate that each child has unique values for the <code>⁨code⁩</code> field",
              "description": "Validate that each child has unique values for the <code>⁨code⁩</code> field.",
              "possible_errors": [
                "children_with_duplicate_values"
              ]
            }
          ]
        },
        "effective_from": {
          "type": "string",
          "format": "date",
          "description": "<p>The date from which the agreement is effective (inclusive), i.e. the agreement starts on the midnight of this date, such that this date becomes the first day covered by this agreement.</p>"
        },
        "effective_to": {
          "type": [
            "string",
            "null"
          ],
          "format": "date",
          "description": "<p>The date to which the agreement is effective (exclusive), i.e. the agreement will end on the midnight of this date, such that the previous day is the last day covered by this agreement.</p>"
        },
        "intermediary": {
          "allOf": [
            {
              "$ref": "#/$defs/AgreementIntermediaryDetails"
            }
          ],
          "description": "<p>Details about the intermediary relationship for this agreement. When provided, an intermediary link will be created between the agreement and the portfolio, establishing a business intermediary relationship.</p>"
        },
        "product_addons": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/AusAgreementAddOn"
          },
          "description": "<p>A list of product addons that apply to the specific agreement.</p>"
        },
        "rate_overrides": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "format": "decimal",
            "pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$"
          },
          "description": "<p>Agreement rate overrides.</p>"
        },
        "rates_agreed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "<p>The datetime the rates were agreed at.</p>"
        },
        "supply_point_identifier": {
          "type": "string",
          "description": "<p>The identifier of the supply point to add the agreement to.</p>"
        },
        "tariff_code": {
          "type": "string",
          "description": "<p>The code for the agreement tariff. Must match an existing tariff code of an active product.</p>",
          "x-validators": [
            {
              "name": "Validate product code exists",
              "description": "Validate that the product code exists in Kraken.",
              "possible_errors": [
                "product_code_does_not_exist"
              ]
            }
          ]
        }
      },
      "required": [
        "account_reference",
        "effective_from",
        "market_name",
        "supply_point_identifier",
        "tariff_code"
      ],
      "x-validators": [
        {
          "name": "Validate <code>⁨effective_to⁩</code> not before <code>⁨effective_from⁩</code>",
          "description": "Validates that <code>⁨effective_to⁩</code>, if given, is on or later than <code>⁨effective_from⁩</code>.",
          "possible_errors": [
            "start_date_later_than_end_date"
          ]
        }
      ]
    },
    "AusEmbeddedElectricityAgreement": {
      "type": "object",
      "properties": {
        "market_name": {
          "enum": [
            "AUS_EMBEDDED_ELECTRICITY"
          ],
          "type": "string",
          "x-spec-enum-id": "eaeb85db1513ab66",
          "description": "<p>The market name of the supply point.</p>",
          "x-enum-descriptions": {
            "AUS_EMBEDDED_ELECTRICITY": "AUS_EMBEDDED_ELECTRICITY"
          }
        },
        "account_reference": {
          "type": "string",
          "description": "<p>The identifier of the account that owns this supply point. Must match one of the contract's subject accounts.</p>"
        },
        "agreed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "<p>The datetime the agreement was agreed at.</p>"
        },
        "business_contract_identifier": {
          "type": [
            "string",
            "null"
          ],
          "description": "<p>The identifier of the business contract this agreement should be linked to.</p>"
        },
        "characteristics": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/ProductCharacteristic"
          },
          "description": "<p>Characteristics of the agreed product that the customer has chosen.</p>",
          "x-validators": [
            {
              "name": "Validate that each child has unique values for the <code>⁨code⁩</code> field",
              "description": "Validate that each child has unique values for the <code>⁨code⁩</code> field.",
              "possible_errors": [
                "children_with_duplicate_values"
              ]
            }
          ]
        },
        "effective_from": {
          "type": "string",
          "format": "date",
          "description": "<p>The date from which the agreement is effective (inclusive), i.e. the agreement starts on the midnight of this date, such that this date becomes the first day covered by this agreement.</p>"
        },
        "effective_to": {
          "type": [
            "string",
            "null"
          ],
          "format": "date",
          "description": "<p>The date to which the agreement is effective (exclusive), i.e. the agreement will end on the midnight of this date, such that the previous day is the last day covered by this agreement.</p>"
        },
        "intermediary": {
          "allOf": [
            {
              "$ref": "#/$defs/AgreementIntermediaryDetails"
            }
          ],
          "description": "<p>Details about the intermediary relationship for this agreement. When provided, an intermediary link will be created between the agreement and the portfolio, establishing a business intermediary relationship.</p>"
        },
        "product_addons": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/AusAgreementAddOn"
          },
          "description": "<p>A list of product addons that apply to the specific agreement.</p>"
        },
        "rate_overrides": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "format": "decimal",
            "pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$"
          },
          "description": "<p>Agreement rate overrides.</p>"
        },
        "rates_agreed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "<p>The datetime the rates were agreed at.</p>"
        },
        "supply_point_identifier": {
          "type": "string",
          "description": "<p>The identifier of the supply point to add the agreement to.</p>"
        },
        "tariff_code": {
          "type": "string",
          "description": "<p>The code for the agreement tariff. Must match an existing tariff code of an active product.</p>",
          "x-validators": [
            {
              "name": "Validate product code exists",
              "description": "Validate that the product code exists in Kraken.",
              "possible_errors": [
                "product_code_does_not_exist"
              ]
            }
          ]
        }
      },
      "required": [
        "account_reference",
        "effective_from",
        "market_name",
        "supply_point_identifier",
        "tariff_code"
      ],
      "x-validators": [
        {
          "name": "Validate <code>⁨effective_to⁩</code> not before <code>⁨effective_from⁩</code>",
          "description": "Validates that <code>⁨effective_to⁩</code>, if given, is on or later than <code>⁨effective_from⁩</code>.",
          "possible_errors": [
            "start_date_later_than_end_date"
          ]
        }
      ]
    },
    "AusEmbeddedGasAgreement": {
      "type": "object",
      "properties": {
        "market_name": {
          "enum": [
            "AUS_EMBEDDED_GAS"
          ],
          "type": "string",
          "x-spec-enum-id": "474da700104b555f",
          "description": "<p>The market name of the supply point.</p>",
          "x-enum-descriptions": {
            "AUS_EMBEDDED_GAS": "AUS_EMBEDDED_GAS"
          }
        },
        "account_reference": {
          "type": "string",
          "description": "<p>The identifier of the account that owns this supply point. Must match one of the contract's subject accounts.</p>"
        },
        "agreed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "<p>The datetime the agreement was agreed at.</p>"
        },
        "business_contract_identifier": {
          "type": [
            "string",
            "null"
          ],
          "description": "<p>The identifier of the business contract this agreement should be linked to.</p>"
        },
        "characteristics": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/ProductCharacteristic"
          },
          "description": "<p>Characteristics of the agreed product that the customer has chosen.</p>",
          "x-validators": [
            {
              "name": "Validate that each child has unique values for the <code>⁨code⁩</code> field",
              "description": "Validate that each child has unique values for the <code>⁨code⁩</code> field.",
              "possible_errors": [
                "children_with_duplicate_values"
              ]
            }
          ]
        },
        "effective_from": {
          "type": "string",
          "format": "date",
          "description": "<p>The date from which the agreement is effective (inclusive), i.e. the agreement starts on the midnight of this date, such that this date becomes the first day covered by this agreement.</p>"
        },
        "effective_to": {
          "type": [
            "string",
            "null"
          ],
          "format": "date",
          "description": "<p>The date to which the agreement is effective (exclusive), i.e. the agreement will end on the midnight of this date, such that the previous day is the last day covered by this agreement.</p>"
        },
        "intermediary": {
          "allOf": [
            {
              "$ref": "#/$defs/AgreementIntermediaryDetails"
            }
          ],
          "description": "<p>Details about the intermediary relationship for this agreement. When provided, an intermediary link will be created between the agreement and the portfolio, establishing a business intermediary relationship.</p>"
        },
        "product_addons": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/AusAgreementAddOn"
          },
          "description": "<p>A list of product addons that apply to the specific agreement.</p>"
        },
        "rate_overrides": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "format": "decimal",
            "pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$"
          },
          "description": "<p>Agreement rate overrides.</p>"
        },
        "rates_agreed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "<p>The datetime the rates were agreed at.</p>"
        },
        "supply_point_identifier": {
          "type": "string",
          "description": "<p>The identifier of the supply point to add the agreement to.</p>"
        },
        "tariff_code": {
          "type": "string",
          "description": "<p>The code for the agreement tariff. Must match an existing tariff code of an active product.</p>",
          "x-validators": [
            {
              "name": "Validate product code exists",
              "description": "Validate that the product code exists in Kraken.",
              "possible_errors": [
                "product_code_does_not_exist"
              ]
            }
          ]
        }
      },
      "required": [
        "account_reference",
        "effective_from",
        "market_name",
        "supply_point_identifier",
        "tariff_code"
      ],
      "x-validators": [
        {
          "name": "Validate <code>⁨effective_to⁩</code> not before <code>⁨effective_from⁩</code>",
          "description": "Validates that <code>⁨effective_to⁩</code>, if given, is on or later than <code>⁨effective_from⁩</code>.",
          "possible_errors": [
            "start_date_later_than_end_date"
          ]
        }
      ]
    },
    "AusEmbeddedUnmeteredElectricityAgreement": {
      "type": "object",
      "properties": {
        "market_name": {
          "enum": [
            "AUS_EMBEDDED_UNMETERED_ELECTRICITY"
          ],
          "type": "string",
          "x-spec-enum-id": "f42813c05e71afe0",
          "description": "<p>The market name of the supply point.</p>",
          "x-enum-descriptions": {
            "AUS_EMBEDDED_UNMETERED_ELECTRICITY": "AUS_EMBEDDED_UNMETERED_ELECTRICITY"
          }
        },
        "account_reference": {
          "type": "string",
          "description": "<p>The identifier of the account that owns this supply point. Must match one of the contract's subject accounts.</p>"
        },
        "agreed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "<p>The datetime the agreement was agreed at.</p>"
        },
        "business_contract_identifier": {
          "type": [
            "string",
            "null"
          ],
          "description": "<p>The identifier of the business contract this agreement should be linked to.</p>"
        },
        "characteristics": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/ProductCharacteristic"
          },
          "description": "<p>Characteristics of the agreed product that the customer has chosen.</p>",
          "x-validators": [
            {
              "name": "Validate that each child has unique values for the <code>⁨code⁩</code> field",
              "description": "Validate that each child has unique values for the <code>⁨code⁩</code> field.",
              "possible_errors": [
                "children_with_duplicate_values"
              ]
            }
          ]
        },
        "effective_from": {
          "type": "string",
          "format": "date",
          "description": "<p>The date from which the agreement is effective (inclusive), i.e. the agreement starts on the midnight of this date, such that this date becomes the first day covered by this agreement.</p>"
        },
        "effective_to": {
          "type": [
            "string",
            "null"
          ],
          "format": "date",
          "description": "<p>The date to which the agreement is effective (exclusive), i.e. the agreement will end on the midnight of this date, such that the previous day is the last day covered by this agreement.</p>"
        },
        "intermediary": {
          "allOf": [
            {
              "$ref": "#/$defs/AgreementIntermediaryDetails"
            }
          ],
          "description": "<p>Details about the intermediary relationship for this agreement. When provided, an intermediary link will be created between the agreement and the portfolio, establishing a business intermediary relationship.</p>"
        },
        "product_addons": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/AusAgreementAddOn"
          },
          "description": "<p>A list of product addons that apply to the specific agreement.</p>"
        },
        "rate_overrides": {
          "type": "object",
          "additionalProperties": {
            "type": "string",
            "format": "decimal",
            "pattern": "^-?\\d{0,10}(?:\\.\\d{0,5})?$"
          },
          "description": "<p>Agreement rate overrides.</p>"
        },
        "rates_agreed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "<p>The datetime the rates were agreed at.</p>"
        },
        "supply_point_identifier": {
          "type": "string",
          "description": "<p>The identifier of the supply point to add the agreement to.</p>"
        },
        "tariff_code": {
          "type": "string",
          "description": "<p>The code for the agreement tariff. Must match an existing tariff code of an active product.</p>",
          "x-validators": [
            {
              "name": "Validate product code exists",
              "description": "Validate that the product code exists in Kraken.",
              "possible_errors": [
                "product_code_does_not_exist"
              ]
            }
          ]
        }
      },
      "required": [
        "account_reference",
        "effective_from",
        "market_name",
        "supply_point_identifier",
        "tariff_code"
      ],
      "x-validators": [
        {
          "name": "Validate <code>⁨effective_to⁩</code> not before <code>⁨effective_from⁩</code>",
          "description": "Validates that <code>⁨effective_to⁩</code>, if given, is on or later than <code>⁨effective_from⁩</code>.",
          "possible_errors": [
            "start_date_later_than_end_date"
          ]
        }
      ]
    },
    "AusEmbeddedUnmeteredGasAgreement": {
      "type": "object",
      "properties": {
        "market_name": {
          "enum": [
            "AUS_EMBEDDED_UNMETERED_GAS"
          ],
          "type": "string",
          "x-spec-enum-id": "2908a0235ee48f24",
          "description": "<p>The market name of the supply point.</p>",
          "x-enum-descriptions": {
            "AUS_EMBEDDED_UNMETERED_GAS": "AUS_EMBEDDED_UNMETERED_GAS"
          }
        },
        "account_reference": {
          "type": "string",
          "description": "<p>The identifier of the account that owns this supply point. Must match one of the contract's subject accounts.</p>"
        },
        "agreed_at": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "<p>The datetime the agreement was agreed at.</p>"
        },
        "business_contract_identifier": {
          "type": [
            "string",
            "null"
          ],
          "description": "<p>The identifier of the business contract this agreement should be linked to.</p>"
        },
        "characteristics": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/ProductCharacteristic"
          },
          "description": "<p>Characteristics of the agreed product that the customer has chosen.</p>",
          "x-validators": [
            {
              "name": "Validate that each child has unique values for the <code>⁨code⁩</code> field",
              "description": "Validate that each child has unique values for the <code>⁨code⁩</code>

# --- truncated at 32 KB (195 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/origin-energy/refs/heads/main/json-schema/origin-energy-schedule-order-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/origin-energy-schedule-order"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.