/v1/ledgers/{ledger_id}/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/ledgers/<LEDGER_ID>/entries' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
ledger_idpath · stringrequiredFormat: uuid
cursorquery · string | nulllimitquery · integerDefault: 50 · Minimum: 1 · Maximum: 200
sortquery · string | nullValues: "created_at", "effective_date", "amount"
orderquery · stringDefault: "desc" · Values: "asc", "desc"
entry_typequery · string | nullResponses
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",
"id": "00000000-0000-4000-8000-000000000001",
"running_balance": "<VALUE_MATCHING_PATTERN>",
"subtotal": "<VALUE_MATCHING_PATTERN>",
"tax_amount": "<VALUE_MATCHING_PATTERN>",
"created_by": {
"display_name": "string",
"email": "string",
"id": "00000000-0000-4000-8000-000000000001"
},
"due_date": "2026-10-29"
}
],
"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
dataLedgerEntryResponse[]requiredShow data schema
amountstringrequiredNet amount of this entry, after discount and including tax. This is the figure that moves the balance.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
created_atstringrequiredWhen the entry was written.
Format: date-time
created_byUserCompactResponse | nullThe user who caused the entry, where a person did.
Show created_by schema
UserCompactResponse | nullThe user who caused the entry, where a person did.
Variant 1: UserCompactResponse
display_namestringrequiredemailstringrequiredidstringrequiredFormat: uuid
Variant 2: null
nulldescriptionstringrequiredHuman-readable line description, as it appears on an invoice or statement.
discount_amountstringrequiredDiscount applied to this line, as a positive number.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
due_datestring | nullBusiness date payment is due, for entries that are charges.
Format: date
Show due_date schema
string | nullBusiness date payment is due, for entries that are charges.
Variant 1: string
stringVariant 2: null
nulleffective_datestringrequiredBusiness date the entry takes effect, in the facility's timezone. This drives period allocation, not created_at.
Format: date
entry_typestringrequiredWhat this entry represents, for example rent, fee, tax, payment, or credit.
idstringrequiredUnique identifier for this ledger entry.
Format: uuid
invoice_numberstring | nullThe invoice this entry was billed on, where one has been issued.
Show invoice_number schema
string | nullThe invoice this entry was billed on, where one has been issued.
Variant 1: string
stringVariant 2: null
nullperiod_endstring | nullLast day of the service period this entry covers.
Format: date
Show period_end schema
string | nullLast day of the service period this entry covers.
Variant 1: string
stringVariant 2: null
nullperiod_startstring | nullFirst day of the service period this entry covers.
Format: date
Show period_start schema
string | nullFirst day of the service period this entry covers.
Variant 1: string
stringVariant 2: null
nullreference_idstring | nullIdentifier of the record named by reference_type.
Format: uuid
Show reference_id schema
string | nullIdentifier of the record named by reference_type.
Variant 1: string
stringVariant 2: null
nullreference_typestring | nullThe kind of record that produced this entry, for example a payment or a fee rule.
Show reference_type schema
string | nullThe kind of record that produced this entry, for example a payment or a fee rule.
Variant 1: string
stringVariant 2: null
nullrunning_balancestringrequiredAccount balance immediately after this entry was posted. Because entries are never modified, this lets a balance be reconstructed as at any point in time.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
sourcestring | nullWhat originated the entry, for example an automated billing run or a staff action.
Show source schema
string | nullWhat originated the entry, for example an automated billing run or a staff action.
Variant 1: string
stringVariant 2: null
nullsubtotalstringrequiredLine amount before tax and discount.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tax_amountstringrequiredTax charged on this line.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
voided_entry_idstring | nullWhen this entry reverses another, the entry it reverses. Ledger entries are never edited or deleted: a correction is a void plus a replacement, so the history stays intact.
Format: uuid
Show voided_entry_id schema
string | nullWhen this entry reverses another, the entry it reverses. Ledger entries are never edited or deleted: a correction is a void plus a replacement, so the history stays intact.
Variant 1: string
stringVariant 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