Units
Unit information

Discussion

A unit is a logical or physical space within a facility. Units are of a certain type (which is facility-defined and freeform). Units can have any number of amenities (also facility-defined and freeform).

>>>

GET /v1/:facility_id/units
Shows all units

Examples

GET /v1/27e57062-88c0-4706-8a0b-52a7d10fe487/units
200
{
  "units": [
    {
      "id": "f85624b0-ded0-43a2-beb6-8d3b5eba4780",
      "price": 847.75,
      "name": "U73",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 1996,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "52dcc2dc-72f5-40b5-b1fb-4fcf26744759",
        "name": "Unit Type 77",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "20b36754-0289-44ae-a789-230204926e2f"
    },
    {
      "id": "22e26815-c31d-4419-8a65-856edc1aed68",
      "price": 847.75,
      "name": "U74",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 1997,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "86f3919d-0780-4f5f-a6fa-1f13bbda061f",
        "name": "Unit Type 78",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "ccd204a2-87bf-49ea-b8bf-6867f6534ffe"
    },
    {
      "id": "80be5e3f-da43-4432-91ea-0b6714e42cfd",
      "price": 847.75,
      "name": "U75",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 1998,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "6d6970ff-14a3-4d20-9369-25e3c237e9c6",
        "name": "Unit Type 79",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "a34dc674-740f-437c-9462-7579fc8e751f"
    },
    {
      "id": "f814a639-4e69-488c-98fc-65356ad2e104",
      "price": 847.75,
      "name": "U76",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 1999,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "a1b83b83-f5c4-4796-ad0f-db47c2a43c17",
        "name": "Unit Type 80",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "fdc2ee3c-a9c7-41e2-b6a6-2ea7d63acb1b"
    },
    {
      "id": "64904b07-7593-4cb0-bc21-313c1ec06bc4",
      "price": 847.75,
      "name": "U77",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2000,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "77cf33e6-e112-4113-b238-dc40b1c4d3ae",
        "name": "Unit Type 81",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "0567dcc3-e57e-48f8-aea7-efc6bc5ef16e"
    },
    {
      "id": "2c3aa981-75d1-433f-8a48-1a4c2bfb4eda",
      "price": 847.75,
      "name": "U78",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2001,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "3948a00c-6486-4231-9f9f-821353252587",
        "name": "Unit Type 82",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "13dc0bdc-1176-463f-b378-2563f2c5028b"
    },
    {
      "id": "77e82fd4-b9fb-406c-8879-381a1618ba78",
      "price": 847.75,
      "name": "U79",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2002,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "fecf4e95-9eaa-46b3-9630-def8a3cbf234",
        "name": "Unit Type 83",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "17f5bb8d-2a93-4b3c-9aa8-c2ee509526ca"
    },
    {
      "id": "845c0e04-eb7f-4932-b467-e4fa87dc9d38",
      "price": 847.75,
      "name": "U80",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2003,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "60fd4c2a-fee2-4119-bd7b-6d63f10dfddf",
        "name": "Unit Type 84",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "3fd98353-3749-447d-a50f-b64fb2fae507"
    },
    {
      "id": "116afcf7-080b-4bb0-9d0b-07c9ab2a2412",
      "price": 847.75,
      "name": "U81",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2004,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "0a831443-7d96-4811-8bda-c220eaaf33cc",
        "name": "Unit Type 85",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "f1e27382-ccdd-4670-aa16-002e003482e7"
    },
    {
      "id": "da069838-6c6f-4649-a3a6-16dcb8dd6d15",
      "price": 847.75,
      "name": "U82",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "managed_rate": null,
      "available_for_move_in": false,
      "rentable": true,
      "status": "occupied",
      "payment_status": "current",
      "current_ledger_id": "9b64e3b1-fa19-4fb5-bce8-7dbaeac4ad6d",
      "current_tenant_id": "ee5dbce1-4e77-49dc-8e6c-d1c6feb60865",
      "combo_lock_group": null,
      "combination_lock_number": null,
      "overlock_lock_number": null,
      "attribute_description": null,
      "deleted": false,
      "damaged": false,
      "complimentary": false,
      "unrentable": false,
      "company_owned": false,
      "is_prepped": null,
      "tiering": {
        "cross_sell_group_id": 2005,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "75c4b83a-5e65-415d-b4f7-c0db2cd273ed",
        "name": "Unit Type 86",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "4a8b3ff7-4b2f-4b64-9982-3bcf0f218c87"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 10,
      "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": "27e57062-88c0-4706-8a0b-52a7d10fe487"
    }
  }
}
>>>

GET /v1/:facility_id/units/:id
Show a particular unit

The field door_type has these possible values: roll_up, swing, none
The field access_type has these possible values: indoor, outdoor

Examples

GET /v1/c2d6ba2f-2ec4-40c1-b68c-e1d76c8d61f7/units/95886cc3-e0d9-4de6-9d3a-d2877218c830
200
{
  "unit": {
    "id": "95886cc3-e0d9-4de6-9d3a-d2877218c830",
    "price": 847.75,
    "name": "U72",
    "description": "",
    "width": 8.0,
    "length": 5.0,
    "height": 7.0,
    "door_height": 10.0,
    "door_width": 2.0,
    "door_type": "roll_up",
    "access_type": "indoor",
    "floor": null,
    "directions": null,
    "size": "8x5x7",
    "area": 40.0,
    "standard_rate": 847.75,
    "managed_rate": null,
    "available_for_move_in": false,
    "rentable": true,
    "status": "occupied",
    "payment_status": "current",
    "current_ledger_id": "a6141275-98d0-4453-969a-50e723a116a6",
    "current_tenant_id": "53b0fd8c-589e-46fb-bc3e-c07caca5c519",
    "combo_lock_group": null,
    "combination_lock_number": null,
    "overlock_lock_number": null,
    "attribute_description": null,
    "deleted": false,
    "damaged": false,
    "complimentary": false,
    "unrentable": false,
    "company_owned": false,
    "is_prepped": null,
    "tiering": {
      "cross_sell_group_id": 1995,
      "descriptor": "No Tier",
      "tiered_amenities": []
    },
    "custom_fields": [],
    "channel_rate": null,
    "unit_amenities": [],
    "unit_type": {
      "id": "0f7b4664-cb21-48e0-a81a-3cf8ea09629e",
      "name": "Unit Type 76",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    "unit_group_id": "4d0f0004-8fd8-4535-9e3a-f25dcc41bffd"
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "c2d6ba2f-2ec4-40c1-b68c-e1d76c8d61f7",
      "id": "95886cc3-e0d9-4de6-9d3a-d2877218c830"
    }
  }
}

Params

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

GET /v1/:facility_id/units/available
Shows all units that are available for move in

Examples

GET /v1/91ab74a4-e5f0-447d-ad32-46b253102414/units/available
200
{
  "units": [
    {
      "id": "2abc3956-a27a-4cb4-b06f-40a2ff88f28d",
      "price": 847.75,
      "name": "U93",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2016,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "bceef15c-14fc-46d1-a980-27a34a88e7aa",
        "name": "Unit Type 97",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "3d3b4948-8980-4f4b-9986-0283d0e7d61e"
    },
    {
      "id": "ce59a101-d928-435e-9aaa-59b7d65cc88c",
      "price": 847.75,
      "name": "U94",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2017,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "920f4da3-6ed1-4e30-a24c-2974457e91f4",
        "name": "Unit Type 98",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "c9923bdb-6397-4e39-8e50-a8026bdbab08"
    },
    {
      "id": "5c78a547-8d80-4423-a0b3-7b9f3d999bd9",
      "price": 847.75,
      "name": "U95",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2018,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "56a890f9-ccd8-4d8b-a34a-03ff0305ed3e",
        "name": "Unit Type 99",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "643c0c81-5805-4450-9a5b-606fc0f2d1a2"
    },
    {
      "id": "2e7e32f3-da6f-439a-9774-eff4479fa31c",
      "price": 847.75,
      "name": "U96",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2019,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "29e47c82-59e7-4422-9e9f-e0ff3bf682e5",
        "name": "Unit Type 100",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "873de35c-3ff0-4b4e-834c-79159ec0a1d0"
    },
    {
      "id": "5d47b155-7e4f-4e9f-93d9-2c6b250fe353",
      "price": 847.75,
      "name": "U97",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2020,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "41973870-9db8-4a6a-9743-979f0fb406d1",
        "name": "Unit Type 101",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "3536fc13-ad32-49e6-9f12-7effc2676fad"
    },
    {
      "id": "2183c3da-28d9-48ef-8825-0f60fab4259d",
      "price": 847.75,
      "name": "U98",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2021,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "4e7cf056-283f-415c-8e17-ffe317326a73",
        "name": "Unit Type 102",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "db02ffa2-10a1-44c3-82c2-1f3bef91ccb5"
    },
    {
      "id": "53970044-66c4-444f-ba40-79fca6f61929",
      "price": 847.75,
      "name": "U99",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2022,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "fd2b95a4-bb6c-4350-8858-fad4b56773dd",
        "name": "Unit Type 103",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "02c24ea6-839a-4203-8e1c-53280ed93cc4"
    },
    {
      "id": "11e4d582-1159-405a-adcd-66faa22766bc",
      "price": 847.75,
      "name": "U100",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2023,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "513948d3-a9ec-4d27-9750-16d6b911bb53",
        "name": "Unit Type 104",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "6187e7d9-3e91-4227-ad35-66094fffcbcb"
    },
    {
      "id": "787c0e2c-c6c4-4a60-9e4a-22187f4f245f",
      "price": 847.75,
      "name": "U101",
      "description": "",
      "width": 8.0,
      "length": 5.0,
      "height": 7.0,
      "door_height": 10.0,
      "door_width": 2.0,
      "door_type": "roll_up",
      "access_type": "indoor",
      "floor": null,
      "directions": null,
      "size": "8x5x7",
      "area": 40.0,
      "standard_rate": 847.75,
      "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": 2024,
        "descriptor": "No Tier",
        "tiered_amenities": []
      },
      "custom_fields": [],
      "channel_rate": null,
      "unit_amenities": [],
      "unit_type": {
        "id": "c809aa1b-e69f-4ec3-8bbf-f7a9943a5f3f",
        "name": "Unit Type 105",
        "deleted": false,
        "internal_account_code": "4000",
        "code_and_description": "4000 - Rental Revenue",
        "ii_excluded": []
      },
      "unit_group_id": "9458731f-f0c8-4f57-90a8-20e10de19ead"
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 9,
      "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": "91ab74a4-e5f0-447d-ad32-46b253102414"
    }
  }
}
>>>

