Get item types by UUIDs for a facility

POST

api

{portfolio}

portfolios

facilities

{facilityUuid}

itemTypes

get_by_uuids

Get item types by UUIDs for a facility

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "itemTypeUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids"

payload = { "itemTypeUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    itemTypeUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'itemTypeUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '3fa85f64-5717-4562-b3fc-2c963f66afa7'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids"

	payload := strings.NewReader("{\n  \"itemTypeUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"itemTypeUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"itemTypeUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "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,
    "isSmartUnitCharge": false,
    "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
    },
    "glAccount": {
      "glAccountUuid": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
      "glCode": "4000",
      "accountName": "Revenue - Rent",
      "accountingBasis": "ACCRUAL"
    },
    "cashGlAccount": {
      "glAccountUuid": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
      "glCode": "4000",
      "accountName": "Revenue - Rent",
      "accountingBasis": "ACCRUAL"
    }
  }
]

Headers

x-api-key

any

required

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

isSmartUnitCharge

boolean

required

True when this item type is the Smart Unit Monitoring charge.

Example:

false

organizationItemTaxRate

object

required

Organization item tax rate information

Show child attributes

glAccount

object | null

required

Accrual GL account this charge type posts to: revenue, or deferred revenue on a charge prorated at move in. Null when the charge type names no accrual account, or the organization holds no account for the one it names.

Show child attributes

cashGlAccount

object | null

required

Cash-basis GL account this charge type posts to — a distinct account from glAccount, with its own UUID and name. Null when the charge type names no cash-basis account, or the organization holds no account for the one it names.

Show child attributes

Get item types by UUIDs for a facility

curl --request POST \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "itemTypeUuids": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "3fa85f64-5717-4562-b3fc-2c963f66afa7"
  ]
}
'

import requests

url = "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids"

payload = { "itemTypeUuids": ["3fa85f64-5717-4562-b3fc-2c963f66afa6", "3fa85f64-5717-4562-b3fc-2c963f66afa7"] }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    itemTypeUuids: ['3fa85f64-5717-4562-b3fc-2c963f66afa6', '3fa85f64-5717-4562-b3fc-2c963f66afa7']
  })
};

fetch('https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'itemTypeUuids' => [
        '3fa85f64-5717-4562-b3fc-2c963f66afa6',
        '3fa85f64-5717-4562-b3fc-2c963f66afa7'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids"

	payload := strings.NewReader("{\n  \"itemTypeUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"itemTypeUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/itemTypes/get_by_uuids")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"itemTypeUuids\": [\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n    \"3fa85f64-5717-4562-b3fc-2c963f66afa7\"\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "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,
    "isSmartUnitCharge": false,
    "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
    },
    "glAccount": {
      "glAccountUuid": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
      "glCode": "4000",
      "accountName": "Revenue - Rent",
      "accountingBasis": "ACCRUAL"
    },
    "cashGlAccount": {
      "glAccountUuid": "9a1b2c3d-4e5f-6a7b-8c9d-0e1f2a3b4c5d",
      "glCode": "4000",
      "accountName": "Revenue - Rent",
      "accountingBasis": "ACCRUAL"
    }
  }
]

Coverage

Portfolios

Facilities

Rental Records

Delinquencies

Item Types

GL Accounts

ECRI

Journal Entries

Ledger Entries

Rent Changes

Payments

Summary

Auctions

Tenants

User Accounts

Units

Unit Groups

Physical Locks

Move Out

Leads

Tasks

People

Lead Source Options

Notes

Promotions

Webhooks

Get item types by UUIDs for a facility

Headers

Path Parameters

Body

Response