Tariff Recurring Periods

Retrieve recurring periods.

GET

https://partner-api.monta.com

/api/v1/tariff-recurring-periods

Required scope: tariffs:read

Retrieve recurring periods. › query Parameters

tariffId

integer · int64 · required

tariffPeriodGroupId

integer · int64 · required

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

Retrieve recurring periods. › Responses

Tariff recurring periods with provided tariffId & tariffPeriodGroupId

Page_TariffRecurringPeriodDto_

TariffRecurringPeriod[] · required

Pageable · required

pageNumber

integer · int32

offset

integer · int64

size

integer · int32

empty

boolean

numberOfElements

integer · int32

totalSize

integer · int64

totalPages

integer · int32

GET/api/v1/tariff-recurring-periods

curl 'https://partner-api.monta.com/api/v1/tariff-recurring-periods?tariffId=<number>&tariffPeriodGroupId=<number>' \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "content": [
    {
      "id": 0,
      "tariffId": 0,
      "dayOfWeek": "MONDAY",
      "endDayOfWeek": "MONDAY",
      "start": 0,
      "end": 0,
      "startMinute": 30,
      "endMinute": 0,
      "price": 0
    }
  ],
  "pageable": {
    "orderBy": [
      {
        "ignoreCase": true,
        "direction": "ASC",
        "property": "property",
        "ascending": true
      }
    ],
    "number": 0,
    "size": 0,
    "mode": "CURSOR_NEXT",
    "sort": {
      "orderBy": [
        {
          "ignoreCase": true,
          "direction": "ASC",
          "property": "property",
          "ascending": true
        }
      ]
    }
  },
  "pageNumber": 0,
  "offset": 0,
  "size": 0,
  "empty": true,
  "numberOfElements": 0,
  "totalSize": 0,
  "totalPages": 0
}

json

application/json

Create new recurring period.

POST

https://partner-api.monta.com

/api/v1/tariff-recurring-periods

Required scope: tariffs:write
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.

Create new recurring period. › Request Body

TariffRecurringPeriodCreateRequestDto

tariffId

integer · int64 · required

Id of the tariff this period will belong to

Example: 1

groupId

integer · int64 · required

Id of the tariff period group this period will belong to

Example: 1

dayOfWeek

string · enum · required

Capitalized name of the day of the week

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Example: MONDAY

startHour

integer · int32 · required

hour that the period starts at

Example: 0

endHour

integer · int32 · required

hour that the period ends at

Example: 23

price

number · required

price during the period

Example: 2.54

endDayOfWeek

string · enum

Capitalized name of the day of the week that the price is for

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Example: FRIDAY

startMinute

integer · int32

minute within startHour that the period starts at: 0, 15, 30 or 45. Defaults to 0

Example: 30

endMinute

integer · int32

minute within endHour that the period ends at: 0, 15, 30 or 45. Defaults to 0

Example: 0

Create new recurring period. › Responses

Tariff recurring period that was created

TariffRecurringPeriod

dayOfWeek

string · enum · required

day of the period

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

price

number · required

price during the period

id

integer · int64

id of the period

tariffId

integer · int64

id of the tariff

endDayOfWeek

string · enum

End day of the period

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

start

integer · int32

starting hour of the period

end

integer · int32

ending hour of the period

startMinute

integer · int32

minute within the starting hour when the period starts (0, 15, 30 or 45)

Example: 30

endMinute

integer · int32

minute within the ending hour when the period ends (0, 15, 30 or 45)

Example: 0

POST/api/v1/tariff-recurring-periods

curl https://partner-api.monta.com/api/v1/tariff-recurring-periods \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "tariffId": 1,
  "groupId": 1,
  "dayOfWeek": "MONDAY",
  "endDayOfWeek": "FRIDAY",
  "startHour": 0,
  "endHour": 23,
  "startMinute": 30,
  "endMinute": 0,
  "price": 2.54
}'

Example Request Body

{
  "tariffId": 1,
  "groupId": 1,
  "dayOfWeek": "MONDAY",
  "endDayOfWeek": "FRIDAY",
  "startHour": 0,
  "endHour": 23,
  "startMinute": 30,
  "endMinute": 0,
  "price": 2.54
}

json

Example Responses

