Skip to main content

Knowledge Center

Recurring rates (RRT)

RRT_Overview.jpg

The Recurring rates (RRT) application is used to define rates which are used in rental and/or subscription applications.

Recurring rates area - Left side

The Recurring rate area lists all Recurring rates (RRT). The list can be filtered efficiently by the options in the header, as well as the Search field, Column settings and Filter builder.

Notable functionality is found in the footer, by clicking the Create recurring rate button.

RRT_Left_side.jpg
Header

The header area allows for efficient filtering of the list by either only displaying Recurring rates (RRT) of a certain currency or quickly finding a Recurring rate (RRT) applied to a certain product, or by searching for a product identifier.

  • Quick search field and icon - The quick search allows the user to filter the list on Recurring rates (RRT) with a specific product name or identifier. To specify if product name and/or identifier is to be included in the search, click the Quick search icon.

    Quick_search.png

    Quick search icon

  • Currency field - Specify if only Recurring rates (RRT) of a specific currency is to be listed. To filter on a specific currency, click the Currency drop-down menu, and select a currency from the list.

  • Clear filters button - To clear selections made in the Quick search field and Currency drop-down menu, click the Clear filters button.

List

The Recurring rates lists all Recurring rates (RRT). The user may select individual rates to view and edit details on the right side, or use the Create recurring rate button to create a new recurring rate in Status 1 - Draft.

The list includes the following options for filtering:
  • Search field - Click and pressing SPACEBAR will list Field, then Operator and finally Value, which can be used to create a quick filter. Values entered in the Search field will be matched with matching descriptions or customer identifier.

  • Filter builder icon - Click to open a popup where standard filters can be selected, and even create and save your own.

  • Column settings icon - click to list available columns, Export to Excel and Reset to Default view. If the list is not displaying the expected information, the Reset to default view can be especially useful.

Column

Icon

Description

St

OOV_Status.png

Displays an icon indicating the status of the Recurring rate (RRT).

Available statuses are:
  • Status 0 - In process

  • Status 1 - Draft

  • Status 3 - Future

  • Status 4 - Active

  • Status 9 - Discontinued

Why is the Recurring rate (RRT) not in Status 4?

If the Effective date of the Recurring rate (RRT) is a future date, the Recurring rate (RRT) will be set in Status 3 - Future, until the Effective date is reached.

Id

Displays the Recurring rate identifier (RRT)

Created at

Displays the date and time the Recurring rate (RRT) was created in yyyy.MM.dd format.

Currency

Displays the three character code of the currency applied to the rate, following the ISO 4217 standard.

Type

States if the Recurring rate (RRT) is of type:

  • Standard

  • Special

Note

Standard rates can be replaced by either using the Replaces rate drop-down menu in the Details area for Recurring rates (RRT) in Status 1 - Draft, or using the replace rate functionality in the header.

Product

Order_id_view_icon.jpg

Displays the name and the potential description of the Product (ART) the Recurring rate (RRT) applies for.

To view and/or edit details, click the View icon to open the Product (ART) application.

Effective date

Displays the date the Recurring rate (RRT) is valid from.

Expiration date

Displays the date the Recurring rate (RRT) was, or will become, invalid.

Replaces rate

link-ext-alt.svg

Displays the Recurring rate (RRT) identifier of the rate that has or will be replaced by the listed Recurring rate (RRT).

Rate aspect

Displays the Rate aspect of the Recurring rate (RRT):

  • Duration

  • Quantity

Initial rate step

info-circled.svg

Displays the initial rate step set when creating the Recurring rate (RRT).

To view details about the potential rate steps, hover over the Information icon.

Button

Icon

Description

Create recurring rate button

Create_recurring_rate_button.jpg

To create a Recurring rate (RRT) in Status 1 - Draft, click the Create recurring rate button.

This will open the Create recurring rate popup with the following options.

Require fields are marked with an asterisk (*)

