Unit groups
Unit Group information

Discussion

A unit group is a collection of units with the same type (which is facility-defined and freeform).

>>>

GET /v1/:facility_id/unit_groups
Shows all unit groups

Examples

GET /v1/62cfa470-447c-46aa-a731-0e077d651e2c/unit_groups
200
{
  "unit_groups": [
    {
      "id": "ebc1c659-17f9-4c1d-afc6-e48d1ffb7fea",
      "price": 50.0,
      "group_key": "100x100x100 - $50.00 - 2114 - [195] - 1",
      "name": "100x100x100 - $50.00 - 2114 - [195] - 1",
      "available_units_count": 5,
      "total_units_count": 5,
      "total_non_excluded_units_count": 5,
      "size": "100x100x100",
      "standard_rate": 50.0,
      "floor": 1,
      "reduced_price": 50.0,
      "cyo_reduced_prices": {},
      "occupancy_percent": 0.0,
      "area": 10000.0,
      "length": 100.0,
      "width": 100.0,
      "height": 100.0,
      "due_at_move_in": 50.0,
      "due_at_move_in_without_fees": 50.0,
      "due_monthly": 50.0,
      "attribute_description": "CDN",
      "description": "(CDN) - 24 Hour Access, 1st floor",
      "invoiceable_fees": [],
      "average_rent": 0.0,
      "active_rate_type": "standard_rate",
      "scheduled_move_outs": [],
      "managed_rate": null,
      "reservation_fee": null,
      "tiering": {
        "cross_sell_group_id": 2053,
        "descriptor": "No Tier",
        "justification": null,
        "tiered_amenities": []
      },
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "a28a86b9-16d3-4416-beac-af41a04d0bbd",
          "name": "24 Hour Access",
          "short_code": "A14",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 195
        }
      ],
      "unit_type": {
        "id": "7c2fe0c0-7ae1-47df-a246-33172da502a4",
        "name": "Unit Type 142",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "discount_plans": [],
      "channel_rate_ids": [],
      "available_upgrade_to_unit_groups": []
    },
    {
      "id": "8240cf8b-5d76-4161-9b14-7c42b27e7901",
      "price": 50.0,
      "group_key": "1x1x1 - $50.00 - 2114 - 1",
      "name": "1x1x1 - $50.00 - 2114 - 1",
      "available_units_count": 1,
      "total_units_count": 1,
      "total_non_excluded_units_count": 1,
      "size": "1x1x1",
      "standard_rate": 50.0,
      "floor": 1,
      "reduced_price": 50.0,
      "cyo_reduced_prices": {},
      "occupancy_percent": 0.0,
      "area": 1.0,
      "length": 1.0,
      "width": 1.0,
      "height": 1.0,
      "due_at_move_in": 50.0,
      "due_at_move_in_without_fees": 50.0,
      "due_monthly": 50.0,
      "attribute_description": "CEN",
      "description": "(CEN) - 1st floor",
      "invoiceable_fees": [],
      "average_rent": 0.0,
      "active_rate_type": "standard_rate",
      "scheduled_move_outs": [],
      "managed_rate": null,
      "reservation_fee": null,
      "tiering": {
        "cross_sell_group_id": 2055,
        "descriptor": "No Tier",
        "justification": null,
        "tiered_amenities": []
      },
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "7c2fe0c0-7ae1-47df-a246-33172da502a4",
        "name": "Unit Type 142",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "discount_plans": [],
      "channel_rate_ids": [],
      "available_upgrade_to_unit_groups": []
    },
    {
      "id": "eb7840fa-c1d4-456d-8290-8bc1deef058e",
      "price": 20.0,
      "group_key": "10x10x10 - $20.00 - 2114 - 1",
      "name": "10x10x10 - $20.00 - 2114 - 1",
      "available_units_count": 1,
      "total_units_count": 1,
      "total_non_excluded_units_count": 1,
      "size": "10x10x10",
      "standard_rate": 20.0,
      "floor": 1,
      "reduced_price": 20.0,
      "cyo_reduced_prices": {},
      "occupancy_percent": 0.0,
      "area": 100.0,
      "length": 10.0,
      "width": 10.0,
      "height": 10.0,
      "due_at_move_in": 20.0,
      "due_at_move_in_without_fees": 20.0,
      "due_monthly": 20.0,
      "attribute_description": "CENM",
      "description": "(CENM) - 1st floor",
      "invoiceable_fees": [],
      "average_rent": 0.0,
      "active_rate_type": "standard_rate",
      "scheduled_move_outs": [],
      "managed_rate": null,
      "reservation_fee": null,
      "tiering": {
        "cross_sell_group_id": 2056,
        "descriptor": "No Tier",
        "justification": null,
        "tiered_amenities": []
      },
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "7c2fe0c0-7ae1-47df-a246-33172da502a4",
        "name": "Unit Type 142",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "discount_plans": [],
      "channel_rate_ids": [],
      "available_upgrade_to_unit_groups": []
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 3,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "62cfa470-447c-46aa-a731-0e077d651e2c"
    }
  }
}
>>>

