Discussion

Unit Types is a customizable list of types of units such as 'Storage Unit', 'Office Space', etc.


GET /v1/:facility_id/unit_types
Lists all unit types

Examples

GET /v1/5c5a220c-3929-4836-830d-d094ee85c7f3/unit_types
200
{
  "unit_types": [
    {
      "id": "647fe0af-a484-44d7-b06e-d2750a0204c3",
      "name": "Locker",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    {
      "id": "9a773775-91b8-4ba5-8f65-bc6f2346cf6a",
      "name": "Mailbox",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    {
      "id": "40b7fdaf-51c9-4672-b658-b9dfb5092492",
      "name": "Office Space",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    {
      "id": "f43c86d8-de21-4246-8971-9b827a7bc371",
      "name": "Parking Space",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    {
      "id": "2dc5cef5-62c2-4b94-aab7-d8f866a70700",
      "name": "Self-Storage Unit",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    },
    {
      "id": "f5642121-92c2-4243-9dbc-4e9a560fa81a",
      "name": "Wine Storage",
      "deleted": false,
      "internal_account_code": "4000",
      "code_and_description": "4000 - Rental Revenue",
      "ii_excluded": []
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "total_pages": 1,
      "per_page": 100,
      "total_entries": 6,
      "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": "5c5a220c-3929-4836-830d-d094ee85c7f3"
    }
  }
}

GET /v1/:facility_id/unit_types/:id
Show a particular unit type

Examples

GET /v1/65bea16a-954d-4dc9-afee-0de5feb74310/unit_types/4db6e7c6-dc90-44a9-9549-c13b41df1ee9
200
{
  "unit_type": {
    "id": "4db6e7c6-dc90-44a9-9549-c13b41df1ee9",
    "name": "Mailbox",
    "deleted": false,
    "internal_account_code": "4000",
    "code_and_description": "4000 - Rental Revenue",
    "ii_excluded": []
  },
  "meta": {
    "status_code": 200,
    "status_message": "OK",
    "status_cat": "https://http.cat/200",
    "request_method": "GET",
    "request_id": null,
    "parameters": {
      "facility_id": "65bea16a-954d-4dc9-afee-0de5feb74310",
      "id": "4db6e7c6-dc90-44a9-9549-c13b41df1ee9"
    }
  }
}

Params

Param name Description
id
required

Value: Must be a String