TransactionFinalisedQuery Model

A query that can be applied against transaction aggregate tables

Nullable
Dimension_ServiceModeStringID : StringDimension`1

Whether ServiceModeStringID should be dimensioned

Nullable
Dimension_Created_TerminalStringID : StringDimension`1

Whether Created_TerminalStringID should be dimensioned

Nullable
Dimension_EventStringID : StringDimension`1

Whether EventStringID should be dimensioned

Nullable
Dimension_TaxStringID : StringDimension`1

Whether TaxStringID should be dimensioned

Nullable
Dimension_CreatedBy_EmployeeStringID : StringDimension`1

Whether CreatedBy_EmployeeStringID should be dimensioned

Nullable
Dimension_OwnedBy_EmployeeStringID : StringDimension`1

Whether OwnedBy_EmployeeStringID 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_Covers : Aggregation

Whether the aggregation Total_Covers should be included in the result set

Nullable
Aggregation_Total_Amount : CurrencyAggregation

Whether the aggregation Total_Amount should be included in the result set

Nullable
Aggregation_Total_Cost : CurrencyAggregation

Whether the aggregation Total_Cost should be included in the result set

Nullable
Aggregation_Total_TaxSales1 : CurrencyAggregation

Whether the aggregation Total_TaxSales1 should be included in the result set

Nullable
Aggregation_Total_TaxSales2 : CurrencyAggregation

Whether the aggregation Total_TaxSales2 should be included in the result set

Nullable
Aggregation_Total_TaxSales3 : CurrencyAggregation

Whether the aggregation Total_TaxSales3 should be included in the result set

Nullable
Aggregation_Total_TaxSales4 : CurrencyAggregation

Whether the aggregation Total_TaxSales4 should be included in the result set

Nullable
Aggregation_Total_IncTax1 : CurrencyAggregation

Whether the aggregation Total_IncTax1 should be included in the result set

Nullable
Aggregation_Total_IncTax2 : CurrencyAggregation

Whether the aggregation Total_IncTax2 should be included in the result set

Nullable
Aggregation_Total_IncTax3 : CurrencyAggregation

Whether the aggregation Total_IncTax3 should be included in the result set

Nullable
Aggregation_Total_IncTax4 : CurrencyAggregation

Whether the aggregation Total_IncTax4 should be included in the result set

Nullable
Aggregation_Total_ExTax1 : CurrencyAggregation

Whether the aggregation Total_ExTax1 should be included in the result set

Nullable
Aggregation_Total_ExTax2 : CurrencyAggregation

Whether the aggregation Total_ExTax2 should be included in the result set

Nullable
Aggregation_Total_ExTax3 : CurrencyAggregation

Whether the aggregation Total_ExTax3 should be included in the result set

Nullable
Aggregation_Total_ExTax4 : CurrencyAggregation

Whether the aggregation Total_ExTax4 should be included in the result set

Nullable
Aggregation_Total_DurationSec : Aggregation

Whether the aggregation Total_DurationSec 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_Created_TerminalStringID": {},
  "Dimension_EventStringID": {},
  "Dimension_TaxStringID": {},
  "Dimension_CreatedBy_EmployeeStringID": {},
  "Dimension_OwnedBy_EmployeeStringID": {},
  "Dimension_ZReportStringID": {},
  "Aggregation_Total_Covers": {},
  "Aggregation_Total_Amount": {},
  "Aggregation_Total_Cost": {},
  "Aggregation_Total_TaxSales1": {},
  "Aggregation_Total_TaxSales2": {},
  "Aggregation_Total_TaxSales3": {},
  "Aggregation_Total_TaxSales4": {},
  "Aggregation_Total_IncTax1": {},
  "Aggregation_Total_IncTax2": {},
  "Aggregation_Total_IncTax3": {},
  "Aggregation_Total_IncTax4": {},
  "Aggregation_Total_ExTax1": {},
  "Aggregation_Total_ExTax2": {},
  "Aggregation_Total_ExTax3": {},
  "Aggregation_Total_ExTax4": {},
  "Aggregation_Total_DurationSec": {},
  "UseActualDateTimeForDateStart": true,
  "Dimension_DateStart": {},
  "Aggregation_Count": {},
  "Aggregation_Total_DBGen": {},
  "Limit": 321,
  "Dimension_CurrencyStringID": {},
  "BaseCurrencyCode": "string value",
  "ConvertToBaseCurrency": true,
  "IncludeBaseCurrencyRate": true,
  "CurrencyExchangeRates": []
}