GET /v1/:facility_id/unit_groups/:id
Shows a unit group by id

Examples

GET /v1/fc065dee-2fc7-46fd-9c31-0417430f17ba/unit_groups/c4345b83-d0d1-444d-98ad-df5da6d73465
200
{
  "unit_group": {
    "id": "c4345b83-d0d1-444d-98ad-df5da6d73465",
    "price": 50.0,
    "group_key": "100x100x100 - $50.00 - 2116 - [197] - 1",
    "name": "100x100x100 - $50.00 - 2116 - [197] - 1",
    "available_units_count": 5,
    "total_units_count": 5,
    "total_non_excluded_units_count": 5,
    "size": "100x100x100",
    "standard_rate": 50.0,
    "floor": 1,
    "reduced_price": 50.0,
    "cyo_reduced_prices": {},
    "occupancy_percent": 0.0,
    "area": 10000.0,
    "length": 100.0,
    "width": 100.0,
    "height": 100.0,
    "due_at_move_in": 50.0,
    "due_at_move_in_without_fees": 50.0,
    "due_monthly": 50.0,
    "attribute_description": "CDN",
    "description": "(CDN) - 24 Hour Access, 1st floor",
    "invoiceable_fees": [],
    "average_rent": 0.0,
    "active_rate_type": "standard_rate",
    "scheduled_move_outs": [],
    "managed_rate": null,
    "reservation_fee": null,
    "tiering": {
      "cross_sell_group_id": 2058,
      "descriptor": "No Tier",
      "justification": null,
      "tiered_amenities": []
    },
    "channel_rate": null,
    "unit_amenities": [
      {
        "id": "d4064472-2826-4026-956a-96d2c4469acc",
        "name": "24 Hour Access",
        "short_code": "A16",
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false,
        "primary_key_id": 197
      }
    ],
    "unit_type": {
      "id": "b29a9347-cfaf-41f5-85dd-011e909db5e7",
      "name": "Unit Type 143",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    "discount_plans": [],
    "channel_rate_ids": [],
    "available_upgrade_to_unit_groups": []
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "fc065dee-2fc7-46fd-9c31-0417430f17ba",
      "id": "c4345b83-d0d1-444d-98ad-df5da6d73465"
    }
  }
}

Params

Param name Description
id
required
Value: Must be a String
>>>

GET /v1/:facility_id/unit_groups/:unit_group_id/units
Shows a unit group's units

Examples

