A query that can be applied against stock movement aggregate tables
Nullable
Dimension_StockItemStringID :
StringDimension`1
Whether StockMovementStringID should be dimensioned
Nullable
Dimension_Stock_GroupStringID :
StringDimension`1
Whether StockMovementStringID should be dimensioned
Nullable
Dimension_TerminalStringID :
StringDimension`1
Whether TerminalStringID should be dimensioned
Nullable
Dimension_PhysicalStockLocationStringID :
StringDimension`1
Whether StockMovementStringID should be dimensioned
Nullable
Dimension_Sale_GroupStringID :
StringDimension`1
Whether Sale_GroupStringID should be dimensioned
Nullable
Dimension_Sale_SalesTransactionItemStringID :
StringDimension`1
Whether Sale_SalesTransactionItemStringID should be dimensioned
Nullable
Dimension_Sale_ServiceModeStringID :
StringDimension`1
Whether Sale_ServiceModeStringID should be dimensioned
Nullable
Dimension_Sale_EventStringID :
StringDimension`1
Whether Sale_EventStringID should be dimensioned
Nullable
Dimension_Sale_Cost_CostCenterStringID :
StringDimension`1
Whether Sale_Cost_CostCenterStringID should be dimensioned
Nullable
Dimension_Sale_Revenue_CostCenterStringID :
StringDimension`1
Whether Sale_Revenue_CostCenterStringID should be dimensioned
Nullable
Dimension_StocktakeID :
Dimension
Whether StocktakeID should be dimensioned
Nullable
Dimension_StocktakeCounter :
Dimension
Whether StocktakeCounter should be dimensioned
Nullable
Dimension_MovementType :
Dimension
Whether MovementType should be dimensioned. See POSCorePublic.Enums.Sales.StockMovementTypes
Nullable
Aggregation_Total_LastCostSalesAttributed :
CurrencyAggregation
Whether the aggregation Total_LastCostSalesAttributed should be included in the result set
Nullable
Aggregation_Total_LastCostAttributed :
CurrencyAggregation
Whether the aggregation Total_LastCostAttributed should be included in the result set
Nullable
Aggregation_Total_FIFOCostSalesAttributed :
CurrencyAggregation
Whether the aggregation Total_FIFOCostSalesAttributed should be included in the result set
Nullable
Aggregation_Total_FIFOCostAttributed :
CurrencyAggregation
Whether the aggregation Total_FIFOCostAttributed should be included in the result set
Nullable
Aggregation_Total_FIFOCostSalesEstimated :
CurrencyAggregation
Whether the aggregation Total_FIFOCostSalesEstimated should be included in the result set
Nullable
Aggregation_Total_FIFOCostEstimated :
CurrencyAggregation
Whether the aggregation Total_FIFOCostEstimated should be included in the result set
Nullable
Aggregation_Total_ActualCost :
CurrencyAggregation
Whether the aggregation Total_FIFOCostEstimated should be included in the result set
Nullable
Aggregation_Count_FIFOCostSalesEstimated :
Aggregation
Whether the aggregation Count_FIFOCostSalesEstimated should be included in the result set
Nullable
Aggregation_Count_FIFOCostEstimated :
Aggregation
Whether the aggregation Count_FIFOCostEstimated should be included in the result set
Nullable
Aggregation_Total_StockQtyMovement :
Aggregation
Whether the aggregation Total_StockQtyMovement 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_StockItemStringID": {},
"Dimension_Stock_GroupStringID": {},
"Dimension_TerminalStringID": {},
"Dimension_PhysicalStockLocationStringID": {},
"Dimension_Sale_GroupStringID": {},
"Dimension_Sale_SalesTransactionItemStringID": {},
"Dimension_Sale_ServiceModeStringID": {},
"Dimension_Sale_EventStringID": {},
"Dimension_Sale_Cost_CostCenterStringID": {},
"Dimension_Sale_Revenue_CostCenterStringID": {},
"Dimension_StocktakeID": {},
"Dimension_StocktakeCounter": {},
"Dimension_MovementType": {},
"Aggregation_Total_LastCostSalesAttributed": {},
"Aggregation_Total_LastCostAttributed": {},
"Aggregation_Total_FIFOCostSalesAttributed": {},
"Aggregation_Total_FIFOCostAttributed": {},
"Aggregation_Total_FIFOCostSalesEstimated": {},
"Aggregation_Total_FIFOCostEstimated": {},
"Aggregation_Total_ActualCost": {},
"Aggregation_Count_FIFOCostSalesEstimated": {},
"Aggregation_Count_FIFOCostEstimated": {},
"Aggregation_Total_StockQtyMovement": {},
"UseActualDateTimeForDateStart": true,
"Dimension_DateStart": {},
"Aggregation_Count": {},
"Aggregation_Total_DBGen": {},
"Limit": 321,
"Dimension_CurrencyStringID": {},
"BaseCurrencyCode": "string value",
"ConvertToBaseCurrency": true,
"IncludeBaseCurrencyRate": true,
"CurrencyExchangeRates": []
}