Revenue Forecast

Revenue forecast is needed to calculate schedule recomendations based on deployment settings. On this page, we’ll dive into the different revenue forecast endpoints you can use to manage your revenue forecast. We'll look at how to upload and update revenue forecast.

The Revenue Forecast model

The revenue forecast model contains the storeID, sales, transactions amount and date.

Properties

Name
storeID
Type
number
Description
Unique identifier of the store structure node.
Name
sales
Type
number
Description
The amount of sales forecast.
Name
transactions
Type
number
Description
The amount of transactions forecast.
Name
date
Type
number
Description
Date of month.

POST/integrations/revenueForecast

Update revenue forecast

This endpoint allows you to upload all your revenue forecast. It replaces all the existing entities with uploaded ones. See the code examples for how to upload your Revenue Forecast through ProShedule API.

Required attributes

Name
year
Type
number
Description
A year of the uploading forecast.
Name
month
Type
number (1-12)
Description
A month of the uploading forecast.
Name
body
Type
Array<revenueForecast>
Description
An array of revenueForecast objects.

Request

POST

/integrations/revenueForecast

curl \
  --location "https://api.proschedule.ambraisoft.com/integrations/revenueForecast?year=2024&month=05" \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer {token}" \
  --data-raw '[
    {
      "date": 1,
      "sales": 80000,
      "transactions": 10000,
      "storeID": "001"
    },
    {
      "date": 2,
      "sales": 80000,
      "transactions": 10000,
      "storeID": "001"
    },
    {
      "date": 3,
      "sales": 80000,
      "transactions": 10000,
      "storeID": "001"
    }
  ]'

Response

  {
      "message": "3 day forecast(s) uploaded",
      "status": 200
  }