Copy page

Common workflows

Get price information

Use this workflow to retrieve price information for a Customer and Accounting Point on a specific date.

This is typically used when an external system needs to display product price information, consumption price, fixed monthly price, or price expressions for a customer-facing or operational view.

Endpoint

Code
GET /se/v2/GetPriceInformation?customer={customerGuid}&ap={accountingPointIdentification}&date={date}

When to use

Use this workflow when an external system needs price information for a specific customer, Accounting Point, and date.

Typical use cases include:

• displaying the customer's current product price information
• showing the price expression used for calculation
• showing consumption price for a specific date
• showing hourly price sequences for the selected date
• showing monthly fixed price amounts
• explaining price components in a customer portal, CRM, or customer support system

Request parameters

Parameter	Description
customer	UtilityCloud GUID of the Customer.
ap	Accounting Point identification.
date	Date for the requested price information.

Example request

Code
GET /se/v2/GetPriceInformation?customer=9c571be0-a689-4b83-9343-4043b5328836&ap=707057500012345678&date=2023-03-21

Response

A successful request returns price information for the selected Customer, Accounting Point, and date.

Code
{
  "productName": "BE Test Produkt",
  "subProducts": [],
  "date": "2023-03-21T00:00:00",
  "priceExpression": "NO4 + 0.1 + 77",
  "consumptionPrice": "0.4180000000000001",
  "consumptionPriceSequence": [
    {
      "sequence": 1,
      "price": 0.393
    },
    {
      "sequence": 24,
      "price": 0.44300000000000006
    }
  ],
  "monthlyPrice": "77"
}

Response fields

Field	Description
productName	Name of the product used for the price information.
subProducts	Optional add-on products included in the price information.
date	Date for the price information.
priceExpression	Combined price expression for the product and sub-products.
consumptionPrice	Average consumption price for the selected date.
consumptionPriceSequence	One price sequence per sub-product with hourly prices.
consumptionPriceSequenceAggregated	One aggregated hourly price sequence for all sub-products.
monthlyPrice	Sum of fixed monthly amounts.

Notes

The returned price information depends on the customer's contract, products, sub-products, price setup, Accounting Point, and selected date.

subProducts are optional add-on products.

priceExpression shows the combined price expression for all included sub-products.

consumptionPrice is the average price for the selected date.

consumptionPriceSequence contains hourly prices per sub-product.

consumptionPriceSequenceAggregated contains one aggregated hourly price sequence for all sub-products.

monthlyPrice contains the sum of fixed monthly amounts.

Related endpoints

Code
GET /se/v2/GetPriceInformation?customer={customerGuid}&ap={accountingPointIdentification}&date={date}
GET /v1/se/calculation/GetCalculation?customer={customerGuid}&meteringpoint={accountingPointIdentification}&firstDay={firstDay}&lastDay={lastDay}&agg={aggregation}
POST /v1/pm/products
POST /v1/cm/contracts