Variable discounts

Discussion

Return data for units that are discounted through a variable discount promotion within the specified date range. The results will be sorted by the store name (ascending) and the tenant last name (ascending).
The default page size is 500 results with a maximum of 2,000 results per page.

>>>

GET /v1/companies/:company_id/variable_discounts
Returns the discount lines for units in a date range based on the given date filters

Examples

GET /v1/companies/7080ac59-4366-4a77-b425-79071b0b353a/variable_discounts
200
{
  "variable_discounts": [
    {
      "id": "b067e626-8d30-4b65-b2ab-08b50cd3834a",
      "facility_name": "0296 CUBESMART VA FREDERICKSBURG PATRIOT HWY",
      "tenant_name": "Odin Smit",
      "tenant_id": "3464bd55-d545-4645-97a8-e4dd94d5cd51",
      "unit_name": "001",
      "unit_id": "13dd27a3-526f-4883-a18d-38ff6009d158",
      "created_at": "2023-09-05T07:09:31-10:00",
      "discounted_by_name": "Melissa Hill",
      "discounted_by_id": "884418c4-ac2f-4544-bd1a-b29d05f69820",
      "amount": 6.5,
      "note": "25% OFF, CUSTOMER CARE REP CONCESSION"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 500,
      "total_entries": 1,
      "previous_page": null,
      "next_page": null
    },
    "filters": {},
    "sorting": null,
    "search_term": null,
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": "24126543-6a5c-4d0a-ae32-4afc7e31727e",
    "parameters": {
      "start_date": "2023-09-05",
      "end_date": "2023-09-05",
      "company_id": "7080ac59-4366-4a77-b425-79071b0b353a"
    }
  }
}

Params

Param name Description
company_id
required

The company id


Value: Must be a String
start_date
required

The date after which the discount was created for the unit. Used with end_date and format should be YYYY-MM-DD (e.g. 2023-07-16)


Value: Must be a Date
end_date
required

The date before which the discount was created for the unit. Used with start_date and format should be YYYY-MM-DD (e.g. 2023-07-16)


Value: Must be a Date