Rate change updates

Discussion

Return the data for all units where the rate changed for the provided date range based on the given date filters. The results will be sorted by the store name (ascending) and the tenant name (ascending).
The default page size is 500 results with a maximum of 2,000 results per page.

>>>

GET /v1/companies/:company_id/rate_change_updates
Returns the rate information for units in a date range based on the given date filters

Examples

GET /v1/companies/7080ac59-4366-4a77-b425-79071b0b353a/rate_change_updates
200
{
  "rate_change_updates": [
    {
      "id": "f1ac6dcb-4971-4c82-8172-a1518931767a",
      "facility_name": "0001 CUBESMART PA MALVERN OLD LANCASTER ROAD",
      "tenant_id": "2befd7ea-53dc-48d4-a6e0-24d906094ee7",
      "tenant_name": "Liam Davison",
      "unit_id": "f83fe167-9bdb-4a85-88a8-cd868102e751",
      "unit_name": "2060",
      "changed_at": "2023-08-30T08:04:49-10:00",
      "old_rate": 160.2,
      "new_rate": 194.0,
      "effective_on_date": "2023-11-06"
    },
    {
      "id": "dc2ab1e2-07b5-417e-9aa9-732407bd344f",
      "facility_name": "0101 CUBESMART VA ARLINGTON SHIRLINGTON ROAD",
      "tenant_id": "67e47779-e1d2-479b-a845-7bfeadf8f3b3",
      "tenant_name": "Emma Brown",
      "unit_id": "560d6d9c-eac3-4704-84bb-de2cc4147fd9",
      "unit_name": "3221",
      "changed_at": "2023-08-30T08:40:54-10:00",
      "old_rate": 154.0,
      "new_rate": 182.0,
      "effective_on_date": "2023-10-12"
    },
    {
      "id": "50cdce8d-83a9-49a4-9d40-fc017c63e5ca",
      "facility_name": "0101 CUBESMART VA ARLINGTON SHIRLINGTON ROAD",
      "tenant_id": "5180aecd-f88b-45a5-8abf-bf2b43b85cbd",
      "tenant_name": "Sophia Martin",
      "unit_id": "c55d7adb-fba9-4344-89f2-a40867aca6b1",
      "unit_name": "3199",
      "changed_at": "2023-08-30T08:45:18-10:00",
      "old_rate": 160.0,
      "new_rate": 189.0,
      "effective_on_date": "2023-11-11"
    },
    {
      "id": "2debaa57-a812-470d-8f5d-a3cd80801e8f",
      "facility_name": "0101 CUBESMART VA ARLINGTON SHIRLINGTON ROAD",
      "tenant_id": "0cd907e5-251b-4f71-8794-3d7954f0947e",
      "tenant_name": "Mason Smith",
      "unit_id": "1e732bef-02a6-40b0-b458-497e3e419a76",
      "unit_name": "2020",
      "changed_at": "2023-08-30T08:49:08-10:00",
      "old_rate": 160.0,
      "new_rate": 190.0,
      "effective_on_date": "2023-11-12"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 2,
      "per_page": 10,
      "total_entries": 4,
      "previous_page": null,
      "next_page": 2
    },
    "filters": {},
    "sorting": null,
    "search_term": null,
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": "233da3bd-18df-413d-bc9a-6fc6cb435157",
    "parameters": {
      "updated_after": "2023-08-30T08:00:00-10:00",
      "updated_before": "2023-08-30T09:00:00-10:00",
      "created_by": "2580",
      "per_page": "10",
      "company_id": "7080ac59-4366-4a77-b425-79071b0b353a"
    }
  }
}

Params

Param name Description
company_id
required

The company id


Value: Must be a String
updated_after
required

The datetime after which rental rate updates will be returned. Used with updated_before and format should be YYYY-MM-DDThh:mm:ss:TZD (e.g. 2023-07-16T00:00:00-05:00)


Value: Must be a DateTime
updated_before
required

The datetime before which rental rate updates will be returned. Used with updated_after and format should be YYYY-MM-DDThh:mm:ss:TZD (e.g. 2023-07-16T23:59:59-05:00)


Value: Must be a DateTime
created_by
optional

The user UUID that created the rental rate change event for the unit


Value: Must be a Integer