Datastructures

Rate

Property

Type

Cardinality

Description

rateName

string(255)

1

Name of the rate.

costId

int

1

Id of the cost rate.

costRateUuid

string

1

UUID of the cost rate. Same rate as costId.

pricingType

int

1

0: static; 1: recurring per weekday; 2: unique date and time.

currency

string

1

Currency of the rate. e.g. EUR

localCurrency

string

1

Local currency of the station. e.g. DDK

costTotalLocalCurrency

number

?

Costs in the local currency. null - without consumption or duration

currencyConversionRate

number

1

The conversion rate from one currency to another.

costTotal

number

?

The total costs time + power.null - without consumption or duration

costTime

number

?

The cost for time based rate. null - without consumption or duration

costPower

number

?

The costs for the consumed power. null - without consumption or duration

priceStructure

Price Structure Object

1

Price structure object divided in energy and time

scheduleUuid

string

?

UUID of the applied dynamic-pricing schedule entry. null for a static rate, a recurring gap (default window), or a unique rate queried before its first entry.

validity

Validity Object

?

Validity of the applied schedule entry. null for a static rate and a unique rate queried before its first entry.

nextPrice

NextPrice Object

?

The next applicable price. Present only when next_price is set and a following entry exists.
Paginated Response

Property

Type

Cardinality

Description

pagination

Pagination Object

1

Pagination object, which contains information for fetching the next page

data

Map<String, Rate>

1

Map of evse ids to their resolved rate objects
Pagination Object

Property

Type

Cardinality

Description

nextCursorId

string

1

pager string which can be passed for the next page to fetch

isLastPage

boolean

1

Indicator if this was the last page received (true if last page otherwise false)
Price Structure Object

Property

Type

Cardinality

Description

energy

Type Energy / Time Object

1

Energy based cost rate

time

Type Energy / Time Object

1

Time based cost rate

sessionFee

Type Session Fee Object

1

Session Fee based cost rate
Price Structure Object

Property

Type

Cardinality

Description

unit

String

1

The unit of the price structure object. energy → Wh, time → min.

elements

Element[]

1..*

The interval cost elements

tax

Double

?

Not present if include_tax parameter is not set
Element Object

Property

Type

Cardinality

Description

Unit

intervalChange

int

1

Interval change in Wh or min.

Wh or s respectively

stepCosts

number

1

Cost per kWh or min

currency

intervalCosts

number

1

Costs for this interval

Currency(e.g. €)/kWh or currency/min respectively
Session Fee Object

Property

Type

Cardinality

Description

Unit

value

number

1

Cost of session fee in localCurrency

localCurrency defined in the response

gracePeriod

int

1

Minimum time in seconds that is required to apply session fee. Both gracePeriod and minimumEnergyConsumption conditions need to satisfied to apply session fee

seconds

minimumEnergyConsumption

int

1

Minimum energy in Wh that is required to apply session fee. Both gracePeriod and minimumEnergyConsumption conditions need to satisfied to apply session fee

Wh
Validity Object

Property

Type

Cardinality

Description

type

String

1

unique, recurring, or default. Determines which of the remaining fields are present.

start

String

?

unique only. ISO-8601 UTC start of the entry.

end

String

?

unique only. ISO-8601 UTC end: the next entry’s start, or end of day for the last entry.

weekdays

Weekday Entry[]

?

recurring only. The slot applicable at the requested time (a single entry), not the whole schedule.

weekday

int

?

default only. 0: Sunday … 6: Saturday.

weekday_name

String

?

default only. Three-letter weekday, e.g. THU.

start_time

String

?

default only. Start of the gap window, HH:MM.

end_time

String

?

default only. End of the gap window, HH:MM.

The default type is the recurring rate’s fallback price in a gap where no schedule slot covers. It carries no schedule uuid (scheduleUuid is null).

Weekday Entry Object

Property

Type

Cardinality

Description

uuid

String

1

UUID of the recurring schedule config for this weekday/time slot.

weekday

int

1

0: Sunday … 6: Saturday.

weekday_name

String

1

Three-letter weekday, e.g. THU.

start_time

String

1

Slot start, HH:MM.

end_time

String

1

Slot end, HH:MM.
NextPrice Object

Property

Type

Cardinality

Description

scheduleUuid

String

?

UUID of the next schedule entry. null when the next entry is a recurring gap (default window).

validity

Validity Object

1

Validity of the next entry.

priceStructure

Price Structure Object

1

Price of the next entry, in the same model as the current price.