Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Lease Delinquency
Search the full API reference Esc to close

Get Lease Delinquency

Leases · REST API reference

Get support
GET/v1/leases/{lease_id}/delinquency
One lease's open case -- else its most recently closed one -- with its whole event log, its statutory milestones and what fires next.

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/leases/<LEASE_ID>/delinquency' \
  --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

lease_idpath · stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "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

dataLeaseDelinquencyResponserequired

One 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 | null

The open case, else the most recently closed one, else null.

Show case schema
DelinquencyCaseResponse | null

The open case, else the most recently closed one, else null.

Variant 1: DelinquencyCaseResponse
assigned_toUserCompactResponse | null

The arrangement task's assignee.

Show assigned_to schema
UserCompactResponse | null

The arrangement task's assignee.

Variant 1: UserCompactResponse
Variant 2: null
auction_datestring | null

Scheduled sale date, once one has been recorded.

Format: date

Show auction_date schema
string | null

Scheduled sale date, once one has been recorded.

Variant 1: string
Variant 2: null
auction_locationstring | null

Where the sale takes place.

Show auction_location schema
string | null

Where the sale takes place.

Variant 1: string
Variant 2: null
auction_timestring | null

Scheduled sale time, as the operator entered it.

Show auction_time schema
string | null

Scheduled sale time, as the operator entered it.

Variant 1: string
Variant 2: null
balancestringrequired

Outstanding balance at the last sweep.

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

case_idstringrequired

Unique identifier for this delinquency case.

Format: uuid

closed_atstring | null

When the case closed; null while it is open.

Format: date-time

Show closed_at schema
string | null

When the case closed; null while it is open.

Variant 1: string
Variant 2: null
closed_reasonstring | null

cured, written_off or lease_closed.

Show closed_reason schema
string | null

cured, written_off or lease_closed.

Variant 1: string
Variant 2: null
current_stagestringrequired

The same value as `state`, under the name earlier clients read.

days_past_dueintegerrequired

Days past the oldest unpaid rent-class due date, facility-local.

facility_idstringrequired

The facility the case belongs to -- every row carries it under `all`.

Format: uuid

fees_appliedstringrequired

Engine 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_arrangementbooleanrequired

True while an open collection task filed by the engine exists.

last_payment_amountstring | null

Amount of that payment.

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

Show last_payment_amount schema
string | null

Amount of that payment.

Variant 1: string
Variant 2: null
last_payment_datestring | null

Business date of the tenant's most recent payment.

Format: date

Show last_payment_date schema
string | null

Business date of the tenant's most recent payment.

Variant 1: string
Variant 2: null
leaseLeaseCompactResponserequired
Show lease schema
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.

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.

lockoutDelinquencyLockoutBlockrequired

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

The lock provider that confirmed it, for example kiss.

denied_sincestring | null

When 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_suspendedbooleanrequired

True while a delinquency suspension is live on the lease's access grant.

manual_holdboolean

True 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_overlockedbooleanrequired

True while the unit is overlocked and this case's lease is the one occupying it.

monthly_rentstringrequired

The lease's current monthly rent.

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

next_actionstring | null

Display label of the next stage due to fire.

Show next_action schema
string | null

Display label of the next stage due to fire.

Variant 1: string
Variant 2: null
next_action_datestring | null

Business date that stage is due.

Format: date

Show next_action_date schema
string | null

Business 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 | null

The state that stage would move the case into.

Show next_state schema
string | null

The state that stage would move the case into.

Variant 1: string
Variant 2: null
next_state_onstring | null

Business date the next state is due.

Format: date

Show next_state_on schema
string | null

Business date the next state is due.

Variant 1: string
Variant 2: null
opened_onstringrequired

Business date the case was opened.

Format: date

overrideDelinquencyOverrideBlock | null

The last manual override, or null when the case has only ever moved by the ladder.

Show override schema
DelinquencyOverrideBlock | null

The last manual override, or null when the case has only ever moved by the ladder.

Variant 1: DelinquencyOverrideBlock
Variant 2: null
pause_reasonstring | null

Why the case is paused: arrangement, exempt, manual, opposition or scra.

Show pause_reason schema
string | null

Why the case is paused: arrangement, exempt, manual, opposition or scra.

Variant 1: string
Variant 2: null
paused_untilstring | null

Business date the pause lifts; null when not paused.

Format: date

Show paused_until schema
string | null

Business date the pause lifts; null when not paused.

Variant 1: string
Variant 2: null
recent_eventsDelinquencyEventCompactResponse[]required

The five newest events on this case, newest first.

Show recent_events schema
balance_at_eventstringrequired

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

created_atstringrequired

Format: date-time

event_typestringrequired
idstringrequired

Format: uuid

is_manual_overrideboolean

Default: false

new_statestringrequired
notesstring | null
trigger_daysintegerrequired
statestringrequired

The case's current delinquency state.

tenantTenantCompactResponserequired

Inline tenant reference. Extended variant adds email/phone.

Show tenant schema
emailstring | null

Primary email address.

first_namestringrequired

Given name.

idstringrequired

Unique identifier for the tenant.

