A query that can be applied against sales adjustments aggregate tables
Nullable
Dimension_SalesTransactionItemStringID :
StringDimension`1
Whether the SalesTransactionItemStringID should be dimensioned
Nullable
Dimension_ServiceModeStringID :
StringDimension`1
Whether ServiceModeStringID should be dimensioned
Nullable
Dimension_Created_TerminalStringID :
StringDimension`1
Whether Created_TerminalStringID 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_EventStringID :
StringDimension`1
Whether EventStringID should be dimensioned
Nullable
Dimension_TaxStringID :
StringDimension`1
Whether TaxStringID should be dimensioned
Nullable
Dimension_Revenue_CostCenterStringID :
StringDimension`1
Whether Revenue_CostCenterStringID should be dimensioned
Nullable
Dimension_Cost_CostCenterStringID :
StringDimension`1
Whether Cost_CostCenterStringID should be dimensioned
Nullable
Dimension_GroupStringID :
StringDimension`1
Whether GroupStringID should be dimensioned
Nullable
Dimension_PriceLevelStringID :
StringDimension`1
Whether PriceLevelStringID 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
Dimension_Adjustment_SalesTransactionItemStringID :
StringDimension`1
Whether Adjustment_SalesTransactionItemStringID should be dimensioned
Nullable
Dimension_AdjustmentRevenue_CostCenterStringID :
StringDimension`1
Whether AdjustmentRevenue_CostCenterStringID should be dimensioned
Nullable
Aggregation_Total_Adjustment_IncTax1 :
CurrencyAggregation
Whether the aggregation Total_Adjustment_IncTax1 should be included in the result set
Nullable
Aggregation_Total_Adjustment_IncTax2 :
CurrencyAggregation
Whether the aggregation Total_Adjustment_IncTax2 should be included in the result set
Nullable
Aggregation_Total_Adjustment_IncTax3 :
CurrencyAggregation
Whether the aggregation Total_Adjustment_IncTax3 should be included in the result set
Nullable
Aggregation_Total_Adjustment_IncTax4 :
CurrencyAggregation
Whether the aggregation Total_Adjustment_IncTax4 should be included in the result set
Nullable
Aggregation_Total_Adjustment_ExTax1 :
CurrencyAggregation
Whether the aggregation Total_Adjustment_ExTax1 should be included in the result set
Nullable
Aggregation_Total_Adjustment_ExTax2 :
CurrencyAggregation
Whether the aggregation Total_Adjustment_ExTax2 should be included in the result set
Nullable
Aggregation_Total_Adjustment_ExTax3 :
CurrencyAggregation
Whether the aggregation Total_Adjustment_ExTax3 should be included in the result set
Nullable
Aggregation_Total_Adjustment_ExTax4 :
CurrencyAggregation
Whether the aggregation Total_Adjustment_ExTax4 should be included in the result set
Nullable
Aggregation_Total_Adjustment_Amount :
CurrencyAggregation
Whether the aggregation Total_Adjustment_Amount 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_SalesTransactionItemStringID": {},
"Dimension_ServiceModeStringID": {},
"Dimension_Created_TerminalStringID": {},
"Dimension_CreatedBy_EmployeeStringID": {},
"Dimension_OwnedBy_EmployeeStringID": {},
"Dimension_EventStringID": {},
"Dimension_TaxStringID": {},
"Dimension_Revenue_CostCenterStringID": {},
"Dimension_Cost_CostCenterStringID": {},
"Dimension_GroupStringID": {},
"Dimension_PriceLevelStringID": {},
"Dimension_ZReportStringID": {},
"Dimension_Adjustment_SalesTransactionItemStringID": {},
"Dimension_AdjustmentRevenue_CostCenterStringID": {},
"Aggregation_Total_Adjustment_IncTax1": {},
"Aggregation_Total_Adjustment_IncTax2": {},
"Aggregation_Total_Adjustment_IncTax3": {},
"Aggregation_Total_Adjustment_IncTax4": {},
"Aggregation_Total_Adjustment_ExTax1": {},
"Aggregation_Total_Adjustment_ExTax2": {},
"Aggregation_Total_Adjustment_ExTax3": {},
"Aggregation_Total_Adjustment_ExTax4": {},
"Aggregation_Total_Adjustment_Amount": {},
"UseActualDateTimeForDateStart": true,
"Dimension_DateStart": {},
"Aggregation_Count": {},
"Aggregation_Total_DBGen": {},
"Limit": 321,
"Dimension_CurrencyStringID": {},
"BaseCurrencyCode": "string value",
"ConvertToBaseCurrency": true,
"IncludeBaseCurrencyRate": true,
"CurrencyExchangeRates": []
}