Navigation: Schema: Data > Tables

Revenues: Roller Revenues

Catalog: Roller

Schema: Data

Primary Keys: BookingPaymentId

Label: Revenues

Documentation:

Revenues are filtered on event date instead on modified date.

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/revenues

Insert Roller API URL: data/revenues

Update Roller API URL: data/revenues

Delete Roller API URL: data/revenues

Field Selection Method: NotRequired

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function Revenues. 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	Documentation
bookingReferences	string	☐	Booking references specified as list in comma-separated format. Maximum limit is 100.
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 Revenues are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
accountsReceivable	decimal	Account Receivable	☑	The accounts receivable generated or removed for this entry.
bookingPaymentId	string	Booking Payment ID	☐	Unique Identifier of a transaction.
bookingReference	string	Booking Reference	☑	Unique identifier for a booking.
customerId	string	Customer ID	☐	Unique identifier of the customer for the booking.
deferredRevenue	decimal	Deferred Revenue	☐	The deferred revenue generated or removed for this entry.
deferredRevenueGiftCards	decimal		☐	The giftcard deferred revenue generated or removed for this entry.
deferredRevenueOther	decimal		☐	The external deferred revenue generated or removed for this entry (used for integrations, eg. Groupon).
discount	decimal	Discount	☐	The value of the discount against a transaction entry.
discountCode	string	Discount Code	☐	The discount code used.
eventDate	datetime	Event Date	☑	The date the entry occurred - not necessarily the date the entry was generated, but when the values should be recorded as occurring.
eventType	string	Event Type	☑	The type of entry - Transaction, Redemption or Expiry.
externalPaymentReference	string	External Payment Reference	☐	The unique payment identifier from the payment gateway - or gift card number for gift card payments.
feeRevenue	decimal	Fee Revenue	☑	The amount of revenue from transaction fees for this entry.
fundsReceived	decimal	Funds Received	☑	The amount of money received for a transaction entry.
netRevenue	decimal	Net Revenue	☑	The after tax revenue generated for this entry.
paymentType	string	Payment Type	☑	The type of tender used for the transaction.
productId	string	Product ID	☑	Unique identifier of a product.
productType	string	Product Type	☑	Passes, Add-ons, Custom Products, Gift Cards, Package, Wallet.
receiptNumber	string	Receipt Number	☑
recognisedDiscount	decimal	Recognized Discount	☐	The value of the discount against a redemption or expiry entry.
taxOnFundsReceived	decimal	Tax on Funds Received	☐	The amount of tax on funds received for a transaction entry.
taxPayable	decimal	Tax Payable	☑	The amount of tax payable on recognised revenue for this entry.
taxPercent	decimal	Tax Percentage	☑	The tax percent against the product in this entry.
ticketId	string	Ticket ID	☑	Unique identifier for a ticket within a booking.
ticketTransactionValue	decimal	Ticket Transaction Value	☑	The value of the amount paid against the booking that is being attributed to this entry.
ticketUnitCost	decimal	Ticket Unit Cost	☑	The price of the ticket being referenced in the entry.
transactionDate	datetime	Transaction Date	☑	Date of the first transaction against a booking.
transactionFeeAmount	decimal	Transaction Fee Amount	☐	The value of the transaction fee against a transaction entry.
transactionLocation	string	Transaction Location	☑	The sales channel the booking was generated from.

22-09-2022 21:51 Version 22.0.355-PROD+3587

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Roller API Data Model

Revenues: Roller Revenues

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information