queryTipSettings( )

Creates a query to retrieve a list of tip settings.

The queryTipSettings() function builds a query to retrieve a list of tip settings and returns a TipSettingsQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() function.

You can refine the query by chaining TipSettingsQueryBuilder functions onto the query. TipSettingsQueryBuilder functions enable you to sort, filter, and control the results that queryTipSettings() returns.

queryTipSettings() runs with the following TipSettingsQueryBuilder default that you can override:

• limit is 50.
• Sorted by id in ascending order.

The functions that are chained to queryTipSettings() are applied in the order they are called. For example, if you apply ascending("tipType") and then ascending("locationId"), the results are sorted first by the "tipType", and then, if there are multiple results with the same "tipType", the items are sorted by "locationId".

The following TipSettingsQueryBuilder functions are supported for the queryTipSettings() function. For a full description of the tip settings object, see the object returned for the items property in TipSettingsQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
locationId	eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
paymentTerminalId	eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
_id	eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
tipType	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
allowCustomerTip	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
allowBusinessTipAtPayment	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
allowCustomAmount	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
allowEditDistribution	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
default	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()