Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Facility Ledger Entries
Search the full API reference Esc to close

List Facility Ledger Entries

Ledgers · REST API reference

Get support
GET/v1/facilities/{facility_id}/ledger-entries
Facility-wide ledger-entry feed behind the Billing tab's three sub-tabs (Transactions, Credits & Refunds, Adjustments -- each is this endpoint with a different `entry_type` filter).

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request 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
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/ledger-entries' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

facility_idpath · string | stringrequired

Format: uuid

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

pagequery · integer | null

1-based page number, for a numbered pager. Mutually exclusive with `cursor`.

Minimum: 1

entry_typequery · string[] | null
reference_typequery · string[] | null

Repeatable. Narrows a charge to what it is FOR: 'insurance_plan', 'fee_rule', 'rent', 'payment', 'refund', 'void'.

tenant_idquery · string | null

Format: uuid

lease_idquery · string | null

Format: uuid

effective_date_fromquery · string | null

Format: date

effective_date_toquery · string | null

Format: date

sourcequery · string | null
method_typequery · string[] | null

Repeatable. Filters on the joined Payment; implies entry_type='payment'. One of cash, check, money_order, card, ach.

payment_statusquery · string[] | null

Repeatable. Filters on the joined Payment; implies entry_type='payment'.

min_amountquery · number | string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

max_amountquery · number | string | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "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[]required
Show data schema
amountstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

created_atstringrequired

Format: date-time

descriptionstringrequired
discount_amountstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

due_datestring | null

Format: date

Show due_date schema
string | null
Variant 1: string
string
Variant 2: null
null
effective_datestringrequired

Format: date

entry_typestringrequired
facility_idstringrequired

Format: uuid

idstringrequired

Format: uuid

leaseLeaseCompactResponse | null
Show lease schema
LeaseCompactResponse | null
Variant 1: LeaseCompactResponse
idstringrequired

Unique identifier for the lease.

Format: uuid

insurance_planInsurancePlanCompactResponse | null

The protection plan this lease is enrolled on, or null when the tenant carries their own policy or none.

Show insurance_plan schema
InsurancePlanCompactResponse | null

The 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_numberstringrequired

Operator-facing lease reference, unique within the facility.

next_billing_datestringrequired

Business date rent is next charged.

Format: date

ratestringrequired

Current monthly rent charged under this lease.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

start_datestringrequired

Business date the lease began.

Format: date

statusstringrequired

Lifecycle state of the lease.

tenant_idstringrequired

The tenant renting under this lease.

Format: uuid

tenant_namestringrequired

The tenant's display name, denormalized so a listing needs no second call.

unit_numberstringrequired

Label of the unit this lease occupies.

Variant 2: null
null
ledger_idstringrequired

Format: uuid

ledger_kindstringrequired

Values: "lease", "counter", "lead_deposit"

method_typestring | null
Show method_type schema
string | null
Variant 1: string
string
Variant 2: null
null
payment_amountstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show payment_amount schema
string | null
Variant 1: string
string
Variant 2: null
null
payment_entry_modestring | null
Show payment_entry_mode schema
string | null
Variant 1: string
string
Variant 2: null
null
payment_idstring | null

Format: uuid

Show payment_id schema
string | null
Variant 1: string
string
Variant 2: null
null
payment_numberstring | null
Show payment_number schema
string | null
Variant 1: string
string
Variant 2: null
null
payment_refund_amountstring | null

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

Show payment_refund_amount schema
string | null
Variant 1: string
string
Variant 2: null
null
payment_statusstring | null
Show payment_status schema
string | null
Variant 1: string
string
Variant 2: null
null
reference_idstring | null

Format: uuid

Show reference_id schema
string | null
Variant 1: string
string
Variant 2: null
null
reference_typestring | null
Show reference_type schema
string | null
Variant 1: string
string
Variant 2: null
null
running_balancestringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

sourcestring | null
Show source schema
string | null
Variant 1: string
string
Variant 2: null
null
subtotalstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

tax_amountstringrequired

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$

tenantTenantCompactResponse | null
Show tenant schema
TenantCompactResponse | null
Variant 1: TenantCompactResponse
emailstring | null

Primary email address.

Show email schema
string | null

Primary email address.

Variant 1: string
Variant 2: null
first_namestringrequired

Given name.

idstringrequired

Unique identifier for the tenant.

Format: uuid

last_namestringrequired

Family name.

phonestring | null

Primary telephone number.

Show phone schema
string | null

Primary telephone number.

Variant 1: string
Variant 2: null
tenant_numberstringrequired

Operator-facing tenant reference, unique within the facility.

Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll ledgers operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

List Facility Ledger Entries | Facily Developers