Get store budget for a year

Get the budget for a store for a full year, with monthly amounts and the daily distribution per month. Only months that have a budget are returned; the months array is empty when no budget exists for the year.

Required permissions: REPORTING, SALES_ORDER, RETURN_ORDER

get

/tenants/{tenantUid}/stores/{storeUid}/budgets/{budgetYear}

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringRequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

budgetYearinteger · min: 2000 · max: 2100Required

The year the budget applies to.

Responses

200

Store budget for a year

application/json

yearintegerRequired

get/tenants/{tenantUid}/stores/{storeUid}/budgets/{budgetYear}

GET /v2/tenants/{tenantUid}/stores/{storeUid}/budgets/{budgetYear} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Store budget for a year

{
  "year": 1,
  "months": [
    {
      "month": 1,
      "salesAmountExVat": 1,
      "revenueAmountExVat": 1,
      "days": [
        {
          "date": "2026-01-01",
          "salesAmountExVat": 1
        }
      ]
    }
  ]
}