Other endpoints

Server

Download schema

deprecated

🕚 Change a customers status

POST

https://api-stag.utilitycloud.app

/v1/cm/customer/{guid}/status

Bearer (JWT)

🕚 Change a customers status › path Parameters

guid

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^… · required

The uc id of the customer

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

🕚 Change a customers status › Request Body

cm_contract_cm_change_customer_status_req_body

Status

string · enum

Enum values:

Deceased

Example: Deceased

RequestId

cm_contract_cm_req_id · pattern: ^([0-9A-Fa-f]{32}$|^…

Request ID, must be unique

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

Reason

string · enum

Enum values:

Deceased

Example: Deceased

Inheritor

cm_contract_cm_guid · pattern: ^([0-9A-Fa-f]{32}$|^…

UC Identifier

Example: ff175a44-90e6-4579-87f1-7e9aa07d57ac

🕚 Change a customers status › Responses

Request accepted

cm_contract_cm_202Default

Message

string · enum

Enum values:

Request accepted

Example: Request accepted

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025]

POST

https://api-stag.utilitycloud.app

/se/api-pricelist/v1/backend/pricelist/createorupdate

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /v2/backend/pricelist

🕚 [DEPRECATED Sunset on 31-March-2025] › Request Body

se_pricelist_CreatePriceListMessage

se_pricelist_CreatePriceListMessageHeader

se_pricelist_CreatePriceListEntries

🕚 [DEPRECATED Sunset on 31-March-2025] › Responses

Success

string

POST/se/api-pricelist/v1/backend/pricelist/createorupdate

curl https://api-stag.utilitycloud.app/se/api-pricelist/v1/backend/pricelist/createorupdate \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "header": {
    "source": "source",
    "receiver": "receiver",
    "version": "version",
    "tenantID": "tenantID",
    "correlationID": "correlationID",
    "eventCreatedDate": "2024-08-25T15:00:00Z",
    "createdBy": "createdBy",
    "tzIdentifier": "tzIdentifier"
  },
  "createPriceListEntries": {
    "header": {
      "name": "name",
      "tags": [
        "string"
      ]
    },
    "payload": [
      {
        "startTime": "2024-08-25T15:00:00Z",
        "value": 0
      }
    ]
  }
}'

Example Request Body

{
  "header": {
    "source": "source",
    "receiver": "receiver",
    "version": "version",
    "tenantID": "tenantID",
    "correlationID": "correlationID",
    "eventCreatedDate": "2024-08-25T15:00:00Z",
    "createdBy": "createdBy",
    "tzIdentifier": "tzIdentifier"
  },
  "createPriceListEntries": {
    "header": {
      "name": "name",
      "tags": [
        "string"
      ]
    },
    "payload": [
      {
        "startTime": "2024-08-25T15:00:00Z",
        "value": 0
      }
    ]
  }
}

json

Example Responses

string

json

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025]

GET

https://api-stag.utilitycloud.app

/se/api-pricelist/v1/product/pricelist/{id}

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /v2/product/pricelist/{id}

🕚 [DEPRECATED Sunset on 31-March-2025] › path Parameters

id

string · required

🕚 [DEPRECATED Sunset on 31-March-2025] › Responses

Success

se_pricelist_CustomPriceListResponse

se_pricelist_Acknowledge

se_pricelist_CustomPriceList

GET/se/api-pricelist/v1/product/pricelist/{id}

curl https://api-stag.utilitycloud.app/se/api-pricelist/v1/product/pricelist/:id \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "acknowledge": {
    "responseCode": "responseCode",
    "responseText": "responseText"
  },
  "priceList": {
    "id": "id",
    "description": "description",
    "lastUpdatedBy": "lastUpdatedBy",
    "visible": true,
    "lastUpdated": "2024-08-25T15:00:00Z",
    "tzIdentifier": "tzIdentifier",
    "tags": [
      "string"
    ],
    "hasPriceAreas": true,
    "entries": [
      {
        "id": "id",
        "priceListName": "priceListName",
        "startTime": "2024-08-25T15:00:00Z",
        "endTime": "2024-08-25T15:00:00Z",
        "value": 0,
        "priceArea": "priceArea"
      }
    ],
    "currency": "currency",
    "market": "market"
  }
}

json

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025]

GET

https://api-stag.utilitycloud.app

/se/api-pricelist/v1/product/pricelists

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /v2/product/pricelists/

🕚 [DEPRECATED Sunset on 31-March-2025] › Responses

Success

se_pricelist_CustomPriceListListing

array | null

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025]

GET

https://api-stag.utilitycloud.app

/se/settlement/v2/GetPriceInformation

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /settlement/v4/accountingpoints/priceinformations/{accountingPointId}. Retrieves price information based on the specified parameters.

🕚 [DEPRECATED Sunset on 31-March-2025] › query Parameters

ap

string · required

date

string · required

customer

string

nordpoolprices

string

🕚 [DEPRECATED Sunset on 31-March-2025] › Responses

Success

se_settlement_PriceInformationV2

productName

string | null

subProducts

array | null

date

string · date-time

priceExpression

string | null

consumptionPrice

number · double

monthlyPrice

number · double

array | null

deprecated

🕚 [DEPRECATED Sunset on 31-August-2026]

GET

https://api-stag.utilitycloud.app

/se/settlement/v3/accountingpoints/priceinformations/{accountingPointId}

Bearer (JWT)

[DEPRECATED Sunset on 31-August-2026] Please use the new endpoint /v4/accountingpoints/priceinformations/{accountingPointId}.

🕚 [DEPRECATED Sunset on 31-August-2026] › path Parameters

accountingPointId

string · required

🕚 [DEPRECATED Sunset on 31-August-2026] › query Parameters

date

string · required

customerGuid

string

nordpoolprices

string

🕚 [DEPRECATED Sunset on 31-August-2026] › Responses

Success

se_settlement_PriceInformationV2

productName

string | null

subProducts

array | null

date

string · date-time

priceExpression

string | null

consumptionPrice

number · double

monthlyPrice

number · double

array | null

GET/se/settlement/v3/accountingpoints/priceinformations/{accountingPointId}

curl 'https://api-stag.utilitycloud.app/se/settlement/v3/accountingpoints/priceinformations/:accountingPointId?date=<string>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "productName": "productName",
  "subProducts": [
    "string"
  ],
  "date": "2024-08-25T15:00:00Z",
  "priceExpression": "priceExpression",
  "consumptionPrice": 0,
  "monthlyPrice": 0,
  "consumptionPriceSequenceAggregated": [
    {
      "sequence": 0,
      "price": 0
    }
  ],
  "consumptionPriceSequence": [
    {
      "partProduct": "partProduct",
      "priceSequence": [
        {
          "sequence": 0,
          "price": 0
        }
      ]
    }
  ]
}

json

deprecated

🕚 [DEPRECATED Sunset on 31-March-2025]

GET

https://api-stag.utilitycloud.app

/se/settlement/v1/GetPriceInformation

Bearer (JWT)

[DEPRECATED Sunset on 31-March-2025] Please use the new endpoint /settlement/v4/accountingpoints/priceinformations/{accountingPointId}. Retrieves price information based on the specified parameters.

🕚 [DEPRECATED Sunset on 31-March-2025] › query Parameters

ap

string · required

date

string · required

customer

string

nordpoolprices

string

🕚 [DEPRECATED Sunset on 31-March-2025] › Responses

Success

se_settlement_PriceInformationV2

productName

string | null

subProducts

array | null

date

string · date-time

priceExpression

string | null

consumptionPrice

number · double

monthlyPrice

number · double

array | null

Payments