BookingItemsByDate: Roller Booking Items by Date |
Catalog: Roller
Schema: Data
Label: Booking Items by Date
Documentation:
The timespan covered by the start and end date can not exceed 7 days.
This is a read-only table function. The Roller API may not support changing the data or the Invantive SQL driver for Roller does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Roller API.
Select Roller API URL: data/bookingitems
Insert Roller API URL: data/bookingitems
Update Roller API URL: data/bookingitems
Delete Roller API URL: data/bookingitems
Field Selection Method: NotRequired
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function BookingItemsByDate. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
---|---|---|---|---|
endDate |
datetime |
☑ |
|
Search end date, based on record modified date. |
startDate |
datetime |
☑ |
|
Search start date, based on record modified date. |
Columns of Table Function
The columns of the table function BookingItemsByDate are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
bookingCreatedByStaffId |
string |
|
☐ |
Staff Id that created the Booking. |
bookingCreatedDate |
datetime |
|
☑ |
Date the booking was created. |
bookingCustomerId |
string |
Customer ID |
☐ |
Unique identifier of the customer linked to the booking. |
bookingDate |
datetime |
Booking Date |
☑ |
Booking date of the ticket - when the ticket is valid for/from. |
bookingLocation |
string |
Location |
☑ |
Sales channel the booking was created through. |
bookingModifiedDate |
datetime |
Modified |
☑ |
Date the booking was most recently modified. |
bookingReference |
string |
Booking Reference |
☑ |
Unique identifier for a booking. |
bookingStatus |
string |
Status |
☑ |
Payment status of the booking. |
createdDate |
datetime |
Created |
☑ |
Date the booking item was created. |
discountAmount |
decimal |
|
☐ |
The amount discounted against this specific booking item. |
groupSize |
int32 |
Group Size |
☑ |
The number of guests per quantity - eg. GroupSize of 4 with Quantity 3 would be 12 guests. |
productId |
string |
Product ID |
☑ |
Unique identifier of the product. |
quantity |
int32 |
Quantity |
☑ |
Quantity of the product on this booking item. |
sessionEnd |
string |
Session End |
☐ |
End time of the item if applicable. |
sessionStart |
string |
Session Start |
☐ |
Start time of the item if applicable. |
taxExemptId |
string |
|
☐ |
The Tax ID provided when overriding the tax amount. |
22-09-2022 21:51 Version 22.0.355-PROD+3587