# Retrieve a unit type by Id

Fetch detailed information about a specific unit type within the Property Management System (PMS) using its unique ID. Unit types are essential for categorizing accommodations based on factors such as size, layout, amenities, and occupancy capacity. This endpoint is useful for retrieving unit type-specific data for inventory management, pricing strategies, availability searches, and reporting. The response includes details about the unit type, including its classification and characteristics. If the specified unit type ID does not exist, a  error will be returned. In case of an unexpected system error, a  will be triggered.

Endpoint: GET /api/v3/unitTypes/{id}
Version: 3.0.4
Security: OAuth2

## Path parameters:

  - `id` (integer, required)
    The unique identifier of the unit type

## Response 200 fields (application/json):

  - `id` (integer)
    Unique identifier of the unit type

  - `building` (object, required)
    Building associated with the unit type

  - `building.id` (integer)
    Unique identifier of the building

  - `building.name` (string)
    Name of the building

  - `name` (string, required)
    Name of the unit type

  - `unitTypeCode` (string, required)
    Code of the unit type

  - `shortDescription` (string, required)
    Short description of the unit type

  - `minStay` (integer, required)
    Minimum stay duration for the unit type

  - `maxStay` (integer, required)
    Maximum stay duration for the unit type

  - `maxOccupancy` (integer, required)
    Maximum occupancy for the unit type

  - `type` (string, required)
    Type of the unit
    Enum: "STUDIO", "ONE_BEDROOM", "TWO_BEDROOM", "THREE_BEDROOM", "FOUR_BEDROOM", "FIVE_BEDROOM", "SIX_BEDROOM", "TWIN_ROOM", "COSY", "STANDARD", "COMFY", "BIG", "DOUBLE_ROOM", "TWODIO", "COSY_STUDIO", "CLASSIC_STUDIO", "CLASSIC_PLUS_STUDIO", "PREMIUM_STUDIO", "ACCESSIBLE_STUDIO", "OFFICE", "PARKING_SPACE", "MEETING_ROOM", "COMMUNAL_AREA", "RETAIL_SPACE", "SHUFFLE", "STORAGE_SPACE", "STORAGE_SPACE_TWO", "STORAGE_SPACE_THREE", "STORAGE_SPACE_FOUR", "STORAGE_SPACE_FIVE", "STORAGE_SPACE_SIX"

  - `maxInternetBookingLimit` (integer, required)
    Maximum internet booking limit for the unit type

  - `sortOrder` (integer)
    Sort order of the unit type

  - `networkUnitOwner` (object)
    Company data to update

  - `networkUnitOwner.id` (integer)
    The unique identifier of the company

  - `networkUnitOwner.companyName` (string, required)
    The name of the company

  - `networkUnitOwner.consolidatedBilling` (boolean)
    Indicates if the company uses consolidated billing

  - `networkUnitOwner.companyNumber` (string)
    The registration number of the company

  - `networkUnitOwner.vatRegistered` (boolean)
    Indicates if the company is VAT registered

  - `networkUnitOwner.vatNumber` (string)
    The VAT number of the company

  - `networkUnitOwner.websiteUrl` (string)
    The website URL of the company

  - `networkUnitOwner.creditLimit` (number)
    The credit limit of the company

  - `networkUnitOwner.creditAccount` (boolean)
    Indicates if the company has a credit account

  - `networkUnitOwner.companyFinanceAccount` (object)
    The finance account details of the company

  - `networkUnitOwner.companyFinanceAccount.id` (integer)
    Unique identifier of the finance account

  - `networkUnitOwner.companyFinanceAccount.accountCode` (string)
    Account code of the finance account

  - `networkUnitOwner.companyFinanceAccount.contact` (object)
    The primary correspondence contact of the company

  - `networkUnitOwner.companyFinanceAccount.contact.id` (integer)
    Unique identifier of the contact

  - `networkUnitOwner.companyFinanceAccount.contact.firstName` (string)
    First name of the contact

  - `networkUnitOwner.companyFinanceAccount.contact.lastName` (string)
    Last name of the contact

  - `networkUnitOwner.companyFinanceAccount.company` (object)
    Company summary associated with the finance account

  - `networkUnitOwner.companyFinanceAccount.company.id` (integer)
    Unique identifier of the company

  - `networkUnitOwner.companyFinanceAccount.company.companyName` (string)
    Name of the company

  - `networkUnitOwner.companyFinanceAccount.externalId` (string)
    External identifier of the finance account

  - `networkUnitOwner.companyFinanceAccount.exportedDate` (string)
    Date when the finance account was exported

  - `networkUnitOwner.companyFinanceAccount.exportStatus` (string)
    Export status of the finance account
    Enum: "SKIPPED", "CREATED", "PENDING", "SENT", "EXPORTED", "FAILED", "IMPORTED"

  - `networkUnitOwner.billingAddress` (object, required)
    The primary address of the company

  - `networkUnitOwner.billingAddress.id` (integer)
    Unique identifier of the address

  - `networkUnitOwner.billingAddress.addressLine1` (string)
    First line of the address

  - `networkUnitOwner.billingAddress.addressLine2` (string)
    Second line of the address

  - `networkUnitOwner.billingAddress.addressLine3` (string)
    Third line of the address

  - `networkUnitOwner.billingAddress.city` (string)
    City of the address

  - `networkUnitOwner.billingAddress.postCode` (string)
    Postal code of the address

  - `networkUnitOwner.billingAddress.country` (object)
    Data Transfer Object representing a Country entity in the Property Management System (PMS).

  - `networkUnitOwner.billingAddress.country.id` (integer)
    Unique identifier of the country

  - `networkUnitOwner.billingAddress.country.name` (string, required)
    Name of the country

  - `networkUnitOwner.billingAddress.country.sortOrder` (integer, required)
    Sort order of the country

  - `networkUnitOwner.billingAddress.country.countryCodeAlpha2` (string, required)
    Alpha-2 country code

  - `networkUnitOwner.billingAddress.country.countryCodeAlpha3` (string, required)
    Alpha-3 country code

  - `networkUnitOwner.billingAddress.country.countryCodeNumeric` (string, required)
    Numeric country code

  - `networkUnitOwner.billingAddress.nickname` (string)

  - `networkUnitOwner.primaryCompanyAddress` (object, required)
    The primary address of the company

  - `networkUnitOwner.primaryCompanyEmailAddress` (object)
    The primary email address of the company

  - `networkUnitOwner.primaryCompanyEmailAddress.id` (integer)
    Unique identifier of the email address
    Example: 1

  - `networkUnitOwner.primaryCompanyEmailAddress.email` (string, required)

  - `networkUnitOwner.primaryCompanyEmailAddress.nickname` (string)
    Nickname of the email address
    Example: "Work"

  - `networkUnitOwner.primaryCompanyEmailAddress.primary` (boolean)
    Primary email address
    Example: true

  - `networkUnitOwner.primaryCompanyTelephoneNumber` (object, required)
    The primary telephone number of the company

  - `networkUnitOwner.primaryCompanyTelephoneNumber.id` (integer)
    Unique identifier of the company telephone number

  - `networkUnitOwner.primaryCompanyTelephoneNumber.number` (string)
    Telephone number

  - `networkUnitOwner.primaryCompanyTelephoneNumber.nickname` (string)
    Nickname for the telephone number

  - `networkUnitOwner.primaryCompanyTelephoneNumber.primary` (boolean)
    Indicates if this is the primary telephone number

  - `networkUnitOwner.type` (string)
    The type of the company
    Enum: "CUSTOMER", "BOOKING_AGENT", "SUPPLIER", "NETWORK_PROVIDER", "LANDLORD", "LETTING_AGENT", "MANAGING_AGENT", "BILLING", "PARENT"

  - `networkUnitOwner.parentCompany` (object)
    Company data to update

  - `networkUnitOwner.status` (string)
    The status of the company
    Enum: "ACTIVE", "INACTIVE", "ARCHIVED"

  - `networkUnitOwner.hasPublicLiability` (boolean)
    Indicates if the company has public liability

  - `networkUnitOwner.liabilityAmount` (number)
    The liability amount of the company

  - `networkUnitOwner.riskAssessment` (boolean)
    Indicates if the company has a risk assessment

  - `networkUnitOwner.paymentTerm` (number)
    The payment term of the company

  - `networkUnitOwner.wrapInvoicesManually` (boolean)
    Indicates if the company wraps invoices manually

  - `networkUnitOwner.referrer` (object)
    The referrer details of the company

  - `networkUnitOwner.referrer.id` (integer)
    Unique identifier of the referrer

  - `networkUnitOwner.referrer.code` (string)
    Code of the referrer

  - `networkUnitOwner.referrer.name` (string)
    Name of the referrer

  - `networkUnitOwner.industry` (object)
    The industry of the company

  - `networkUnitOwner.industry.id` (integer)
    Unique identifier of the industry

  - `networkUnitOwner.industry.name` (string)
    Name of the industry

  - `networkUnitOwner.marketSegment` (object)
    The market segment of the company

  - `networkUnitOwner.marketSegment.id` (integer)
    Unique identifier of the market segment

  - `networkUnitOwner.marketSegment.name` (string, required)
    Name of the market segment

  - `networkUnitOwner.primaryCorrespondenceContact` (object)
    The primary correspondence contact of the company

  - `networkUnitOwner.emailTo` (string)
    The email to details for the company
    Enum: "BOOKING_CONTACT", "BOOKING_GUESTS", "BOOKING_CONTACT_AND_GUESTS"

  - `networkUnitOwner.bankName` (string)
    The bank name of the company

  - `networkUnitOwner.bankAccountName` (string)
    The bank account name of the company

  - `networkUnitOwner.bankAccountNo` (string)
    The bank account number of the company

  - `networkUnitOwner.bankSortCode` (string)
    The bank sort code of the company

  - `networkUnitOwner.bankBicCode` (string)
    The bank BIC code of the company

  - `networkUnitOwner.bankIbanCode` (string)
    The bank IBAN code of the company

  - `networkUnitOwner.linkCode` (string)
    The link code of the company

  - `networkUnitOwner.lifecycleStage` (string)
    The lifecycle stage of the company
    Enum: "LEAD", "QUALIFIED", "DISQUALIFIED", "OPPORTUNITY", "CUSTOMER"

  - `networkUnitOwner.source` (string)
    The source of the company
    Enum: "OFFLINE_SOURCE", "ONLINE_ENQUIRY_FORM", "ONLINE_BOOKING", "SALES_CHANNEL", "DIRECT_SALE"

  - `networkUnitOwner.creditCheckOk` (boolean)
    Indicates if the company's credit check is okay

  - `networkUnitOwner.creditCheckDate` (string)
    The date of the company's credit check

  - `shortDescriptionLang2` (string)
    Short description in second language

  - `shortDescriptionLang3` (string)
    Short description in third language

  - `shortDescriptionLang4` (string)
    Short description in fourth language

  - `shortDescriptionLang5` (string)
    Short description in fifth language

  - `longDescription` (string)
    Long description of the unit type

  - `longDescriptionLang2` (string)
    Long description in second language

  - `longDescriptionLang3` (string)
    Long description in third language

  - `longDescriptionLang4` (string)
    Long description in fourth language

  - `longDescriptionLang5` (string)
    Long description in fifth language

  - `floorSpaceMin` (integer)
    Minimum floor space of the unit type

  - `floorSpaceMax` (integer)
    Maximum floor space of the unit type

  - `numberOfBedrooms` (integer)
    Number of bedrooms in the unit type