{
  "id": 0,
  "tariffId": 0,
  "dayOfWeek": "MONDAY",
  "endDayOfWeek": "MONDAY",
  "start": 0,
  "end": 0,
  "startMinute": 30,
  "endMinute": 0,
  "price": 0
}

json

application/json

Retrieve a tariff recurring period.

GET

https://partner-api.monta.com

/api/v1/tariff-recurring-periods/{id}

Required scope: tariffs:read

Retrieve a tariff recurring period. › path Parameters

id

integer · int64 · required

Retrieve a tariff recurring period. › Responses

Tariff recurring period with provided id

TariffRecurringPeriod

dayOfWeek

string · enum · required

day of the period

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

price

number · required

price during the period

id

integer · int64

id of the period

tariffId

integer · int64

id of the tariff

endDayOfWeek

string · enum

End day of the period

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

start

integer · int32

starting hour of the period

end

integer · int32

ending hour of the period

startMinute

integer · int32

minute within the starting hour when the period starts (0, 15, 30 or 45)

Example: 30

endMinute

integer · int32

minute within the ending hour when the period ends (0, 15, 30 or 45)

Example: 0

Update existing recurring period.

PATCH

https://partner-api.monta.com

/api/v1/tariff-recurring-periods/{id}

Required scope: tariffs:write
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.

Update existing recurring period. › path Parameters

id

integer · int64 · required

Update existing recurring period. › Request Body

TariffRecurringPeriodUpdateRequestDto

dayOfWeek

string · enum

Capitalized name of the day of the week

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Example: MONDAY

endDayOfWeek

string · enum

Capitalized name of the end day of the week

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

Example: FRIDAY

startHour

integer | null · int32

hour that the period starts at

Example: 0

endHour

integer | null · int32

hour that the period ends at

Example: 23

startMinute

integer | null · int32

minute within startHour that the period starts at: 0, 15, 30 or 45

Example: 30

endMinute

integer | null · int32

minute within endHour that the period ends at: 0, 15, 30 or 45

Example: 0

price

number | null

price during the period

Example: 2.54

Update existing recurring period. › Responses

Tariff recurring period that was updated

TariffRecurringPeriod

dayOfWeek

string · enum · required

day of the period

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

price

number · required

price during the period

id

integer · int64

id of the period

tariffId

integer · int64

id of the tariff

endDayOfWeek

string · enum

End day of the period

Enum values:

MONDAY

TUESDAY

WEDNESDAY

THURSDAY

FRIDAY

SATURDAY

SUNDAY

start

integer · int32

starting hour of the period

end

integer · int32

ending hour of the period

startMinute

integer · int32

minute within the starting hour when the period starts (0, 15, 30 or 45)

Example: 30

endMinute

integer · int32

minute within the ending hour when the period ends (0, 15, 30 or 45)

Example: 0

PATCH/api/v1/tariff-recurring-periods/{id}

curl https://partner-api.monta.com/api/v1/tariff-recurring-periods/:id \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "dayOfWeek": "MONDAY",
  "endDayOfWeek": "FRIDAY",
  "startHour": 0,
  "endHour": 23,
  "startMinute": 30,
  "endMinute": 0,
  "price": 2.54
}'

Example Request Body

{
  "dayOfWeek": "MONDAY",
  "endDayOfWeek": "FRIDAY",
  "startHour": 0,
  "endHour": 23,
  "startMinute": 30,
  "endMinute": 0,
  "price": 2.54
}

json

Example Responses

{
  "id": 0,
  "tariffId": 0,
  "dayOfWeek": "MONDAY",
  "endDayOfWeek": "MONDAY",
  "start": 0,
  "end": 0,
  "startMinute": 30,
  "endMinute": 0,
  "price": 0
}

json

application/json

Delete an existing Tariff Recurring Period , and all contained prices.

DELETE

https://partner-api.monta.com

/api/v1/tariff-recurring-periods/{id}

Required scope: tariffs:delete
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.

Delete an existing Tariff Recurring Period , and all contained prices. › path Parameters

id

integer · int64 · required

Delete an existing Tariff Recurring Period , and all contained prices. › Responses

Tariff Recurring Period deleted

No data returned

Tariff Period Groups Tax Compliance