PaymentQuery Model

A query that can be applied against payment aggregate tables

Nullable
Dimension_ServiceModeStringID : StringDimension`1

Whether ServiceModeStringID should be dimensioned

Nullable
Dimension_PaymentTypeStringID : StringDimension`1

Whether PaymentTypeStringID should be dimensioned

Nullable
Dimension_Foreign_CurrencyStringID : StringDimension`1

Whether Foreign_CurrencyStringID should be dimensioned

Nullable
Dimension_Created_TerminalStringID : StringDimension`1

Whether Created_TerminalStringID should be dimensioned

Nullable
Dimension_Cashier_EmployeeStringID : StringDimension`1

Whether Cashier_EmployeeStringID should be dimensioned

Nullable
Dimension_OwnedBy_EmployeeStringID : StringDimension`1

Whether OwnedBy_EmployeeStringID should be dimensioned

Nullable
Dimension_EventStringID : StringDimension`1

Whether EventStringID should be dimensioned

Nullable
Dimension_Revenue_CostCenterStringID : StringDimension`1

Whether Revenue_CostCenterStringID should be dimensioned

Nullable
Dimension_ZReportStringID : StringDimension`1

Whether ZReportStringID should be dimensioned

Not available for TimePeriodTypeEnums broader than a day (eg Month and beyond)

Nullable
Aggregation_Total_AmountPaid : CurrencyAggregation

Whether the aggregation Total_AmountPaid should be included in the result set

Nullable
Aggregation_Total_AmountChange : CurrencyAggregation

Whether the aggregation Total_AmountChange should be included in the result set

Nullable
Aggregation_Total_AmountCashOut : CurrencyAggregation

Whether the aggregation Total_AmountCashOut should be included in the result set

Nullable
Aggregation_Total_AmountTip : CurrencyAggregation

Whether the aggregation Total_AmountTip should be included in the result set

Nullable
Aggregation_Total_AmountServiceCharge : CurrencyAggregation

Whether the aggregation Total_AmountServiceCharge should be included in the result set

Nullable
Aggregation_Total_AmountSurcharge : CurrencyAggregation

Whether the aggregation Total_AmountSurcharge should be included in the result set

Nullable
Aggregation_Total_AmountRounded : CurrencyAggregation

Whether the aggregation Total_AmountRounded should be included in the result set

Nullable
Aggregation_Total_ForeignCurrencyTendered : Aggregation

Whether the aggregation Total_ForeignCurrencyTendered should be included in the result set

Nullable
Aggregation_Total_ForeignCurrencyChange : Aggregation

Whether the aggregation Total_ForeignCurrencyChange should be included in the result set

UseActualDateTimeForDateStart : bool

If true - the returned DateStart property will be set to the actual time an item/payment/transaction/etc was created/paid/finalised.

If false - the returned DateStart property will be based off the Z TradingDate period

For TimePeriodTypes below the resolution of a Day, the TradingDate will be offset to match the time of day that the action occurred. i.e. an action aggregated hourly occuring at 4am will
have the Trading Date offset to 4am on the trading date.

For TimePeriodTypes above the resolution of a day, the trading date will be aligned to the period in question (eg - start of Month for Monthly queries)

Nullable
Dimension_DateStart : DateStartDimension

Whether the date should be included as a dimension

Nullable
Aggregation_Count : Aggregation

Whether the aggregation Count should be included in the result set

Nullable
Aggregation_Total_DBGen : Aggregation

Whether the Total_DBGen should be included in the result set

Nullable
Limit : number (int)

The maximum number of aggregates to return. Not specifying anything will default to no limit.

Nullable
Dimension_CurrencyStringID : StringDimension`1

Whether CurrencyStringID should be dimensioned

Nullable MaxLength(4)
BaseCurrencyCode : string

Set to a ISO 4217 currency code

If set - the response aggregates will have a new property BaseCurrencyCode which will be set to this value

See Also IncludeBaseCurrencyRate and CurrencyAggregate.ConvertToBaseCurrency

NOTE - currency exchange rates are provided by a third party and updated daily. There is no guarantee on their reliability/accuracy. To utilise your own rates include CurrencyExchangeRates

ConvertToBaseCurrency : bool

If set, all currency aggregations will have their values automatically converted to the BaseCurrencyCode.

See also BaseCurrencyCode for more information about how the conversion rates are calculated

IncludeBaseCurrencyRate : bool

If set responses will include a BaseCurrencyRate value. Will have no effect unless dimension CurrencyStringID -> Reporting_CurrencyCode is also set

BaseCurrencyRate wil be set to the conversion rate between the Reporting_CurrencyCode and BaseCurrencyCode.

(see also BaseCurrencyCode)

Nullable
CurrencyExchangeRates : CurrencyExchangeRate []

If specified, this must contain exchange rates for all currencies returned mapped to BaseCurrencyCode. If not included this will be instead sourced from a third party which is updated daily.

Example
{
  "Dimension_ServiceModeStringID": {},
  "Dimension_PaymentTypeStringID": {},
  "Dimension_Foreign_CurrencyStringID": {},
  "Dimension_Created_TerminalStringID": {},
  "Dimension_Cashier_EmployeeStringID": {},
  "Dimension_OwnedBy_EmployeeStringID": {},
  "Dimension_EventStringID": {},
  "Dimension_Revenue_CostCenterStringID": {},
  "Dimension_ZReportStringID": {},
  "Aggregation_Total_AmountPaid": {},
  "Aggregation_Total_AmountChange": {},
  "Aggregation_Total_AmountCashOut": {},
  "Aggregation_Total_AmountTip": {},
  "Aggregation_Total_AmountServiceCharge": {},
  "Aggregation_Total_AmountSurcharge": {},
  "Aggregation_Total_AmountRounded": {},
  "Aggregation_Total_ForeignCurrencyTendered": {},
  "Aggregation_Total_ForeignCurrencyChange": {},
  "UseActualDateTimeForDateStart": true,
  "Dimension_DateStart": {},
  "Aggregation_Count": {},
  "Aggregation_Total_DBGen": {},
  "Limit": 321,
  "Dimension_CurrencyStringID": {},
  "BaseCurrencyCode": "string value",
  "ConvertToBaseCurrency": true,
  "IncludeBaseCurrencyRate": true,
  "CurrencyExchangeRates": []
}