Create recurring rate popup
  • Product drop-down menu - Select a Product (ART) which the Recurring rate (RRT) applies for.

  • Currency drop-down menu - To select a Currency (CUR) for the Recurring rate (RRT), click the Currency drop-down menu.

  • Rate aspect drop-down menu - To set a Rate aspect, either quantity or duration, click the Rate aspect drop-down menu and select the required option.

  • Recurring period drop-down menu - To set a Recurring period, day, week, month or year, click the Recurring period drop-down menu and select the required option.

  • Pricing method drop-down menu - To set a Pricing method, either Flat rate or Incremental, click the Pricing method drop-down menu and select the required option.

  • Effective date - field and Calendar icon - Set a date which the Recurring rate will be active from. If a future date is the Recurring rate (RRT) will be in Status 3 - Future, until that date is reached, setting the Recurring rate (RRT) in Status 4 - Active.

  • Expiration date field and Calendar icon - Set an Effective date, click the Effective date field and provide a date in the yyyy.MM.dd format, or click the Calendar icon and select an option.

  • Base rate field - To set a Base rate, click the Base rate field and type the required rate.

  • Create another checkbox - To keep the popup open after having created a Recurring rate (RRT), check the Create another checkbox, This allows for efficient creation of multiple Recurring rates (RRT).

  • Create button - To create a Recurring rate (RRT) with the user provided specifics, click the Create button.

Recurring rate area - Right side

The Recurring rate area allows the creation of replacement rates, editing details, adding rate steps and inspecting where the recurring rate applies.

Header - Recurring rate area
Replace rate for type Standard

Notable functionality in the header is found by clicking the highlighted area in the example above, which allows the creation of a replacement Recurring rate (RRT).

RRT_new_rate_s1.jpg
RRT_new_rate_s2.jpg
RRT_new_rate_s3.jpg
Details area
RRT_Details.jpg

The Details area allows the inspection and editing of a selected Recurring rate's (RRT) details. The available fields, drop-down menus are listed in the table below.

Field, drop-down menus and checkboxes

Icon

Description

Product

Order_id_view_icon.jpg

Displays the name of the Product (ART) the Recurring rate (RRT) applies to.

Can be updated if the Recurring rate (RRT) is in Status 1 - Draft.

To inspect or edit the Product (ART), click the View icon.

Effective date

Calendar.png

Displays the potential start date of the Recurring rate (RRT), if this was set when either creating the Recurring rate (RRT) or when the rate was is Status 1 - Draft.

To edit, click the Effective date field and provide a date in the yyyy.MM.dd format, or click the Calendar icon.

Recurring period

The recurring period decides the interval of the Recurring rate (RRT).

Available intervals:
  • Day

  • Week

  • Month

  • Year

The interval is set when creating the Recurring rate (RRT), and can be adjusted if the Recurring rate (RRT) is in Status 1 - Draft.

To adjust the Recurring period, click the Recurring period drop-down menu and choose one of the listed available intervals.

Pricing method

The method of which total price will be calculated for this Recurring rate (RRT).

1 - Incremental: Sum of respective rates of each step

2 - Flat rate: One price decided by the quantity of the product.

Currency

Displays the selected currency for the Recurring rate (RRT).

Can be changed if the Recurring rate (RRT) is in Status 1 - Draft.

To edit, click the Currency drop-down menu and select a available currency from the list.

Expiration date

Calendar.png

Displays the end date of the Recurring rate (RRT), if this has been set when creating the rate, or edited in Status 1 - Draft.

Rate aspect

Displays the current rate aspect of the rate.

Available options are:
  • Quantity

  • Duration

The Rate aspect is set when creating the Recurring rate (RRT)

Location

Displays the three letter abbreviation for the selected Location (LOC) for the Recurring rate (RRT).

This is set when creating the Recurring rate (RRT).

Can only be updated in Status 1 - Draft.

To update, click the Location drop-down menu, and select a new Location (LOC) from the list.

Type

Available options are:
  • Standard

  • Special

Note

Recurring rates (RRT) of type Standard can replace or be replaced by other rates in Status 1 - Draft.

Replaces rate

If the selected Recurring rate (RRT) has replaced a previously created rate, the identifier of the replaced Recurring rate (RRT) will be displayed.

If the selected Recurring rate (RRT) is in Status 1 - Draft, the Replaces rate drop-down menu can be used to replace a Recurring rate (RRT) in Status 4 - Active, of type Standard.

