Skip to main content
GET
/
api
/
{portfolio}
/
portfolios
/
v1
/
facilities
/
{facilityUuid}
/
rentalRecords
/
{unitRentalRecordUuid}
/
availableFees
Get available fees for a unit rental record
curl --request GET \
  --url https://public-api.prd.monument.io/api/{portfolio}/portfolios/v1/facilities/{facilityUuid}/rentalRecords/{unitRentalRecordUuid}/availableFees \
  --header 'x-api-key: <x-api-key>'
[
  {
    "name": "<string>",
    "amountInPennies": 123,
    "taxAmountInPennies": 123,
    "category": "SERVICES",
    "itemTypeUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isRecurring": true
  }
]

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
​
unitRentalRecordUuid
string
required

Response

200 - application/json

Successfully retrieved available fees

​
name
string
required

Item type name

​
amountInPennies
number
required

Pre-calculated amount in pennies based on feeType. PERCENTAGE: rent * (feePercentage / 100), otherwise fixedFeeAmount.

​
taxAmountInPennies
number
required

Total tax amount in pennies

​
category
enum<string>
required
Available options:
SERVICES,
FEES
​
itemTypeUuid
string<uuid>
required
​
isRecurring
boolean
required

Only recurring fees can be added to monthly invoices