/v1/fee-rules/{fee_rule_id}Authentication
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 PATCH \
--url 'https://api.staging.facily.ai/v1/fee-rules/<FEE_RULE_ID>' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"amount": 0,
"applicable_unit_group_ids": [
"00000000-0000-4000-8000-000000000001"
],
"code": "string",
"facility_ids": [
"00000000-0000-4000-8000-000000000001"
],
"fee_base": "rent",
"is_active": false,
"is_taxable": false,
"kind": "fee",
"name": "string",
"percentage": 0,
"required": false
}'Parameters
fee_rule_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
amountnumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)
Show amount schema
number | string | nullVariant 1: number
numberVariant 2: string
stringVariant 3: null
nullapplicable_unit_group_idsstring[] | nullnull restores all units.
Show applicable_unit_group_ids schema
string[] | nullnull restores all units.
Variant 1: string[]
string[]Variant 2: null
nullcodestring | nullMin length: 1 · Max length: 50
Show code schema
string | nullVariant 1: string
stringVariant 2: null
nullfacility_idsstring[] | nullThe new facility set; [] for every facility. Needs the write permission on every one.
Show facility_ids schema
string[] | nullThe new facility set; [] for every facility. Needs the write permission on every one.
Variant 1: string[]
string[]Variant 2: null
nullfee_basestring | nullValues: "rent", "rent_plus_insurance", "rent_plus_all"
Show fee_base schema
string | nullVariant 1: string
stringValues: "rent", "rent_plus_insurance", "rent_plus_all"
Variant 2: null
nullis_activeboolean | nullShow is_active schema
boolean | nullVariant 1: boolean
booleanVariant 2: null
nullis_taxableboolean | nullShow is_taxable schema
boolean | nullVariant 1: boolean
booleanVariant 2: null
nullkindstring | nullValues: "fee", "service"
Show kind schema
string | nullVariant 1: string
stringValues: "fee", "service"
Variant 2: null
nullnamestring | nullMin length: 1 · Max length: 100
Show name schema
string | nullVariant 1: string
stringVariant 2: null
nullpercentagenumber | string | nullMaximum: 100 · Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,3}|(?=[\d.]{1,6}0*$)\d{0,3}\.\d{0,2}0*$)
Show percentage schema
number | string | nullVariant 1: number
numberVariant 2: string
stringVariant 3: null
nullrequiredboolean | nullShow required schema
boolean | nullVariant 1: boolean
booleanVariant 2: null
nullResponses
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"
}
}application/json
dataFeeRuleResponserequiredShow 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_idstringrequired400Validation 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