/v1/leases/{lease_id}/delinquencyAuthentication
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/leases/<LEASE_ID>/delinquency' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
lease_idpath · stringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"events": [
{
"actions_taken": [
{}
],
"balance_at_event": "<VALUE_MATCHING_PATTERN>",
"created_at": "2026-10-29T12:00:00Z",
"created_by": "00000000-0000-4000-8000-000000000001",
"event_type": "string",
"id": "00000000-0000-4000-8000-000000000001",
"is_manual_override": false,
"lease_id": "00000000-0000-4000-8000-000000000001",
"new_state": "string",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"trigger_days": 0,
"case_id": "00000000-0000-4000-8000-000000000001"
}
],
"lease": {
"id": "00000000-0000-4000-8000-000000000001",
"lease_number": "string",
"next_billing_date": "2026-10-29",
"rate": "<VALUE_MATCHING_PATTERN>",
"start_date": "2026-10-29",
"status": "string",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"tenant_name": "string",
"unit_number": "string",
"insurance_plan": {
"coverage_amount": "<VALUE_MATCHING_PATTERN>",
"id": "00000000-0000-4000-8000-000000000001",
"monthly_premium": "<VALUE_MATCHING_PATTERN>",
"name": "string"
}
},
"milestones": [
{
"fired_on": "2026-10-29",
"id": "00000000-0000-4000-8000-000000000001",
"kind": "string",
"recipient_kind": "string",
"deemed_delivered_on": "2026-10-29",
"delivery_method": "string",
"document_id": "00000000-0000-4000-8000-000000000001",
"mailed_on": "2026-10-29",
"publication_count": 0,
"publication_outlet": "string",
"published_on": "2026-10-29",
"recipient_id": "00000000-0000-4000-8000-000000000001"
}
],
"tenant": {
"first_name": "string",
"id": "00000000-0000-4000-8000-000000000001",
"last_name": "string",
"tenant_number": "string",
"email": "string",
"phone": "string"
},
"case": {
"balance": "<VALUE_MATCHING_PATTERN>",
"case_id": "00000000-0000-4000-8000-000000000001",
"current_stage": "string",
"days_past_due": 0,
"facility_id": "00000000-0000-4000-8000-000000000001",
"fees_applied": "<VALUE_MATCHING_PATTERN>",
"has_arrangement": false,
"lease": {
"id": "00000000-0000-4000-8000-000000000001",
"lease_number": "string",
"next_billing_date": "2026-10-29",
"rate": "<VALUE_MATCHING_PATTERN>",
"start_date": "2026-10-29",
"status": "string",
"tenant_id": "00000000-0000-4000-8000-000000000001",
"tenant_name": "string",
"unit_number": "string",
"insurance_plan": {
"coverage_amount": "<VALUE_MATCHING_PATTERN>",
"id": "00000000-0000-4000-8000-000000000001",
"monthly_premium": "<VALUE_MATCHING_PATTERN>",
"name": "string"
}
},
"lockout": {
"gate_suspended": false,
"unit_overlocked": false,
"denied_provider": "string",
"denied_since": "2026-10-29T12:00:00Z",
"manual_hold": false
},
"monthly_rent": "<VALUE_MATCHING_PATTERN>",
"opened_on": "2026-10-29",
"recent_events": [
{
"balance_at_event": "<VALUE_MATCHING_PATTERN>",
"created_at": "2026-10-29T12:00:00Z",
"event_type": "string",
"id": "00000000-0000-4000-8000-000000000001",
"new_state": "string",
"trigger_days": 0,
"is_manual_override": false,
"notes": "string"
}
],
"state": "string",
"tenant": {
"first_name": "string",
"id": "00000000-0000-4000-8000-000000000001",
"last_name": "string",
"tenant_number": "string",
"email": "string",
"phone": "string"
},
"unit": {
"id": "00000000-0000-4000-8000-000000000001",
"unit_number": "string",
"unit_type_name": "string"
},
"write_off_amount": "<VALUE_MATCHING_PATTERN>"
},
"next_stage": "string",
"next_stage_on": "2026-10-29"
},
"meta": {
"request_id": "string"
}
}application/json
dataLeaseDelinquencyResponserequiredOne lease's delinquency picture: the open case (or the last closed one), its whole event log, its statutory milestones, and what is next.
Show data schema
caseDelinquencyCaseResponse | nullThe open case, else the most recently closed one, else null.
Show case schema
DelinquencyCaseResponse | nullThe open case, else the most recently closed one, else null.
Variant 1: DelinquencyCaseResponse
assigned_toUserCompactResponse | nullThe arrangement task's assignee.
Show assigned_to schema
UserCompactResponse | nullThe arrangement task's assignee.
Variant 1: UserCompactResponse
Variant 2: null
auction_datestring | nullScheduled sale date, once one has been recorded.
Format: date
Show auction_date schema
string | nullScheduled sale date, once one has been recorded.
Variant 1: string
Variant 2: null
auction_locationstring | nullWhere the sale takes place.
Show auction_location schema
string | nullWhere the sale takes place.
Variant 1: string
Variant 2: null
auction_timestring | nullScheduled sale time, as the operator entered it.
Show auction_time schema
string | nullScheduled sale time, as the operator entered it.
Variant 1: string
Variant 2: null
balancestringrequiredOutstanding balance at the last sweep.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
case_idstringrequiredUnique identifier for this delinquency case.
Format: uuid
closed_atstring | nullWhen the case closed; null while it is open.
Format: date-time
Show closed_at schema
string | nullWhen the case closed; null while it is open.
Variant 1: string
Variant 2: null
closed_reasonstring | nullcured, written_off or lease_closed.
Show closed_reason schema
string | nullcured, written_off or lease_closed.
Variant 1: string
Variant 2: null
current_stagestringrequiredThe same value as `state`, under the name earlier clients read.
days_past_dueintegerrequiredDays past the oldest unpaid rent-class due date, facility-local.
facility_idstringrequiredThe facility the case belongs to -- every row carries it under `all`.
Format: uuid
fees_appliedstringrequiredEngine fees posted on this cycle, net of waivers. Delinquency-cycle fees only: the dispute fee is a payment-path charge posted by the dispute ingest, so it is not counted here even though it is classed as an engine fee on the ledger.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
has_arrangementbooleanrequiredTrue while an open collection task filed by the engine exists.
last_payment_amountstring | nullAmount of that payment.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show last_payment_amount schema
string | nullAmount of that payment.
Variant 1: string
Variant 2: null
last_payment_datestring | nullBusiness date of the tenant's most recent payment.
Format: date
Show last_payment_date schema
string | nullBusiness date of the tenant's most recent payment.
Variant 1: string
Variant 2: null
leaseLeaseCompactResponserequiredShow lease schema
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.
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.
lockoutDelinquencyLockoutBlockrequiredThe case's actual lock facts, which the Apply/Release buttons key on -- not the state label, which can say `locked_out` after a release.
Show lockout schema
denied_providerstring | nullThe lock provider that confirmed it, for example kiss.
denied_sincestring | nullWhen the lock provider confirmed it holds the unit denied; null when no provider has, or when the case's lease no longer occupies the unit.
Format: date-time
gate_suspendedbooleanrequiredTrue while a delinquency suspension is live on the lease's access grant.
manual_holdbooleanTrue while a staff hold for a reason other than non-payment is on the lease's access. Releasing the delinquency lockout does not lift it.
Default: false
unit_overlockedbooleanrequiredTrue while the unit is overlocked and this case's lease is the one occupying it.
monthly_rentstringrequiredThe lease's current monthly rent.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
next_actionstring | nullDisplay label of the next stage due to fire.
Show next_action schema
string | nullDisplay label of the next stage due to fire.
Variant 1: string
Variant 2: null
next_action_datestring | nullBusiness date that stage is due.
Format: date
Show next_action_date schema
string | nullBusiness date that stage is due.
Variant 1: string
Variant 2: null
next_stage_keystring | null`{kind}:{index}` of the next stage in the case's snapshot.
Show next_stage_key schema
string | null`{kind}:{index}` of the next stage in the case's snapshot.
Variant 1: string
Variant 2: null
next_statestring | nullThe state that stage would move the case into.
Show next_state schema
string | nullThe state that stage would move the case into.
Variant 1: string
Variant 2: null
next_state_onstring | nullBusiness date the next state is due.
Format: date
Show next_state_on schema
string | nullBusiness date the next state is due.
Variant 1: string
Variant 2: null
opened_onstringrequiredBusiness date the case was opened.
Format: date
overrideDelinquencyOverrideBlock | nullThe last manual override, or null when the case has only ever moved by the ladder.
Show override schema
DelinquencyOverrideBlock | nullThe last manual override, or null when the case has only ever moved by the ladder.
Variant 1: DelinquencyOverrideBlock
Variant 2: null
pause_reasonstring | nullWhy the case is paused: arrangement, exempt, manual, opposition or scra.
Show pause_reason schema
string | nullWhy the case is paused: arrangement, exempt, manual, opposition or scra.
Variant 1: string
Variant 2: null
paused_untilstring | nullBusiness date the pause lifts; null when not paused.
Format: date
Show paused_until schema
string | nullBusiness date the pause lifts; null when not paused.
Variant 1: string
Variant 2: null
recent_eventsDelinquencyEventCompactResponse[]requiredThe five newest events on this case, newest first.
Show recent_events schema
balance_at_eventstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
created_atstringrequiredFormat: date-time
event_typestringrequiredidstringrequiredFormat: uuid
is_manual_overridebooleanDefault: false
new_statestringrequirednotesstring | nulltrigger_daysintegerrequiredstatestringrequiredThe case's current delinquency state.
tenantTenantCompactResponserequiredInline tenant reference. Extended variant adds email/phone.
Show tenant schema
emailstring | nullPrimary email address.
first_namestringrequiredGiven name.
idstringrequiredUnique identifier for the tenant.
Format: uuid
last_namestringrequiredFamily name.
phonestring | nullPrimary telephone number.
tenant_numberstringrequiredOperator-facing tenant reference, unique within the facility.
unitUnitCompactResponserequiredShow unit schema
idstringrequiredFormat: uuid
unit_numberstringrequiredunit_type_namestringrequiredwrite_off_amountstringrequiredAmount written off on this cycle.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Variant 2: null
nulleventsDelinquencyEventResponse[]requiredEvery event on that case, newest first.
Show events schema
actions_takenobject[]requiredOne record per action the stage carried out, with what it produced.
Show actions_taken schema
objectbalance_at_eventstringrequiredThe ledger balance at the moment the event fired.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
case_idstring | nullThe case it belongs to; null on imported pre-Step-10 rows.
Format: uuid
Show case_id schema
string | nullThe case it belongs to; null on imported pre-Step-10 rows.
Variant 1: string
stringVariant 2: null
nullcreated_atstringrequiredWhen the row was written.
Format: date-time
created_bystringrequiredThe actor the row is attributed to.
Format: uuid
event_typestringrequiredWhat happened, for example stage_fired, paused or manual_override.
idstringrequiredUnique identifier for this event.
Format: uuid
is_manual_overridebooleanrequiredTrue when an operator, not the sweep, caused the event.
lease_idstringrequiredThe lease the event is against.
Format: uuid
new_statestringrequiredThe state the case was in after the event.
notesstring | nullFree text: the operator's reason on a manual event.
Show notes schema
string | nullFree text: the operator's reason on a manual event.
Variant 1: string
stringVariant 2: null
nullprevious_statestring | nullThe state the case was in before the event.
Show previous_state schema
string | nullThe state the case was in before the event.
Variant 1: string
stringVariant 2: null
nullstage_keystring | null`{kind}:{index}` of the stage this event concerns.
Show stage_key schema
string | null`{kind}:{index}` of the stage this event concerns.
Variant 1: string
stringVariant 2: null
nulltenant_idstringrequiredThe tenant the event is against.
Format: uuid
trigger_daysintegerrequiredDays past due when the event fired.
leaseLeaseCompactResponserequiredShow lease schema
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
coverage_amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
idstringrequiredFormat: uuid
monthly_premiumstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
namestringrequiredVariant 2: null
nulllease_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.
milestonesLienMilestoneResponse[]requiredEvery statutory milestone on that case.
Show milestones schema
deemed_delivered_onstring | nullBusiness date the statute deems delivery.
Format: date
Show deemed_delivered_on schema
string | nullBusiness date the statute deems delivery.
Variant 1: string
stringVariant 2: null
nulldelivery_methodstring | nullHow it was sent.
Show delivery_method schema
string | nullHow it was sent.
Variant 1: string
stringVariant 2: null
nulldocument_idstring | nullThe rendered notice document, once one exists.
Format: uuid
Show document_id schema
string | nullThe rendered notice document, once one exists.
Variant 1: string
stringVariant 2: null
nullfired_onstringrequiredBusiness date the milestone's stage fired.
Format: date
idstringrequiredUnique identifier for this milestone.
Format: uuid
kindstringrequiredpre_lien, lien or auction_scheduled.
mailed_onstring | nullBusiness date the notice was mailed.
Format: date
Show mailed_on schema
string | nullBusiness date the notice was mailed.
Variant 1: string
stringVariant 2: null
nullpublication_countinteger | nullHow many times it ran.
Show publication_count schema
integer | nullHow many times it ran.
Variant 1: integer
integerVariant 2: null
nullpublication_outletstring | nullWhere the notice was published.
Show publication_outlet schema
string | nullWhere the notice was published.
Variant 1: string
stringVariant 2: null
nullpublished_onstring | nullBusiness date of first publication.
Format: date
Show published_on schema
string | nullBusiness date of first publication.
Variant 1: string
stringVariant 2: null
nullrecipient_idstring | nullThe recipient row; null for a lienholder.
Format: uuid
Show recipient_id schema
string | nullThe recipient row; null for a lienholder.
Variant 1: string
stringVariant 2: null
nullrecipient_kindstringrequiredoccupant, alternate_contact or lienholder.
recipient_namestring | nullThe recipient's name, for a lienholder who has no row.
Show recipient_name schema
string | nullThe recipient's name, for a lienholder who has no row.
Variant 1: string
stringVariant 2: null
nulltracking_numberstring | nullCarrier tracking reference, where one applies.
Show tracking_number schema
string | nullCarrier tracking reference, where one applies.
Variant 1: string
stringVariant 2: null
nullnext_stagestring | nullDisplay label of the next stage due to fire.
Show next_stage schema
string | nullDisplay label of the next stage due to fire.
Variant 1: string
stringVariant 2: null
nullnext_stage_onstring | nullBusiness date it is due.
Format: date
Show next_stage_on schema
string | nullBusiness date it is due.
Variant 1: string
stringVariant 2: null
nulltenantTenantCompactResponserequiredInline tenant reference. Extended variant adds email/phone.
Show tenant schema
emailstring | nullPrimary email address.
Show email schema
string | nullPrimary email address.
Variant 1: string
stringVariant 2: null
nullfirst_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
stringVariant 2: null
nulltenant_numberstringrequiredOperator-facing tenant reference, unique within the facility.
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