openapi: 3.2.0 info: title: Eliq Data Management Meter Price Formulas API description: '# API Reference The Eliq data management API is organized around REST.' contact: name: Support email: support_b2b@eliq.com version: 1.5.2 tags: - name: Meter Price Formulas paths: /meters/{meterId}/priceformulas: get: tags: - Meter Price Formulas summary: Get price formulas for a meter by meter external reference operationId: get-meter-meterid-price-formulas parameters: - name: meterId in: path description: External meter id required: true schema: type: string example: abc123 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/PriceFormula' examples: Price formulas: value: - from: '2024-01-01' to: '2024-12-31' currency_code: SEK elements: - name: Time of use type: unit_rate unit_rate: type: tou tou: register_id: '1' unit_rate: 1.0 intervals: - from_minute: 0 to_minute: 60 - name: Fixed unit rate type: unit_rate unit_rate: type: fixed fixed: unit_rate: 1.0 energy_unit: kwh '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Parameter 'id' must not be null or empty: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a Meter with the given 'meter_id' could not be found. Meter was either deleted or not imported.: value: code: PRICE_FORMULA_METER_NOT_FOUND description: Meter with the given 'meter_id' could not be found. Meter was either deleted or not imported. request_id: 65e2ea86-470f-4363-9295-35d6b473981a '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Location with given id could not be found: value: code: LOCATION_NOT_FOUND description: Location with given id could not be found request_id: 65e2ea86-470f-4363-9295-35d6b473981a '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Internal server error. If problem remains, please contact support: value: code: INTERNAL_ERROR description: Internal server error. If problem remains, please contact support request_id: 65e2ea86-470f-4363-9295-35d6b473981a post: tags: - Meter Price Formulas summary: Add or update a price formula for a meter by meter external reference operationId: add-or-update-meter-price-formulas parameters: - name: meterId in: path description: External meter id required: true schema: type: string example: abc123 requestBody: description: Price formula cbject containing all needed details content: application/json: schema: $ref: '#/components/schemas/PriceFormula' examples: Price formula: value: name: Tariff from: '2024-01-01' to: '2024-12-31' currency_code: SEK elements: - name: Time of use type: unit_rate unit_rate: type: tou tou: register_id: '1' unit_rate: 1.0 intervals: - from_minute: 0 to_minute: 60 - name: Fixed unit rate type: unit_rate unit_rate: type: fixed fixed: unit_rate: 1.0 energy_unit: kwh responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/PriceFormula' examples: Price formula: value: name: Tariff from: '2024-01-01' to: '2024-12-31' currency_code: SEK elements: - name: Time of use type: unit_rate unit_rate: type: tou tou: register_id: '1' unit_rate: 1.0 intervals: - from_minute: 0 to_minute: 60 - name: Fixed unit rate type: unit_rate unit_rate: type: fixed fixed: unit_rate: 1.0 energy_unit: kwh '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Request input is missing. This may be caused by incorrect format of input.: value: code: INPUT_MISSING description: Request input is missing. This may be caused by incorrect format of input. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements' must not be null or empty.: value: code: PRICE_FORMULA_ELEMENTS_MISSING description: Parameter 'elements' must not be null or empty. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'from' must not be null or empty. This may be caused by incorrect format of input.: value: code: PRICE_FORMULA_FROM_DATE_MISSING description: Parameter 'from' must not be null or empty. This may be caused by incorrect format of input. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'to' must not be null or empty. This may be caused by incorrect format of input.: value: code: PRICE_FORMULA_TO_DATE_MISSING description: Parameter 'to' must not be null or empty. This may be caused by incorrect format of input. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'from' must not be in the same date or after parameter 'to'.: value: code: PRICE_FORMULA_FROM_DATE_INVALID description: Parameter 'from' must not be in the same date or after parameter 'to'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'id' must not be null or empty: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a Price formula cannot be null or empty: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a Meter with the given 'meter_id' could not be found. Meter was either deleted or not imported.: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].unit_rate' must be null for 'elements[].type = charge'.: value: code: PRICE_FORMULA_ELEMENT_CHARGE_INVALID description: Parameter 'elements[].unit_rate' must be null for 'elements[].type = charge'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].charge' must be null for 'elements[].type = unit_rate'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_INVALID description: Parameter 'elements[].charge' must be null for 'elements[].type = unit_rate'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].unit_rate' must not be null or empty for 'elements[].type = unit_rate'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_MISSING description: Parameter 'elements[].unit_rate' must not be null or empty for 'elements[].type = unit_rate'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].charge' must not be null or empty for 'elements[].type = charge'.: value: code: PRICE_FORMULA_ELEMENT_CHARGE_MISSING description: Parameter 'elements[].charge' must not be null or empty for 'elements[].type = charge'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.[tou,nordpool,block]' must be null for 'elements[].unit_rate.type = fixed': value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_VALUE_FOR_TYPE_FIXED_INVALID description: Parameters 'elements[].unit_rate.[tou,nordpool,block]' must be null for 'elements[].unit_rate.type = fixed' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.[tou,fix,block]' must be null for 'elements[].unit_rate.type = nordpool': value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_VALUE_FOR_TYPE_NORDPOOL_INVALID description: Parameters 'elements[].unit_rate.[tou,fix,block]' must be null for 'elements[].unit_rate.type = nordpool' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.[tou,fix,norpool]' must be null for 'elements[].unit_rate.type = block': value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_VALUE_FOR_TYPE_BLOCK_INVALID description: Parameters 'elements[].unit_rate.[tou,fix,norpool]' must be null for 'elements[].unit_rate.type = block' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.[block,fix,norpool]' must be null for 'elements[].unit_rate.type = tou': value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_VALUE_FOR_TYPE_TOU_INVALID description: Parameters 'elements[].unit_rate.[block,fix,norpool]' must be null for 'elements[].unit_rate.type = tou' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block' must not be null for 'elements[].unit_rate.type = block': value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_BLOCK_MISSING description: Parameters 'elements[].unit_rate.block' must not be null for 'elements[].unit_rate.type = block' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.register_id' must not be null or empty for 'elements[].unit_rate.type = block'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_BLOCK_REGISTER_ID_MISSING description: Parameters 'elements[].unit_rate.block.register_id' must not be null or empty for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.unit_rate' must not be equal to 0 for 'elements[].unit_rate.type = block'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_BLOCK_VALUE_INVALID description: Parameters 'elements[].unit_rate.block.unit_rate' must not be equal to 0 for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameters 'elements[].unit_rate.block.from_kwh' cannot be equal or bigger 'elements[].unit_rate.block.to_kwh' for 'elements[].unit_rate.type = block'. : value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_BLOCK_FROM_KWH_INVALID description: Parameters 'elements[].unit_rate.block.from_kwh' cannot be equal or bigger 'elements[].unit_rate.block.to_kwh' for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.fixed' must not be null for 'elements[].unit_rate.type = fixed'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_FIXED_MISSING description: Parameters 'elements[].unit_rate.fixed' must not be null for 'elements[].unit_rate.type = fixed'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.fixed.unit_rate' must not be equal to 0 for 'elements[].unit_rate.type = fixed'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_FIXED_VALUE_INVALID description: Parameters 'elements[].unit_rate.fixed.unit_rate' must not be equal to 0 for 'elements[].unit_rate.type = fixed'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.nordpool' must not be null for 'elements[].unit_rate.type = nordpool'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_NORDPOOL_MISSING description: Parameters 'elements[].unit_rate.nordpool' must not be null for 'elements[].unit_rate.type = nordpool'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.nordpool.region' must not be null for 'elements[].unit_rate.type = nordpool'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_NORDPOOL_REGION_MISSING description: Parameters 'elements[].unit_rate.nordpool.region' must not be null for 'elements[].unit_rate.type = nordpool'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameters 'elements[].unit_rate.nordpool.multiplier' must not be equal or less than 0 for 'elements[].unit_rate.type = nordpool'. : value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_NORDPOOL_MULTIPLIER_INVALID description: Parameters 'elements[].unit_rate.nordpool.multiplier' must not be equal or less than 0 for 'elements[].unit_rate.type = nordpool'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.tou' must not be null for 'elements[].unit_rate.type = tou': value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_MISSING description: Parameters 'elements[].unit_rate.tou' must not be null for 'elements[].unit_rate.type = tou' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.tou.register_id' must not be null for 'elements[].unit_rate.type = tou'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_REGISTER_ID_MISSING description: Parameters 'elements[].unit_rate.tou.register_id' must not be null for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.tou.unit_rate' must not be null, or equal to 0 for 'elements[].unit_rate.type = tou'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_VALUE_INVALID description: Parameters 'elements[].unit_rate.tou.unit_rate' must not be null, or equal to 0 for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.tou.intervals[]' must not be empty or null for 'elements[].unit_rate.type = tou'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_VALUE_TOU_INTERVALS_MISSING description: Parameters 'elements[].unit_rate.tou.intervals[]' must not be empty or null for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'currency_code' must not be null or empty: value: code: PRICE_FORMULA_CURRENCY_CODE_MISSING description: Parameter 'currency_code' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'element[].name' must not be null or empty.: value: code: PRICE_FORMULA_ELEMENT_NAME_MISSING description: Parameter 'element[].name' must not be null or empty. request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameters 'elements[].unit_rate.tou.intervals[].from_minute' cannot be more than 1440 for 'elements[].unit_rate.type = tou'. : value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_INTERVALS_FROM_MINUTE_INVALID description: Parameters 'elements[].unit_rate.tou.intervals[].from_minute' cannot be more than 1440 for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameters 'elements[].unit_rate.tou.intervals[].to_minute' cannot be more than 1440 for 'elements[].unit_rate.type = tou'. : value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_INTERVALS_TO_MINUTE_INVALID description: Parameters 'elements[].unit_rate.tou.intervals[].to_minute' cannot be more than 1440 for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.tou.intervals[].from_minute' cannot be less than 0 for 'elements[].unit_rate.type = tou'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_INTERVALS_FROM_MINUTE_INVALID description: Parameters 'elements[].unit_rate.tou.intervals[].from_minute' cannot be less than 0 for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.tou.intervals[].to_minute' cannot be less than 0 for 'elements[].unit_rate.type = tou'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_INTERVALS_TO_MINUTE_INVALID description: Parameters 'elements[].unit_rate.tou.intervals[].to_minute' cannot be less than 0 for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameters 'elements[].unit_rate.tou.intervals[].from_minute' cannot be null or less than 0 for 'elements[].unit_rate.type = tou'. : value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_INTERVALS_FROM_MINUTE_MISSING description: Parameters 'elements[].unit_rate.tou.intervals[].from_minute' cannot be null or less than 0 for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.tou.intervals[].to_minute' cannot be null for 'elements[].unit_rate.type = tou'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_INTERVALS_TO_MINUTE_MISSING description: Parameters 'elements[].unit_rate.tou.intervals[].to_minute' cannot be null for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.from_kwh' cannot be null for 'elements[].unit_rate.type = block'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_BLOCK_FROM_KWH_MISSING description: Parameters 'elements[].unit_rate.block.from_kwh' cannot be null for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.to_kwh' cannot be null for 'elements[].unit_rate.type = block'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_BLOCK_TO_KWH_MISSING description: Parameters 'elements[].unit_rate.block.to_kwh' cannot be null for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.nordpool.region' is invalid for 'elements[].unit_rate.type = nordpool'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_NORDPOOL_REGION_INVALID description: Parameters 'elements[].unit_rate.nordpool.region' is invalid for 'elements[].unit_rate.type = nordpool'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].charge.charge' must not be null for 'elements[].type = charge'.: value: code: PRICE_FORMULA_ELEMENT_CHARGE_VALUE_MISSING description: Parameter 'elements[].charge.charge' must not be null for 'elements[].type = charge'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.fixed.unit_rate' must not be null: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_FIXED_VALUE_MISSING description: Parameters 'elements[].unit_rate.fixed.unit_rate' must not be null request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.tou.unit_rate' must not be null for 'elements[].unit_rate.type = tou'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TOU_VALUE_MISSING description: Parameters 'elements[].unit_rate.tou.unit_rate' must not be null for 'elements[].unit_rate.type = tou'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'currency_code' invalid: value: code: PRICE_FORMULA_CURRENCY_CODE_INVALID description: Parameter 'currency_code' invalid request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.weekdays' must not be empty': value: code: PRICE_FORMULA_UNIT_RATE_WEEKDAYS_VALUES_MISSING description: Parameters 'elements[].unit_rate.weekdays' must not be empty' request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameters 'elements[].unit_rate.weekdays' values must only contain valid weekdays like 'Monday', 'Tuesday', 'Wednesday', etc.' : value: code: PRICE_FORMULA_UNIT_RATE_WEEKDAYS_VALUES_INVALID description: Parameters 'elements[].unit_rate.weekdays' values must only contain valid weekdays like 'Monday', 'Tuesday', 'Wednesday', etc.' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.weekdays' values must not contain any duplicates': value: code: PRICE_FORMULA_UNIT_RATE_WEEKDAYS_VALUES_CONTAINS_DUPLICATES description: Parameters 'elements[].unit_rate.weekdays' values must not contain any duplicates' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'fuel' must not be null: value: code: PRICE_FORMULA_FUEL_MISSING description: Parameter 'fuel' must not be null request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'fuel' invalid: value: code: PRICE_FORMULA_FUEL_INVALID description: Parameter 'fuel' invalid request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'direction' must not be null: value: code: PRICE_FORMULA_DIRECTION_MISSING description: Parameter 'direction' must not be null request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'direction' invalid: value: code: PRICE_FORMULA_DIRECTION_INVALID description: Parameter 'direction' invalid request_id: 65e2ea86-470f-4363-9295-35d6b473981a Found multiple price formulas starting from the same 'from' date.: value: code: PRICE_FORMULA_DUPLICATES_FOUND description: Found multiple price formulas starting from the same 'from' date. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'from' cannot overlap with already existing price formula.: value: code: PRICE_FORMULA_FROM_DATE_IS_OVERLAP_EXISTING_PRICE_FORMULA description: Parameter 'from' cannot overlap with already existing price formula. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'to' cannot overlap with already existing price formula.: value: code: PRICE_FORMULA_TO_DATE_IS_OVERLAP_EXISTING_PRICE_FORMULA description: Parameter 'to' cannot overlap with already existing price formula. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'from' cannot be outside device supply date range (start -> end dates).: value: code: PRICE_FORMULA_FROM_DATE_OUTSIDE_DEVICE_SUPPLY_DATE_RANGE description: Parameter 'from' cannot be outside device supply date range (start -> end dates). request_id: 65e2ea86-470f-4363-9295-35d6b473981a 'Parameters ''elements[].type'' is invalid. Must be one of: [''charge'', ''unit_rate'']': value: code: PRICE_FORMULA_ELEMENT_TYPE_INVALID description: 'Parameters ''elements[].type'' is invalid. Must be one of: [''charge'', ''unit_rate'']' request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].type' cannot be null or empty.: value: code: PRICE_FORMULA_ELEMENT_TYPE_MISSING description: Parameters 'elements[].type' cannot be null or empty. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.type' cannot be null or empty.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TYPE_MISSING description: Parameters 'elements[].unit_rate.type' cannot be null or empty. request_id: 65e2ea86-470f-4363-9295-35d6b473981a 'Parameters ''elements[].unit_rate.type'' is invalid. Must be one of: [''fixed'', ''tou'', ''nordpool'', ''block'']': value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_TYPE_INVALID description: 'Parameters ''elements[].unit_rate.type'' is invalid. Must be one of: [''fixed'', ''tou'', ''nordpool'', ''block'']' request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameters 'elements[].unit_rate.block.resolution' is invalid. Only valid values are 'day' and 'year' for 'elements[].unit_rate.type = block'. : value: code: PRICE_FORMULA_ELEMENT_BLOCK_RESOLUTION_TYPE_INVALID description: Parameters 'elements[].unit_rate.block.resolution' is invalid. Only valid values are 'day' and 'year' for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.nordpool.resolution' is invalid. Only valid value is 'hour'.: value: code: PRICE_FORMULA_ELEMENT_NORDPOOL_RESOLUTION_TYPE_INVALID description: Parameters 'elements[].unit_rate.nordpool.resolution' is invalid. Only valid value is 'hour'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.nordpool.resolution' cannot be null or empty.: value: code: PRICE_FORMULA_ELEMENT_NORDPOOL_RESOLUTION_TYPE_MISSING description: Parameters 'elements[].unit_rate.nordpool.resolution' cannot be null or empty. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].charge.resolution' is invalid. Must be one of ['day', 'month'].: value: code: PRICE_FORMULA_ELEMENT_CHARGE_RESOLUTION_INVALID description: Parameter 'elements[].charge.resolution' is invalid. Must be one of ['day', 'month']. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].charge.resolution' must not be null or empty for 'elements[].type = charge'.: value: code: PRICE_FORMULA_ELEMENT_CHARGE_RESOLUTION_MISSING description: Parameter 'elements[].charge.resolution' must not be null or empty for 'elements[].type = charge'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.resolution' cannot be null or empty for 'elements[].unit_rate.type = block'.: value: code: PRICE_FORMULA_ELEMENT_BLOCK_RESOLUTION_TYPE_MISSING description: Parameters 'elements[].unit_rate.block.resolution' cannot be null or empty for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Invalid parameter source. Only 'client' or 'user' is valid.: value: code: INVALID_PRICE_FORMULA_SOURCE description: Invalid parameter source. Only 'client' or 'user' is valid. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'energy_unit' invalid. Only 'kwh' or 'm3' is valid.: value: code: INVALID_PRICE_FORMULA_ENERGY_UNIT description: Parameter 'energy_unit' invalid. Only 'kwh' or 'm3' is valid. request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Price formula already added by source 'client'. Cannot add price formula by source 'user' if price formula by source 'Client' is already added. : value: code: PRICE_FORMULA_ALREADY_ADDED_BY_SOURCE_CLIENT description: Price formula already added by source 'client'. Cannot add price formula by source 'user' if price formula by source 'Client' is already added. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'meter_id' must not be null or empty.: value: code: PRICE_FORMULA_DEVICE_ID_MISSING description: Parameter 'meter_id' must not be null or empty. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'element' must not be null or empty.: value: code: PRICE_FORMULA_ELEMENT_MISSING description: Parameter 'element' must not be null or empty. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.[tou,fix,block,nordpool]' must be null for 'elements[].unit_rate.type = spot_price'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_VALUE_FOR_TYPE_SPOT_PRICE_INVALID description: Parameters 'elements[].unit_rate.[tou,fix,block,nordpool]' must be null for 'elements[].unit_rate.type = spot_price'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.from_m3' is invalid for 'elements[].unit_rate.type = block'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_BLOCK_FROM_M3_INVALID description: Parameters 'elements[].unit_rate.block.from_m3' is invalid for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.from_m3' cannot be null for 'elements[].unit_rate.type = block'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_BLOCK_FROM_M3_MISSING description: Parameters 'elements[].unit_rate.block.from_m3' cannot be null for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.to_m3' cannot be null for 'elements[].unit_rate.type = block'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_BLOCK_TO_M3_MISSING description: Parameters 'elements[].unit_rate.block.to_m3' cannot be null for 'elements[].unit_rate.type = block'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.nordpool.resolution' must not be null for 'elements[].unit_rate.type = nordpool'.: value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_NORDPOOL_RESOLUTION_MISSING description: Parameters 'elements[].unit_rate.nordpool.resolution' must not be null for 'elements[].unit_rate.type = nordpool'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.tou.intervals[]' cannot be provided together with skip intervals.: value: code: PRICE_FORMULA_UNIT_RATE_VALUE_TOU_INTERVALS_INCLUDED_WITH_SKIP_INTERVALS description: Parameters 'elements[].unit_rate.tou.intervals[]' cannot be provided together with skip intervals. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Location for the price formula is invalid.: value: code: PRICE_FORMULA_LOCATION_INVALID description: Location for the price formula is invalid. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.from_kwh/to_kwh' not allowed when energy unit is m3.: value: code: PRICE_FORMULA_UNIT_RATE_BLOCK_FROM_TO_KWH_NOT_ALLOWED_ENERGY_UNIT_M3 description: Parameters 'elements[].unit_rate.block.from_kwh/to_kwh' not allowed when energy unit is m3. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.block.from_m3/to_m3' not allowed when energy unit is kwh.: value: code: PRICE_FORMULA_UNIT_RATE_BLOCK_FROM_TO_M3_NOT_ALLOWED_ENERGY_UNIT_KWH description: Parameters 'elements[].unit_rate.block.from_m3/to_m3' not allowed when energy unit is kwh. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].charge.capacity_tariff' must not be null.: value: code: PRICE_FORMULA_CHARGE_CAPACITY_TARIFF_MISSING description: Parameter 'elements[].charge.capacity_tariff' must not be null. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].charge.capacity_tariff.calculation_type' must not be null.: value: code: PRICE_FORMULA_CHARGE_CAPACITY_TARIFF_CALCULATION_TYPE_MISSING description: Parameter 'elements[].charge.capacity_tariff.calculation_type' must not be null. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Price formula has a date range gap with the previous price formula.: value: code: PRICE_FORMULA_HAVE_DATE_RANGE_GAP_WITH_PREVIOUS_PRICE_FORMULA description: Price formula has a date range gap with the previous price formula. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Price formula has a date range gap with the next price formula.: value: code: PRICE_FORMULA_HAVE_DATE_RANGE_GAP_WITH_NEXT_PRICE_FORMULA description: Price formula has a date range gap with the next price formula. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.spot_price' must not be null for 'elements[].unit_rate.type = spot_price'.: value: code: PRICE_FORMULA_UNIT_RATE_SPOT_PRICE_MISSING description: Parameters 'elements[].unit_rate.spot_price' must not be null for 'elements[].unit_rate.type = spot_price'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.spot_price.region' must not be null for 'elements[].unit_rate.type = spot_price'.: value: code: PRICE_FORMULA_UNIT_RATE_SPOT_PRICE_REGION_MISSING description: Parameters 'elements[].unit_rate.spot_price.region' must not be null for 'elements[].unit_rate.type = spot_price'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.spot_price.region' is invalid for 'elements[].unit_rate.type = spot_price'.: value: code: PRICE_FORMULA_UNIT_RATE_SPOT_PRICE_REGION_INVALID description: Parameters 'elements[].unit_rate.spot_price.region' is invalid for 'elements[].unit_rate.type = spot_price'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameters 'elements[].unit_rate.spot_price.resolution' must not be null for 'elements[].unit_rate.type = spot_price'.: value: code: PRICE_FORMULA_UNIT_RATE_SPOT_PRICE_RESOLUTION_MISSING description: Parameters 'elements[].unit_rate.spot_price.resolution' must not be null for 'elements[].unit_rate.type = spot_price'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a ? Parameter 'elements[].unit_rate.spot_price.multiplier' must not be less than 0 for 'elements[].unit_rate.type = spot_price'. : value: code: PRICE_FORMULA_ELEMENT_UNIT_RATE_SPOT_PRICE_MULTIPLIER_INVALID description: Parameter 'elements[].unit_rate.spot_price.multiplier' must not be less than 0 for 'elements[].unit_rate.type = spot_price'. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'capacity_tariff.calculation_type' must not be null.: value: code: MISSING_PRICE_FORMULA_CAPACITY_TARIFF_CALCULATION_TYPE description: Parameter 'capacity_tariff.calculation_type' must not be null. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].charge.type' must not be null.: value: code: PRICE_FORMULA_CHARGE_TYPE_MISSING description: Parameter 'elements[].charge.type' must not be null. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].charge.type' is invalid.: value: code: INVALID_PRICE_FORMULA_CHARGE_TYPE description: Parameter 'elements[].charge.type' is invalid. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].unit_rate.spot_price.provider' must not be null.: value: code: MISSING_PRICE_FORMULA_SPOT_PRICE_PROVIDER description: Parameter 'elements[].unit_rate.spot_price.provider' must not be null. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].unit_rate.spot_price.resolution' must not be null.: value: code: MISSING_PRICE_FORMULA_SPOT_PRICE_RESOLUTION description: Parameter 'elements[].unit_rate.spot_price.resolution' must not be null. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].unit_rate.spot_price.region' must not be null.: value: code: MISSING_PRICE_FORMULA_SPOT_PRICE_REGION description: Parameter 'elements[].unit_rate.spot_price.region' must not be null. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].unit_rate.spot_price.resolution' is invalid.: value: code: INVALID_PRICE_FORMULA_SPOT_PRICE_RESOLUTION description: Parameter 'elements[].unit_rate.spot_price.resolution' is invalid. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'elements[].unit_rate.spot_price.provider' is invalid.: value: code: INVALID_PRICE_FORMULA_SPOT_PRICE_PROVIDER description: Parameter 'elements[].unit_rate.spot_price.provider' is invalid. request_id: 65e2ea86-470f-4363-9295-35d6b473981a '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Internal server error. If problem remains, please contact support: value: code: INTERNAL_ERROR description: Internal server error. If problem remains, please contact support request_id: 65e2ea86-470f-4363-9295-35d6b473981a /meters/{meterId}/priceformulas/{fromDate}: delete: tags: - Meter Price Formulas summary: Delete a price formulas for a meter by meter external reference and older than… operationId: delete-meter-from-date-price-formulas parameters: - name: meterId in: path description: External meter id required: true schema: type: string example: abc123 - name: fromDate in: path description: Starting date from when price formulas should be deleted required: true schema: type: string example: '2022-01-01' responses: '204': description: No Content content: application/json: schema: $ref: '#/components/schemas/NoContentResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Meter with the given 'meter_id' could not be found. Meter was either deleted or not imported.: value: code: PRICE_FORMULA_METER_NOT_FOUND description: Meter with the given 'meter_id' could not be found. Meter was either deleted or not imported. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'id' must not be null or empty: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Price formula for the given 'meter_id' and 'from' date was not found.: value: code: PRICE_FORMULA_NOT_FOUND description: Price formula for the given 'meter_id' and 'from' date was not found. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Location with given id could not be found: value: code: LOCATION_NOT_FOUND description: Location with given id could not be found request_id: 65e2ea86-470f-4363-9295-35d6b473981a Meter with given id could not be found: value: code: METER_NOT_FOUND description: Meter with given id could not be found request_id: 65e2ea86-470f-4363-9295-35d6b473981a '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Internal server error. If problem remains, please contact support: value: code: INTERNAL_ERROR description: Internal server error. If problem remains, please contact support request_id: 65e2ea86-470f-4363-9295-35d6b473981a /meters/{meterId}/priceformulas/all: delete: tags: - Meter Price Formulas summary: Delete all price formulas for a meter specified by meter external reference operationId: delete-meter-all-price-formulas parameters: - name: meterId in: path description: External meter id required: true schema: type: string example: abc123 responses: '204': description: No Content content: application/json: schema: $ref: '#/components/schemas/NoContentResult' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Meter with the given 'meter_id' could not be found. Meter was either deleted or not imported.: value: code: PRICE_FORMULA_METER_NOT_FOUND description: Meter with the given 'meter_id' could not be found. Meter was either deleted or not imported. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Parameter 'id' must not be null or empty: value: code: METER_ID_MISSING description: Parameter 'id' must not be null or empty request_id: 65e2ea86-470f-4363-9295-35d6b473981a '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Price formula for the given 'meter_id' and 'from' date was not found.: value: code: PRICE_FORMULA_NOT_FOUND description: Price formula for the given 'meter_id' and 'from' date was not found. request_id: 65e2ea86-470f-4363-9295-35d6b473981a Location with given id could not be found: value: code: LOCATION_NOT_FOUND description: Location with given id could not be found request_id: 65e2ea86-470f-4363-9295-35d6b473981a Meter with given id could not be found: value: code: METER_NOT_FOUND description: Meter with given id could not be found request_id: 65e2ea86-470f-4363-9295-35d6b473981a '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorDetails' examples: Internal server error. If problem remains, please contact support: value: code: INTERNAL_ERROR description: Internal server error. If problem remains, please contact support request_id: 65e2ea86-470f-4363-9295-35d6b473981a components: schemas: Block: type: object properties: resolution: type: - string - 'null' register_id: type: - string - 'null' unit_rate: type: number format: double from_kwh: type: - integer - 'null' format: int64 to_kwh: type: - integer - 'null' format: int64 from_m3: type: - integer - 'null' format: int64 to_m3: type: - integer - 'null' format: int64 Charge: type: object properties: resolution: type: - string - 'null' charge: type: - number - 'null' format: double type: type: - string - 'null' capacity_tariff: $ref: '#/components/schemas/CapacityTariff' CapacityTariff: type: object properties: charge_tariff: type: number format: double minimum_contribution: type: number format: double calculation_type: type: - string - 'null' Element: type: object properties: name: type: - string - 'null' type: type: - string - 'null' charge: $ref: '#/components/schemas/Charge' unit_rate: $ref: '#/components/schemas/UnitRate' Fixed: type: object properties: unit_rate: type: - number - 'null' format: double PriceFormula: type: object properties: name: type: - string - 'null' from: type: - string - 'null' to: type: - string - 'null' currency_code: type: - string - 'null' elements: type: - array - 'null' items: $ref: '#/components/schemas/Element' price_multiplier: type: - number - 'null' format: double energy_unit: type: - string - 'null' Tou: type: object properties: register_id: type: - string - 'null' unit_rate: type: - number - 'null' format: double intervals: type: - array - 'null' items: $ref: '#/components/schemas/Interval' skip_intervals: type: - boolean - 'null' ErrorDetails: required: - code - description type: object properties: code: minLength: 1 type: string description: minLength: 1 type: string request_id: type: - string - 'null' NoContentResult: type: object properties: statusCode: type: integer format: int32 UnitRate: type: object properties: type: type: - string - 'null' fixed: $ref: '#/components/schemas/Fixed' tou: $ref: '#/components/schemas/Tou' block: $ref: '#/components/schemas/Block' spot_price: $ref: '#/components/schemas/SpotPrice' weekdays: type: - array - 'null' items: type: string Interval: type: object properties: from_minute: type: - integer - 'null' format: int64 to_minute: type: - integer - 'null' format: int64 SpotPrice: type: object properties: provider: type: - string - 'null' region: type: - string - 'null' resolution: type: - string - 'null' multiplier: type: - number - 'null' format: double x-tagGroups: - name: Users tags: - User - name: Locations tags: - Location - Location profile - Location home profile - Location price formulas - name: Meters tags: - Meter - Meter Energy Day - Meter Energy High Resolution - Meter Energy Reads - Meter Energy Period - Meter Max Demand - Meter Price Formulas - name: Jobs tags: - Jobs - name: Portfolio tags: - Portfolio Accounts - Portfolio Groups - Portfolio Locations - Portfolio Users - name: Client details tags: - Client details