GET /v1/6cdcf1bb-b5c4-45e0-b344-ba046a414582/unit_groups/d0b2b47e-1b06-4184-a0e6-d42a820a3c11/units
200
{
  "units": [
    {
      "id": "33b96595-4682-4511-92f0-0e95f10d5f5a",
      "price": 50.0,
      "name": "101",
      "description": "24 Hour Access, 1st floor",
      "width": 100.0,
      "length": 100.0,
      "height": 100.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": 1,
      "directions": null,
      "size": "100x100x100",
      "area": 10000.0,
      "standard_rate": 50.0,
      "managed_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "tiering": {
        "cross_sell_group_id": 2048,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "4179e10a-6fc3-4e06-ab03-7f504a1c0caa",
          "name": "24 Hour Access",
          "short_code": "A12",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 193
        }
      ],
      "unit_type": {
        "id": "3726927d-b3c7-4b5e-a60c-019a8e28a511",
        "name": "Unit Type 141",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "d0b2b47e-1b06-4184-a0e6-d42a820a3c11"
    },
    {
      "id": "48c5e8c6-d5e5-4b71-baf4-e26f4d3ebc1b",
      "price": 50.0,
      "name": "102",
      "description": "24 Hour Access, 1st floor",
      "width": 100.0,
      "length": 100.0,
      "height": 100.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": 1,
      "directions": null,
      "size": "100x100x100",
      "area": 10000.0,
      "standard_rate": 50.0,
      "managed_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "tiering": {
        "cross_sell_group_id": 2048,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "4179e10a-6fc3-4e06-ab03-7f504a1c0caa",
          "name": "24 Hour Access",
          "short_code": "A12",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 193
        }
      ],
      "unit_type": {
        "id": "3726927d-b3c7-4b5e-a60c-019a8e28a511",
        "name": "Unit Type 141",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "d0b2b47e-1b06-4184-a0e6-d42a820a3c11"
    },
    {
      "id": "99af37c2-2649-4d08-9180-b22f4a4d0e00",
      "price": 50.0,
      "name": "103",
      "description": "24 Hour Access, 1st floor",
      "width": 100.0,
      "length": 100.0,
      "height": 100.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": 1,
      "directions": null,
      "size": "100x100x100",
      "area": 10000.0,
      "standard_rate": 50.0,
      "managed_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "tiering": {
        "cross_sell_group_id": 2048,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "4179e10a-6fc3-4e06-ab03-7f504a1c0caa",
          "name": "24 Hour Access",
          "short_code": "A12",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 193
        }
      ],
      "unit_type": {
        "id": "3726927d-b3c7-4b5e-a60c-019a8e28a511",
        "name": "Unit Type 141",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "d0b2b47e-1b06-4184-a0e6-d42a820a3c11"
    },
    {
      "id": "74590c34-e90f-4cb7-9e3f-fb3185a75124",
      "price": 50.0,
      "name": "1101a",
      "description": "Climate Controlled, 1st floor",
      "width": 100.0,
      "length": 100.0,
      "height": 100.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": 1,
      "directions": null,
      "size": "100x100x100",
      "area": 10000.0,
      "standard_rate": 50.0,
      "managed_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "tiering": {
        "cross_sell_group_id": 2048,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "fb92d848-1cb3-44f1-8165-8ab4908e667b",
          "name": "Climate Controlled",
          "short_code": "A13",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 194
        }
      ],
      "unit_type": {
        "id": "284b00ff-7f7b-4bb6-8fb8-f3f5f846d44e",
        "name": "other type",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "d0b2b47e-1b06-4184-a0e6-d42a820a3c11"
    },
    {
      "id": "8171e324-7c3e-448a-a4d2-78e238c90748",
      "price": 50.0,
      "name": "1101b",
      "description": "Climate Controlled, 1st floor",
      "width": 100.0,
      "length": 100.0,
      "height": 100.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": 1,
      "directions": null,
      "size": "100x100x100",
      "area": 10000.0,
      "standard_rate": 50.0,
      "managed_rate": null,
      "available_for_move_in": true,
      "rentable": true,
      "status": "vacant",
      "payment_status": null,
      "current_ledger_id": null,
      "current_tenant_id": null,
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": null,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "tiering": {
        "cross_sell_group_id": 2048,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [
        {
          "id": "fb92d848-1cb3-44f1-8165-8ab4908e667b",
          "name": "Climate Controlled",
          "short_code": "A13",
          "show_in_sales_center_filter_dropdown": false,
          "deleted": false,
          "primary_key_id": 194
        }
      ],
      "unit_type": {
        "id": "284b00ff-7f7b-4bb6-8fb8-f3f5f846d44e",
        "name": "other type",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "d0b2b47e-1b06-4184-a0e6-d42a820a3c11"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 5,
      "previous_page": null,
      "next_page": null
    },
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "6cdcf1bb-b5c4-45e0-b344-ba046a414582",
      "unit_group_id": "d0b2b47e-1b06-4184-a0e6-d42a820a3c11"
    }
  }
}

Params

Param name Description
id
required
Value: Must be a String
>>>

GET /v1/:facility_id/unit_groups/:unit_group_id/review_cost
Review the cost of a unit group with discount plans applied

Params

Param name Description
discount_plans
required

A collection of discount plan ids


Value: Must be an array of any type
quoted_rate
optional

The base rate to apply discounts to. If not specified, the current rate of the unit group will be used.


Value: Must be a Float
unit_group_id
required
Value: Must be a String
desired_move_in_date
optional

Desired move-in date. Format: YYYY-MM-DD


Value: Must be a Date