Skip to main content
POST
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
itemTypes
/
get_by_uuids
[
  {
    "itemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "itemTypeName": "<string>",
    "description": "<string>",
    "category": "<string>",
    "isRecurring": true,
    "isRequiredAtMoveIn": true,
    "isRequiredAtTransfer": true,
    "isTaxable": true,
    "taxCode": "<string>",
    "isActive": true,
    "isProratedAtMoveIn": true,
    "feeType": "<string>",
    "fixedFeeAmount": 123,
    "feePercentage": 123,
    "organizationItemTaxRate": {
      "organizationItemTaxRateUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cityTax": 123,
      "countyTax": 123,
      "stateTax": 123,
      "specialTax": 123,
      "taxCode": "<string>",
      "effectiveDate": "2023-11-07T05:31:56Z",
      "itemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "mostRecent": true,
      "isActive": true
    }
  }
]

Headers

x-api-key
any

Api key required to authenticate your request. Please reach out to monument for a key.

Example:

"monument-2230012-2312321"

Path Parameters

facilityUuid
string
required

Body

application/json
itemTypeUuids
string<uuid>[]
required

Array of item type UUIDs to retrieve data for

Example:
[
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"3fa85f64-5717-4562-b3fc-2c963f66afa7"
]

Response

200 - application/json

Successfully retrieved item types data

itemTypeUuid
string<uuid>
required

Item type UUID

itemTypeName
string
required

Item type name

description
string | null
required

Item type description

category
string | null
required

Item type category

isRecurring
boolean
required

Whether the item type is recurring

isRequiredAtMoveIn
boolean
required

Whether the item type is required at move in

isRequiredAtTransfer
boolean
required

Whether the item type is required at transfer

isTaxable
boolean
required

Whether the item type is taxable

taxCode
string | null
required

Tax code

isActive
boolean
required

Whether the item type is active

isProratedAtMoveIn
boolean
required

Whether the item type is prorated at move in

feeType
string | null
required

Fee type

fixedFeeAmount
number | null
required

Fixed fee amount in pennies based on the UNIT_RENT item type

feePercentage
number | null
required

Fee percentage based on the UNIT_RENT item type

organizationItemTaxRate
object
required

Organization item tax rate information