/v1/facilities/{facility_id}/fee-rulesAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest example
Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.
curl --request GET \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/fee-rules' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · string | stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"amount": "<VALUE_MATCHING_PATTERN>",
"applicable_unit_group_ids": [
"00000000-0000-4000-8000-000000000001"
],
"code": "string",
"created_at": "2026-10-29T12:00:00Z",
"facility_ids": [
"00000000-0000-4000-8000-000000000001"
],
"fee_base": "string",
"fee_type": "string",
"frequency": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_active": false,
"is_taxable": false,
"kind": "string",
"name": "string",
"percentage": "<VALUE_MATCHING_PATTERN>",
"required": false
}
],
"meta": {
"request_id": "string"
},
"pagination": {
"has_more": false,
"limit": 0,
"cursor": "string",
"total_count": 0
},
"metrics": {
"cards": {},
"computed_at": "2026-10-29T12:00:00Z",
"is_stale": false,
"scope": "facility"
}
}application/json
dataFeeRuleResponse[]requiredShow data schema
amountstring | nullrequiredThe fixed amount of a flat fee.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show amount schema
string | nullThe fixed amount of a flat fee.
Variant 1: string
stringVariant 2: null
nullapplicable_unit_group_idsstring[] | nullrequiredUnit groups the fee applies to; null for all.
Show applicable_unit_group_ids schema
string[] | nullUnit groups the fee applies to; null for all.
Variant 1: string[]
string[]Variant 2: null
nullcodestringrequiredProduct code, upper-case.
created_atstringrequiredWhen the fee was created.
Format: date-time
facility_idsstring[]requiredFacilities the fee applies at. Empty means every facility.
Show facility_ids schema
stringfee_basestring | nullrequiredWhat a percentage fee is a percentage of.
Show fee_base schema
string | nullWhat a percentage fee is a percentage of.
Variant 1: string
stringVariant 2: null
nullfee_typestringrequiredflat, percentage, or custom.
frequencystringrequiredone_time, monthly or annual.
idstringrequiredUnique identifier for this fee.
Format: uuid
is_activebooleanrequiredWhether the fee can be added or charged now.
is_taxablebooleanrequiredWhether sales tax is charged on this fee.
kindstringrequiredfee or service.
live_attachment_countintegerLeases currently carrying this fee.
Default: 0
namestringrequiredDescription shown to staff and on the ledger line.
percentagestring | nullrequiredThe percentage of a percentage fee.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show percentage schema
string | nullThe percentage of a percentage fee.
Variant 1: string
stringVariant 2: null
nullrequiredbooleanrequiredAdded to every new lease at move-in.
metaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequiredmetricsEmbeddedMetrics | nullShow metrics schema
EmbeddedMetrics | nullVariant 1: EmbeddedMetrics
cardsobjectrequiredcomputed_atstring | nullrequiredFormat: date-time
Show computed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullis_stalebooleanrequiredscopestringrequiredValues: "facility", "portfolio"
Variant 2: null
nullpaginationPaginationBlockrequiredPagination metadata for list responses.
Show pagination schema
cursorstring | nullShow cursor schema
string | nullVariant 1: string
stringVariant 2: null
nullhas_morebooleanrequiredlimitintegerrequiredtotal_countinteger | nullShow total_count schema
integer | nullVariant 1: integer
integerVariant 2: null
null400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired