API Reference
Service StatusApp Documentation
Start typing to search…

Get cost for a service

get https://{kitEnvironment}.{kitDomain}/{kitBasePath}/accounts//cost/

Gets the cost for the service specified by the costId, time period and resolution.

For production services the cost should be negative.

Log in to see full request history
Path Params
string
required
length ≥ 1

The unique Id of the account.

string
required
length ≥ 1

The id of the cost.

Query Params
date-time
required
length ≥ 19

The date-time end date for the data to be returned.

date-time
required
length ≥ 19

The date-time start date for the data to be returned.

string
required
length ≥ 1

The resolution for the data.

Responses

Response body
object
date-time
required
length ≥ 19

The date-time start date for the cost period.

date-time
required
length ≥ 19

The date-time end date for the cost period, noninclusive. For the current month the endDate should be the latest day with cost.

string
required
length ≥ 1

The resolution for the data.

year month day hour 15min

values
array of objects
required
length ≥ 0

The cost for the period starting with date with the resolution as given in the root object.

values*
object
date-time
required
length ≥ 19

The date-time associated with the cost calculation.

float
required

The total cost for the service. For production services, the cost should be negative if it is an income for the end customer.

float

The total cost for the service excluding VAT.

parts
array of objects
length ≥ 0

The different parts that make up the cost, cf. invoice lines.

Using parts to send a full breakdown of the total cost enables important features in the app,
such as cost breakdowns, the ability to exclude fixed fees in detailed history and the ability to calculate
the end customer's "My Price" on months.

Fixed fee costs can be excluded for resolutions finer than month, e.g. day, hour, 15min.

parts
object
string
length ≥ 1
deprecated

Matched with name of a measurement part

string
length ≥ 1

Matched with name of a measurement part

string
required
length ≥ 1

The type of the price item.

  • kWh: Multiplied with the kWh consumption.
  • m3: Multiplied with the m³ consumption.
  • kg: Multiplied with the kg consumption.
  • percent: Added as percent on the finished calculation, 0.25 for VAT.
  • monthly: A monthly fee.
  • yearly: A yearly fee.
  • yearlyDays: A yearly fee (month = yearlyDays * daysInMonth /365).
  • daily: A daily fee, multiplied by the amount of days in the month.
  • spotkWh: Send 0 for the value field to use only the nordpool spot price.
  • spotMonthlykWh: Uses month average spot price (+ value) multiplied with consumption.
  • peakWatt: Used to calculate LoadTariffs (effekttariffer) value multiplied to peakWatt measurement.
  • negativeSpotkWh: For production services only. Send 0 for the value field to use only the nordpool spot price.
  • negativeSpotMonthlykWh: For production services only.
  • 'kg': Used for any service where weight is a unit of measurement, e.g. waste.
  • 'count': Used for any service where a unit of measurement is a count, e.g. a number of occurrences, such as waste collection.

kWh m3 percent monthly yearly yearlyDays daily spotkWh spotMonthlykWh peakWatt negativeSpotkWh negativeSpotMonthlykWh kg count

string
required
length ≥ 1

fee kWhPrice kWhExtra kWhHigh kWhLow kWhProd subscriptionfee certificate spotPrice net svk nordpool balance origin vat tax transferFee m3Price dayWaterFee energy discount loadTariff wasteFood wasteRest wasteGarden collections

float
required

The cost for this part, as defined by the price type and price name and (optionally) measurementPartKey

float

The cost for this part excluding VAT.

Updated 13 days ago

Did this page help you?
Language
Credentials
URL

Updated 13 days ago

Did this page help you?