v1

latestOpenAPI 3.0.12026-07-243686491.1 MB
Tariff Recurring Periods

Create new recurring period.

Required scope: tariffs:write<br/>Note: Once you are done with creating/updating tariffs and its components you have to call the create-prices endpoint to create the prices for the tariff.

post/api/v1/tariff-recurring-periods

Request body

tariffIdinteger required

Id of the tariff this period will belong to

groupIdinteger required

Id of the tariff period group this period will belong to

dayOfWeek'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' required
endDayOfWeek'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
startHourinteger required

hour that the period starts at

endHourinteger required

hour that the period ends at

pricenumber required

price during the period

Example request

{
  "tariffId": 1,
  "groupId": 1,
  "endHour": 23,
  "price": 2.54
}

Response

Tariff recurring period that was created

idinteger

id of the period

tariffIdinteger

id of the tariff

dayOfWeek'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' required
endDayOfWeek'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY'
startinteger

starting hour of the period

endinteger

ending hour of the period

pricenumber required

price during the period