RIO Order & RIO Order Line
Table of Contents
RIO Order & RIO Order Line
These custom objects are used in Continuing Education when a student/guest user registers to Study Offerings and pays for them.
These objects are in a Master-Detail relationship, with Order being the master, and the Order Line being the detail.
When a user registers for a Study Offering, a draft Order is created, if there are none found.
An Order Line linked to that Study Offering will be created, where it will specify the amount that needs to be paid.
-
One Order Line will be created for each Study Offering that the user registers to.
-
Registrations to multiple Study Offerings will create multiple Order Lines. All these Order Lines will be grouped under the Order, which in turn, is under the Contact.
-
The amount of an individual Order Line can be offset by using Study Credits, which act as a “voucher” to get the Study Offering for free.
- The total (final) amount of the Order can be reduced by applying a Discount Code.
This is how they appear upon checkout:
When the payment is made, a Study Registration record will be created (for the Study Offering that was linked with the Order Line).
If the Order Line is deleted (cancelled), the related Study Registration and Study Credits (if any were used) will be deleted as well, to avoid orphan data in the system. See the trigger here.
See also: For the image of the data model and use case, see here.
Important fields
RIO Order
| Fields | Description |
| Order Date | The date the order was created (i.e. student registers for a Study Offering). |
| Status |
Picklist value options:
|
| Order Status Date | Date/Time the order status Changes to Complete or Void etc. |
| Account | Lookup to the Account (company) who placed the order. |
| Contact | Lookup to the Contact (Student) who placed the order. |
| Description | Long text area for the details of the order. |
| Order Amount | Roll-up summary of the sum from the child Order Lines, i.e. the total amount that needs to be paid. |
| Discount Code | Text field for discount codes (if applicable). |
| Discount Amount | Currency field with the amount that has been discounted from the order amount. |
| Total Paid Amount | Currency field with the total amount that has been paid. |
| Outstanding Amount |
Formula currency field that calculates the outstanding balance that needs to be paid. Outstanding Amount = Order Amount - Total Paid Amount
|
RIO Order Line
| Fields | Description |
| RIO Order | Master-detail field looking up to the RIO Order as the parent. |
| Study Offering |
Lookup field to the Study Offering. An Order Line will be created for each Study Offering that the student registers to. |
| Description | Long text area containing the details of the Order Line. |
| Quantity | The number of Order Lines. |
| Unit Price | Currency field with the price per unit. |
| Unit Price Before Discount |
(v3.16) Currency field |
| Discount |
(v3.16) Currency field |
| Discount Code |
(v3.16)
|
| Discount Description |
(v3.16) Long text area field |
| Discount Flag |
(v3.16) Picklist field:
|
| Fee Unit |
(v3.16) Picklist field:
|
| Amount |
Currency field with the amount of this individual Order Line. The Amount is calculated by multiplying Quantity with Unit Price (Amount = Quantity * Unit Price). See the relevant trigger here. |
| Study Credit |
Lookup to the Study Credit (applied as discount), if applicable. If a Study Credit is linked with the Order Line, the Order Line’s amount is considered as $0. If a user wants to override this calculated amount, they will need to create a custom filter field, or disable this trigger here. |
| Credited Amount |
(v3.18) The amount credited from the linked Study Credit. |