Format: uuid

last_namestringrequired

Family name.

phonestring | null

Primary telephone number.

tenant_numberstringrequired

Operator-facing tenant reference, unique within the facility.

unitUnitCompactResponserequired
Show unit schema
idstringrequired

Format: uuid

unit_numberstringrequired
unit_type_namestringrequired
write_off_amountstringrequired

Amount written off on this cycle.

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

Variant 2: null
null
eventsDelinquencyEventResponse[]required

Every event on that case, newest first.

Show events schema
actions_takenobject[]required

One record per action the stage carried out, with what it produced.

Show actions_taken schema
object
balance_at_eventstringrequired

The ledger balance at the moment the event fired.

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

case_idstring | null

The case it belongs to; null on imported pre-Step-10 rows.

Format: uuid

Show case_id schema
string | null

The case it belongs to; null on imported pre-Step-10 rows.

Variant 1: string
string
Variant 2: null
null
created_atstringrequired

When the row was written.

Format: date-time

created_bystringrequired

The actor the row is attributed to.

Format: uuid

event_typestringrequired

What happened, for example stage_fired, paused or manual_override.

idstringrequired

Unique identifier for this event.

Format: uuid

is_manual_overridebooleanrequired

True when an operator, not the sweep, caused the event.

lease_idstringrequired

The lease the event is against.

Format: uuid

new_statestringrequired

The state the case was in after the event.

notesstring | null

Free text: the operator's reason on a manual event.

Show notes schema
string | null

Free text: the operator's reason on a manual event.

Variant 1: string
string
Variant 2: null
null
previous_statestring | null

The state the case was in before the event.

Show previous_state schema
string | null

The state the case was in before the event.

Variant 1: string
string
Variant 2: null
null
stage_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
string
Variant 2: null
null
tenant_idstringrequired

The tenant the event is against.

Format: uuid

trigger_daysintegerrequired

Days past due when the event fired.

leaseLeaseCompactResponserequired
Show lease schema
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
coverage_amountstringrequired

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

idstringrequired

Format: uuid

monthly_premiumstringrequired

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

namestringrequired
Variant 2: null
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.

milestonesLienMilestoneResponse[]required

Every statutory milestone on that case.

Show milestones schema
deemed_delivered_onstring | null

Business date the statute deems delivery.

Format: date

Show deemed_delivered_on schema
string | null

Business date the statute deems delivery.

Variant 1: string
string
Variant 2: null
null
delivery_methodstring | null

How it was sent.

Show delivery_method schema
string | null

How it was sent.

Variant 1: string
string
Variant 2: null
null
document_idstring | null

The rendered notice document, once one exists.

Format: uuid

Show document_id schema
string | null

The rendered notice document, once one exists.

Variant 1: string
string
Variant 2: null
null
fired_onstringrequired

Business date the milestone's stage fired.

Format: date

idstringrequired

Unique identifier for this milestone.

Format: uuid

kindstringrequired

pre_lien, lien or auction_scheduled.

mailed_onstring | null

Business date the notice was mailed.

Format: date

Show mailed_on schema
string | null

Business date the notice was mailed.

Variant 1: string
string
Variant 2: null
null
publication_countinteger | null

How many times it ran.

Show publication_count schema
integer | null

How many times it ran.

Variant 1: integer
integer
Variant 2: null
null
publication_outletstring | null

Where the notice was published.

Show publication_outlet schema
string | null

Where the notice was published.

Variant 1: string
string
Variant 2: null
null
published_onstring | null

Business date of first publication.

Format: date

Show published_on schema
string | null

Business date of first publication.

Variant 1: string
string
Variant 2: null
null
recipient_idstring | null

The recipient row; null for a lienholder.

Format: uuid

Show recipient_id schema
string | null

The recipient row; null for a lienholder.

Variant 1: string
string
Variant 2: null
null
recipient_kindstringrequired

occupant, alternate_contact or lienholder.

recipient_namestring | null

The recipient's name, for a lienholder who has no row.

Show recipient_name schema
string | null

The recipient's name, for a lienholder who has no row.

Variant 1: string
string
Variant 2: null
null
tracking_numberstring | null

Carrier tracking reference, where one applies.

Show tracking_number schema
string | null

Carrier tracking reference, where one applies.

Variant 1: string
string
Variant 2: null
null
next_stagestring | null

Display label of the next stage due to fire.

Show next_stage schema
string | null

Display label of the next stage due to fire.

Variant 1: string
string
Variant 2: null
null
next_stage_onstring | null

Business date it is due.

Format: date

Show next_stage_on schema
string | null

Business date it is due.

Variant 1: string
string
Variant 2: null
null
tenantTenantCompactResponserequired

Inline tenant reference. Extended variant adds email/phone.

Show tenant schema
emailstring | null

Primary email address.

Show email schema
string | null

Primary email address.

Variant 1: string
string
Variant 2: null
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
string
Variant 2: null
null
tenant_numberstringrequired

Operator-facing tenant reference, unique within the facility.

metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
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 leases operations
Build something that works beautifully.

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

Get Lease Delinquency | Facily Developers