PUT /v1/:facility_id/units/:id
Update a unit

The field door_type has these possible values: roll_up, swing, none
The field access_type has these possible values: indoor, outdoor

Examples

PUT /v1/eb414ba2-9917-4cf7-addf-292a95aa28e2/units/d8739f14-07a6-48a5-bfc8-2639708fd944
{
  "unit": {
    "name": "new unit name",
    "width": 8,
    "length": 9,
    "height": 10,
    "door_height": 8,
    "door_width": 9,
    "door_type": "swing",
    "access_type": "outdoor",
    "floor": 0,
    "walk_thru_order": 5,
    "standard_rate": 847.75,
    "rentable": false,
    "combination_lock_number": "12321",
    "attribute_description": "",
    "tax_rates": [
      "844ef046-6167-424b-b613-ab94f1d08bba"
    ],
    "unit_amenities": [
      "edecec5c-7a96-425b-a8a5-286c893356e0"
    ],
    "unit_type": "eb618b13-439b-4a6c-a720-f40e6be5e5e0"
  }
}
200
{
  "unit": {
    "id": "d8739f14-07a6-48a5-bfc8-2639708fd944",
    "price": 847.75,
    "name": "new unit name",
    "description": "Amenity 1, 0th floor",
    "width": 8.0,
    "length": 9.0,
    "height": 10.0,
    "door_height": 8.0,
    "door_width": 9.0,
    "door_type": "swing",
    "access_type": "outdoor",
    "floor": 0,
    "directions": null,
    "size": "8x9x10",
    "area": 40.0,
    "standard_rate": 847.75,
    "managed_rate": null,
    "available_for_move_in": false,
    "rentable": false,
    "status": "vacant",
    "payment_status": null,
    "current_ledger_id": null,
    "current_tenant_id": null,
    "combo_lock_group": null,
    "combination_lock_number": "12321",
    "overlock_lock_number": null,
    "attribute_description": "",
    "deleted": false,
    "damaged": false,
    "complimentary": null,
    "unrentable": true,
    "company_owned": false,
    "is_prepped": null,
    "tiering": {
      "cross_sell_group_id": 2006,
      "descriptor": "No Tier",
      "tiered_amenities": []
    },
    "custom_fields": [],
    "channel_rate": null,
    "unit_amenities": [
      {
        "id": "edecec5c-7a96-425b-a8a5-286c893356e0",
        "name": "Amenity 1",
        "short_code": "A11",
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false,
        "primary_key_id": 192
      }
    ],
    "unit_type": {
      "id": "eb618b13-439b-4a6c-a720-f40e6be5e5e0",
      "name": "Unit Type 87",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    "unit_group_id": "c665732d-9dd9-4e49-8fd1-a2e012a2c6ba"
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "PUT",
    "request_id": null,
    "parameters": {
      "unit": {
        "name": "new unit name",
        "width": 8,
        "length": 9,
        "height": 10,
        "door_height": 8,
        "door_width": 9,
        "door_type": "swing",
        "access_type": "outdoor",
        "floor": 0,
        "walk_thru_order": 5,
        "standard_rate": 847.75,
        "rentable": false,
        "combination_lock_number": "12321",
        "attribute_description": "",
        "tax_rates": [
          "844ef046-6167-424b-b613-ab94f1d08bba"
        ],
        "unit_amenities": [
          "edecec5c-7a96-425b-a8a5-286c893356e0"
        ],
        "unit_type": "eb618b13-439b-4a6c-a720-f40e6be5e5e0"
      },
      "facility_id": "eb414ba2-9917-4cf7-addf-292a95aa28e2",
      "id": "d8739f14-07a6-48a5-bfc8-2639708fd944"
    }
  }
}

Params

Param name Description
unit
required
Value: Must be a Hash
unit[name]
optional
Value: Must be a String
unit[width]
optional
Value: Must be a Integer
unit[length]
optional
Value: Must be a Integer
unit[height]
optional
Value: Must be a Integer
unit[door_height]
optional
Value: Must be a Integer
unit[door_width]
optional
Value: Must be a Integer
unit[door_type]
optional
Value: Must be a String
unit[access_type]
optional
Value: Must be a String
unit[floor]
optional , nil allowed

Floor number


Value: Must be a Integer
unit[walk_thru_order]
optional , nil allowed

Number of unit in walk through order


Value: Must be a Integer
unit[standard_rate]
optional
Value: Must be a Integer
unit[rentable]
optional , nil allowed

Is the unit rentable


Value: Must be one of: <code>true</code>, <code>false</code>.
unit[combination_lock_number]
optional , nil allowed
Value: Must be a String
unit[overlock_lock_number]
optional , nil allowed
Value: Must be a String
unit[attribute_description]
optional , nil allowed
Value: Must be a String
unit[tax_rates]
optional , nil allowed

Array of tax rate uuids


Value: Must be an array of String
unit[unit_amenities]
optional , nil allowed

Array of unit amenity uuids


Value: Must be an array of String
unit[unit_type]
optional

Unit type uuid


Value: Must be a String
unit[fully_enclosed]
optional , nil allowed

True if unit is fully enclosed. If new units belong to an existing unit group, the existing group's value will take precedence.


Value: Must be one of: <code>true</code>, <code>false</code>.
unit[custom_fields]
optional

Array of custom field name and value pairs


Value: Must be an array of Hash
>>>

POST /v1/:facility_id/units
Create one or more new units within the same group.

Discussion

This endpoint can create multiple identical units at once by providing a comma-separated list of names for the name parameter

Examples

POST /v1/ac554359-a2af-4d82-9c81-bb455cf7a7a6/units
{
  "unit": {
    "name": "new unit name",
    "width": 8,
    "length": 9,
    "height": 10,
    "door_height": 8,
    "door_width": 9,
    "door_type": "swing",
    "access_type": "outdoor",
    "floor": 0,
    "walk_thru_order": 5,
    "standard_rate": 40,
    "rentable": false,
    "combination_lock_number": "12321",
    "fully_enclosed": true,
    "attribute_description": "",
    "tax_rates": [
      "e308a271-3ae6-4cd2-b9e5-b46a6ebd700c"
    ],
    "unit_amenities": [
      "edecec5c-7a96-425b-a8a5-286c893356e0"
    ],
    "unit_type": "70c02ac9-c88c-484c-8354-56c87f453e08"
  }
}
200
{
  "units": {
    "id": "d3a70c59-2456-4a5f-b334-f2905ed1bd36",
    "price": 40.0,
    "name": "new unit name",
    "description": "Amenity 2, 0th floor",
    "width": 8.0,
    "length": 9.0,
    "height": 10.0,
    "door_height": 8.0,
    "door_width": 9.0,
    "door_type": "swing",
    "access_type": "outdoor",
    "floor": 0,
    "directions": null,
    "size": "8x9x10",
    "area": 72.0,
    "standard_rate": 40.0,
    "managed_rate": null,
    "available_for_move_in": false,
    "rentable": false,
    "status": "vacant",
    "payment_status": null,
    "current_ledger_id": null,
    "current_tenant_id": null,
    "combination_lock_number": "12321",
    "attribute_description": "",
    "deleted": false,
    "damaged": false,
    "complimentary": null,
    "unrentable": true,
    "company_owned": false,
    "channel_rate": null,
    "unit_amenities": [
      {
        "id": "edecec5c-7a96-425b-a8a5-286c893356e0",
        "name": "Amenity 2",
        "short_code": null,
        "show_in_sales_center_filter_dropdown": false,
        "deleted": false
      }
    ],
    "unit_type": {
      "id": "70c02ac9-c88c-484c-8354-56c87f453e08",
      "name": "Unit Type 100",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue"
    },
    "unit_group_id": "de656472-d00f-47a0-9488-52d9e48825d5"
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "POST",
    "request_id": null,
    "parameters": {
      "unit": {
        "name": "new unit name",
        "width": 8,
        "length": 9,
        "height": 10,
        "door_height": 8,
        "door_width": 9,
        "door_type": "swing",
        "access_type": "outdoor",
        "floor": 0,
        "walk_thru_order": 5,
        "standard_rate": 40,
        "rentable": false,
        "combination_lock_number": "12321",
        "attribute_description": "",
        "tax_rates": [
          "e308a271-3ae6-4cd2-b9e5-b46a6ebd700c"
        ],
        "unit_amenities": [
          "edecec5c-7a96-425b-a8a5-286c893356e0"
        ],
        "unit_type": "70c02ac9-c88c-484c-8354-56c87f453e08"
      },
      "facility_id": "ccdaa779-9e3a-48a5-a75c-f824531e05fa",
      "id": "d3a70c59-2456-4a5f-b334-f2905ed1bd36"
    }
  }
}

Params

Param name Description
unit
required
Value: Must be a Hash
unit[name]
required
Value: Must be a String
unit[width]
required
Value: Must be a Integer
unit[length]
required
Value: Must be a Integer
unit[height]
required
Value: Must be a Integer
unit[door_height]
required
Value: Must be a Integer
unit[door_width]
required
Value: Must be a Integer
unit[door_type]
required
Value: Must be a String
unit[access_type]
required
Value: Must be a String
unit[floor]
optional , nil allowed

Floor number


Value: Must be a Integer
unit[walk_thru_order]
optional , nil allowed

Number of unit in walk through order


Value: Must be a Integer
unit[standard_rate]
required
Value: Must be a Integer
unit[rentable]
optional , nil allowed

Is the unit rentable


Value: Must be one of: <code>true</code>, <code>false</code>.
unit[combination_lock_number]
optional , nil allowed
Value: Must be a String
unit[overlock_lock_number]
optional , nil allowed
Value: Must be a String
unit[attribute_description]
optional , nil allowed
Value: Must be a String
unit[tax_rates]
optional , nil allowed

Array of tax rate uuids


Value: Must be an array of String
unit[unit_amenities]
optional , nil allowed

Array of unit amenity uuids


Value: Must be an array of String
unit[unit_type]
required

Unit type uuid


Value: Must be a String
unit[fully_enclosed]
optional , nil allowed

True if unit is fully enclosed. If new units belong to an existing unit group, the existing group's value will take precedence.


Value: Must be one of: <code>true</code>, <code>false</code>.
unit[custom_fields]
required

Array of custom field name and value pairs


Value: Must be an array of Hash
>>>

GET /v1/:facility_id/units/rate_history
Shows the detailed change history of all rate types for unit(s)

Discussion

Given only a facility id, the default behavior of this endpoint will return relevent rate history details (for ALL units) with an effective_datetime falling on or between the beginning-of-day and end-of-day on which the request was made.
Optional: A unit_id may be supplied with the request, limiting the response results to rate history details associated with the given unit.
Optional: A start_date and end_date may be supplied with the request, which can provide rate history details over a span of time vs. the default behavior which is a 1 day timespan. The start_date and end_date may be no more than 31 days from one another.

Examples

GET /v1/e5e6236c-050f-4f28-b5c4-b57ce5ddfadb/units/rate_history?start_date=2020-02-25&end_date=2020-03-25
200
{
  "units_rate_history": [
    {
      "unit_name": "477",
      "unit_id": "c5e08455-962b-438b-8ca1-2f539fcf9ba0",
      "rate_type": "standard",
      "rate": 39.0,
      "effective_datetime": "2020-03-11T16:15:52.851-04:00",
      "event_id": "a019c89c-603e-40c9-93c0-2fbb506e5716"
    },
    {
      "unit_name": "588",
      "unit_id": "a2a08455-962b-438b-8ca1-2f539fcf9ba0",
      "rate_type": "managed",
      "rate": 39.0,
      "effective_datetime": "2020-02-25T12:21:44.536-05:00",
      "event_id": "a489c18f-57ec-4126-a2f1-2b22a4783cf0"
    },
    {
      "unit_name": "A140",
      "unit_id": "d9d08455-962b-438b-8ca1-2f539fcf9ba0",
      "rate_type": "Web",
      "rate": 49.0,
      "effective_datetime": "2020-02-25T12:21:44.512-05:00",
      "event_id": "37ebf846-3c71-4384-a9cd-c2187d2fcc2e"
    }
  ],
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "e5e6236c-050f-4f28-b5c4-b57ce5ddfadb",
      "start_date": "2020-02-25",
      "end_date": "2020-03-25"
    }
  }
}
>>>

GET /v1/:facility_id/units/:unit_id/future_scheduled_rates
Future scheduled rate changes for currently or previously occupied units.

Params

Param name Description
unit_id
required
Value: Must be a String