Skip to main content
objectRestockSuggestionForecastSettings

Fields

Whether and from which period the past consumption is projected onto the coming days.

lastDays
Int

How many days before the calculation, today included, the consumption is measured; 1 or more. Required exactly when 'forecastType' is 'LAST_DAYS'.

periodStart
DateTime

The first day of the measured period, as a calendar day in the time zone of the ERP. Required exactly when 'forecastType' is 'CUSTOM_PERIOD'.

periodEnd
DateTime

The last day of the measured period, included, as a calendar day in the time zone of the ERP; not before 'periodStart'. Required exactly when 'forecastType' is 'CUSTOM_PERIOD'.

relativePeriod
String

The period relative to the day of the calculation, resolved anew at every calculation as the ERP's period selection does. Required exactly when 'forecastType' is 'RELATIVE_PERIOD'. Known values: THIS_YEAR, LAST_YEAR, YEAR_BEFORE_LAST, LAST_TWO_YEARS, LAST_THREE_YEARS, THIS_QUARTER, LAST_QUARTER, QUARTER_BEFORE_LAST, THIRD_LAST_QUARTER, THIS_AND_LAST_QUARTER, Q1_THIS_YEAR, Q2_THIS_YEAR, Q3_THIS_YEAR, Q4_THIS_YEAR, Q1_LAST_YEAR, Q2_LAST_YEAR, Q3_LAST_YEAR, Q4_LAST_YEAR, Q1_YEAR_BEFORE_LAST, Q2_YEAR_BEFORE_LAST, Q3_YEAR_BEFORE_LAST, Q4_YEAR_BEFORE_LAST, THIS_MONTH, LAST_MONTH, MONTH_BEFORE_LAST, SINCE_START_OF_LAST_MONTH, SINCE_START_OF_MONTH_BEFORE_LAST, THIS_WEEK, LAST_WEEK, WEEK_BEFORE_LAST, SINCE_START_OF_LAST_WEEK, SINCE_START_OF_WEEK_BEFORE_LAST, LAST_SEVEN_DAYS, TODAY, YESTERDAY, DAY_BEFORE_YESTERDAY. A client treats an unknown value as not supported. The server refuses an unknown value.

horizonDays
Int!

How many coming days the forecast covers, 0 or more.

onlyDaysWithStock
Boolean!

Whether the consumption per day is computed over the days on which the item was in stock instead of all days of the period. It changes the suggested quantity only with a forecast.

subtractReturns
Boolean!

Whether the quantities returned in the period, from all warehouses, are subtracted from the consumption. It changes the suggested quantity only with a forecast.

orderPeakThresholdPercent
Int

When set, a sales order whose quantity in the period exceeds this percentage of the item's average quantity per delivery counts as an order peak and is left out of the consumption; 100 or more. Empty: every sales order counts. It changes the suggested quantity only with a forecast.