Default for product and currency checkbox

Checkbox_PWO.jpgOOV_Checkbox.png

Determines whether or not the Recurring rate (RRT) is a default rate for the combination of its product and currency.

Sub-tabs

The sub-tabs can be used to create and edit rate steps and checking where the Recurring rate (RRT) is used.

Rate steps sub-tab
RRT_Sub_tab_Rate_steps.jpg

The Rate steps sub-tab is mainly used to add Rate steps and inspect existing rate steps.

Column

Icons

Description

From quantity

The minimum number of intervals, or quantity, for triggering the rate step.

Rate

Value of the rate step.

Actions

pencil.svg

MRB_Delete_current.png

The icons in the Actions column can be used to edit or delete the Rate step.

To edit either the From quantity of the rate step or the Rate, click the Edit icon.

Unable to edit or delete?

The Recurring rate (RRT) must be in Status 1 - Draft or Status 3 - Future, to be enabled for editing or deletion.

Add rate step button

Add_rate_step_button.jpg

The Add rate step button is used for adding rate steps.

The rate steps are based on the setup of the Recurring rate (RRT) details.

Add a rate step to the Recurring rate (RRT)
  1. Select or create a Recurring rate (RRT) in the Recurring rates area, on the left.

  2. In the Rate steps sub-tab, click the Add rate steps button.

  3. Add the Rate aspect details:

    1. If the Rate aspect of the Recurring rate (RRT) is quantity, set a From quantity from which the new rate will apply.

    2. If the Rate aspect of the Recurring rate (RRT) is duration, set a From date from which the new rate will apply.

  4. Add the Rate details:

    1. Based on the currency for the Recurring rate (RRT) and the Recurring period interval, set a new rate which will apply.

  5. To add the new rate steps, click the Create button.

Note

Rate steps can only be added to Recurring rates (RRT) in Status 1 - Draft.

Utilization sub-tab
RRT_Sub_tab_utilization.jpg

The Utilization sub-tab lists the Rental contract items (RCTITEM) where the Recurring rate (RRT) is applied, along with key information.

Notable functionality is the option of navigating directly to the Rental contract item (RCTITEM) by clicking the Arrow icon or accessing the Rental contract (RCT) directly by clicking the View icon in the Rental contract id column.

Column and functions are described in the table below:

Column

Icon

Description

St

OOV_Status.png

Displays an icon indicating the status of the Rental contract item (RCTITEM).

The stage of the Rental contract item (RCTITEM) defines the meaning of the status.

Contract items in stage Order
  • Status 1 - Draft

  • Status 2 -

  • Status 3 - Future

  • Status 4 - Active

  • Status 6 - Delayed

  • Status 7 - Canceled

  • Status 8 - Pending invoice

  • Status 9 -

Contract items in stage Quote
  • Status 1 - Draft

  • Status 2 - Sealed

  • Status 3 - Active

  • Status 4 -

  • Status 6 -

  • Status 7 - Rejected

  • Status 9 -

Rental contract id

Order_id_view_icon.jpg

Displays the Rental contract (RCT) identifier in the format RCT/000000.

To open the Rental contract (RCT) application to inspect or edit details of the contract, click the View icon.

Line number

Line- or sequence number of the contract item.

Stage

RCT_-_Quote.jpg

RCT_-_Order.jpg

Displays the current stage of the Rental contract item (RCTITEM).

Type

Displays the product type of the Rental contract item (RCTITEM). Expected values are Subscription or Rental.

Start date

Start date of the Rental contract item (RCTITEM). Displayed in yyyy.MM.dd format.

End date

End date of the Rental contract item (RCTITEM). Displayed in yyyy.MM.dd format.

Duration

Displays the total amount of days the Recurring rate (RRT) has, or will be applied to the Rental contract item (RCTITEM). It is the amount of days from the Start date to the End date.

Total amount

Displays the total amount after discount for the Rental contract item (RCTITEM).

Conv. total amount

OOV_Right_arrow.png

To open the Rental contract item (RCTITEM) application and inspect and edit details, click the Right arrow icon