/v1/leases/{lease_id}/fee-chargesAuthentication
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 POST \
--url 'https://api.staging.facily.ai/v1/leases/<LEASE_ID>/fee-charges' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Idempotency-Key: <IDEMPOTENCY_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"fee_rule_id": "00000000-0000-4000-8000-000000000001",
"amount": 0,
"note": "string"
}'Parameters
lease_idpath · stringrequiredFormat: uuid
Idempotency-Keyheader · stringrequiredMin length: 1 · Max length: 100
Request body
application/json · Required
amountnumber | string | nullRequired for a custom fee; refused otherwise.
Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$)
Show amount schema
number | string | nullRequired for a custom fee; refused otherwise.
Variant 1: number
numberVariant 2: string
stringVariant 3: null
nullfee_rule_idstringrequiredFormat: uuid
notestring | nullWhy, kept in the audit trail.
Max length: 255
Show note schema
string | nullWhy, kept in the audit trail.
Variant 1: string
stringVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"amount": "<VALUE_MATCHING_PATTERN>",
"description": "string",
"effective_date": "2026-10-29",
"fee_rule_id": "00000000-0000-4000-8000-000000000001",
"lease_id": "00000000-0000-4000-8000-000000000001",
"ledger_entry_id": "00000000-0000-4000-8000-000000000001",
"ledger_id": "00000000-0000-4000-8000-000000000001",
"replayed": false,
"subtotal": "<VALUE_MATCHING_PATTERN>",
"tax_amount": "<VALUE_MATCHING_PATTERN>"
},
"meta": {
"request_id": "string"
}
}application/json
dataLeaseFeeChargeResponserequiredShow data schema
amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
descriptionstringrequiredeffective_datestringrequiredFormat: date
fee_rule_idstringrequiredFormat: uuid
lease_idstringrequiredFormat: uuid
ledger_entry_idstringrequiredFormat: uuid
ledger_idstringrequiredFormat: uuid
replayedbooleanrequiredTrue when this Idempotency-Key had already charged; nothing new was written.
subtotalstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tax_amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
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