/v1/facilities/{facility_id}/ledger-entriesAuthentication
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>/ledger-entries' \
--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
cursorquery · string | nulllimitquery · integerDefault: 50 · Minimum: 1 · Maximum: 200
pagequery · integer | null1-based page number, for a numbered pager. Mutually exclusive with `cursor`.
Minimum: 1
entry_typequery · string[] | nullreference_typequery · string[] | nullRepeatable. Narrows a charge to what it is FOR: 'insurance_plan', 'fee_rule', 'rent', 'payment', 'refund', 'void'.
tenant_idquery · string | nullFormat: uuid
lease_idquery · string | nullFormat: uuid
effective_date_fromquery · string | nullFormat: date
effective_date_toquery · string | nullFormat: date
sourcequery · string | nullmethod_typequery · string[] | nullRepeatable. Filters on the joined Payment; implies entry_type='payment'. One of cash, check, money_order, card, ach.
payment_statusquery · string[] | nullRepeatable. Filters on the joined Payment; implies entry_type='payment'.
min_amountquery · number | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
max_amountquery · number | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": [
{
"amount": "<VALUE_MATCHING_PATTERN>",
"created_at": "2026-10-29T12:00:00Z",
"description": "string",
"discount_amount": "<VALUE_MATCHING_PATTERN>",
"effective_date": "2026-10-29",
"entry_type": "string",
"facility_id": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001",
"ledger_id": "00000000-0000-4000-8000-000000000001",
"ledger_kind": "lease",
"running_balance": "<VALUE_MATCHING_PATTERN>",
"subtotal": "<VALUE_MATCHING_PATTERN>",
"tax_amount": "<VALUE_MATCHING_PATTERN>"
}
],
"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
dataLedgerEntryFeedResponse[]requiredShow data schema
amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
created_atstringrequiredFormat: date-time
descriptionstringrequireddiscount_amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
due_datestring | nullFormat: date
Show due_date schema
string | nullVariant 1: string
stringVariant 2: null
nulleffective_datestringrequiredFormat: date
entry_typestringrequiredfacility_idstringrequiredFormat: uuid
idstringrequiredFormat: uuid
leaseLeaseCompactResponse | nullShow lease schema
LeaseCompactResponse | nullVariant 1: LeaseCompactResponse
idstringrequiredUnique identifier for the lease.
Format: uuid
insurance_planInsurancePlanCompactResponse | nullThe protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.
Show insurance_plan schema
InsurancePlanCompactResponse | nullThe protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.
Variant 1: InsurancePlanCompactResponse
Variant 2: null
lease_numberstringrequiredOperator-facing lease reference, unique within the facility.
next_billing_datestringrequiredBusiness date rent is next charged.
Format: date
ratestringrequiredCurrent monthly rent charged under this lease.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
start_datestringrequiredBusiness date the lease began.
Format: date
statusstringrequiredLifecycle state of the lease.
tenant_idstringrequiredThe tenant renting under this lease.
Format: uuid
tenant_namestringrequiredThe tenant's display name, denormalized so a listing needs no second call.
unit_numberstringrequiredLabel of the unit this lease occupies.
Variant 2: null
nullledger_idstringrequiredFormat: uuid
ledger_kindstringrequiredValues: "lease", "counter", "lead_deposit"
method_typestring | nullShow method_type schema
string | nullVariant 1: string
stringVariant 2: null
nullpayment_amountstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show payment_amount schema
string | nullVariant 1: string
stringVariant 2: null
nullpayment_entry_modestring | nullShow payment_entry_mode schema
string | nullVariant 1: string
stringVariant 2: null
nullpayment_idstring | nullFormat: uuid
Show payment_id schema
string | nullVariant 1: string
stringVariant 2: null
nullpayment_numberstring | nullShow payment_number schema
string | nullVariant 1: string
stringVariant 2: null
nullpayment_refund_amountstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show payment_refund_amount schema
string | nullVariant 1: string
stringVariant 2: null
nullpayment_statusstring | nullShow payment_status schema
string | nullVariant 1: string
stringVariant 2: null
nullreference_idstring | nullFormat: uuid
Show reference_id schema
string | nullVariant 1: string
stringVariant 2: null
nullreference_typestring | nullShow reference_type schema
string | nullVariant 1: string
stringVariant 2: null
nullrunning_balancestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
sourcestring | nullShow source schema
string | nullVariant 1: string
stringVariant 2: null
nullsubtotalstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tax_amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tenantTenantCompactResponse | nullShow tenant schema
TenantCompactResponse | nullVariant 1: TenantCompactResponse
emailstring | nullPrimary email address.
Show email schema
string | nullPrimary email address.
Variant 1: string
Variant 2: null
first_namestringrequiredGiven name.
idstringrequiredUnique identifier for the tenant.
Format: uuid
last_namestringrequiredFamily name.
phonestring | nullPrimary telephone number.
Show phone schema
string | nullPrimary telephone number.
Variant 1: string
Variant 2: null
tenant_numberstringrequiredOperator-facing tenant reference, unique within the facility.
Variant 2: null
nullmetaMetarequiredEnvelope 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