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

Override Lease Delinquency

Leases · REST API reference

Get support
POST/v1/leases/{lease_id}/delinquency/override

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 POST \
  --url 'https://api.staging.facily.ai/v1/leases/<LEASE_ID>/delinquency/override' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "action": "advance_stage",
  "reason": "string",
  "amount": 0,
  "auction_date": "2026-10-29",
  "auction_location": "string",
  "auction_time": "string",
  "count": 1,
  "kind": "gate_lockout",
  "ledger_entry_id": "00000000-0000-4000-8000-000000000001",
  "mailed_on": "2026-10-29",
  "method": "certified_mail",
  "note": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

lease_idpath · stringrequired

Format: uuid

Request body

application/json · Required

actionOverrideActionrequired

Values: "advance_stage", "skip_stage", "reverse_stage", "cure", "write_off", "waive_fee", "apply_lockout", "release_lockout", "pause", "resume", "set_arrangement", "record_opposition", "military_hold", "schedule_auction", "record_mailing", "record_publication"

amountnumber | string | null

write_off only: how much to write off; default the whole outstanding balance.

Pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,10}|(?=[\d.]{1,13}0*$)\d{0,10}\.\d{0,2}0*$)

Show amount schema
number | string | null

write_off only: how much to write off; default the whole outstanding balance.

Variant 1: number
number
Variant 2: string
string
Variant 3: null
null
auction_datestring | null

schedule_auction only: the sale date.

Format: date

Show auction_date schema
string | null

schedule_auction only: the sale date.

Variant 1: string
string
Variant 2: null
null
auction_locationstring | null

schedule_auction only: where it is held.

Max length: 255

Show auction_location schema
string | null

schedule_auction only: where it is held.

Variant 1: string
string
Variant 2: null
null
auction_timestring | null

schedule_auction only: the sale time.

Max length: 20

Show auction_time schema
string | null

schedule_auction only: the sale time.

Variant 1: string
string
Variant 2: null
null
countinteger | null

record_publication only: how many times it ran.

Minimum: 1

Show count schema
integer | null

record_publication only: how many times it ran.

Variant 1: integer
integer
Variant 2: null
null
kindstring | null

apply_lockout only: which lockout to apply.

Values: "gate_lockout", "overlock"

Show kind schema
string | null

apply_lockout only: which lockout to apply.

Variant 1: string
string

Values: "gate_lockout", "overlock"

Variant 2: null
null
ledger_entry_idstring | null

waive_fee only: the engine fee entry to void.

Format: uuid

Show ledger_entry_id schema
string | null

waive_fee only: the engine fee entry to void.

Variant 1: string
string
Variant 2: null
null
mailed_onstring | null

record_mailing only: the date it was mailed.

Format: date

Show mailed_on schema
string | null

record_mailing only: the date it was mailed.

Variant 1: string
string
Variant 2: null
null
methodstring | null

record_mailing only: how it was sent.

Values: "certified_mail", "verified_mail", "first_class_mail", "email_with_consent"

Show method schema
string | null

record_mailing only: how it was sent.

Variant 1: string
string

Values: "certified_mail", "verified_mail", "first_class_mail", "email_with_consent"

Variant 2: null
null
notestring | null

set_arrangement only: the note filed on the collection task.

Max length: 2000

Show note schema
string | null

set_arrangement only: the note filed on the collection task.

Variant 1: string
string
Variant 2: null
null
outletstring | null

record_publication only: where it ran.

Max length: 255

Show outlet schema
string | null

record_publication only: where it ran.

Variant 1: string
string
Variant 2: null
null
promise_datestring | null

set_arrangement only: the date the tenant promises to pay by.

Format: date

Show promise_date schema
string | null

set_arrangement only: the date the tenant promises to pay by.

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

record_publication only: the date of first publication.

Format: date

Show published_on schema
string | null

record_publication only: the date of first publication.

Variant 1: string
string
Variant 2: null
null
reasonstringrequired

Why the operator is overriding the engine. Stored on the case and in every audit row.

Min length: 1 · Max length: 255

recipient_idstring | null

record_mailing only: the recipient's row. Required for every kind but lienholder, which has none.

Format: uuid

Show recipient_id schema
string | null

record_mailing only: the recipient's row. Required for every kind but lienholder, which has none.

Variant 1: string
string
Variant 2: null
null
recipient_kindstring | null

record_mailing only: who the notice went to.

Values: "occupant", "alternate_contact", "lienholder"

Show recipient_kind schema
string | null

record_mailing only: who the notice went to.

Variant 1: string
string

Values: "occupant", "alternate_contact", "lienholder"

Variant 2: null
null
recipient_namestring | null

record_mailing only: the lienholder's name; required for recipient_kind=lienholder, which has no row.

Max length: 255

Show recipient_name schema
string | null

record_mailing only: the lienholder's name; required for recipient_kind=lienholder, which has no row.

Variant 1: string
string
Variant 2: null
null
stage_keystring | null

record_mailing and record_publication only: `{kind}:{index}` of the stage whose notice this is.

Max length: 60

Show stage_key schema
string | null

record_mailing and record_publication only: `{kind}:{index}` of the stage whose notice this is.

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

record_mailing only: the carrier's tracking reference.

Max length: 50

Show tracking_number schema
string | null

record_mailing only: the carrier's tracking reference.

Variant 1: string
string
Variant 2: null
null
untilstring | null

pause and military_hold only: when the pause lifts.

Format: date

Show until schema
string | null

pause and military_hold only: when the pause lifts.

Variant 1: string
string
Variant 2: null
null

Responses

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

200Successful Response
JSON · generated example
{
  "data": {
    "action": "advance_stage",
    "actions_taken": [
      {}
    ],
    "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>"
    },
    "events_published": 0
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataDelinquencyOverrideResponserequired

What one override did: the case as it now stands, and what it produced.

Show data schema
actionOverrideActionrequired

Values: "advance_stage", "skip_stage", "reverse_stage", "cure", "write_off", "waive_fee", "apply_lockout", "release_lockout", "pause", "resume", "set_arrangement", "record_opposition", "military_hold", "schedule_auction", "record_mailing", "record_publication"

actions_takenobject[]required

One record per effect, with what it produced.

Show actions_taken schema
object
caseDelinquencyCaseResponserequired

One row of the collections queue, or one lease's case in full.

Show case schema
assigned_toUserCompactResponse | null

The arrangement task's assignee.

Show assigned_to schema
UserCompactResponse | null

The arrangement task's assignee.

Variant 1: UserCompactResponse
display_namestringrequired
emailstringrequired
idstringrequired

Format: uuid

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

Where the sale takes place.

Show auction_location schema
string | null

Where the sale takes place.

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

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.

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.

Show denied_provider schema
string | null

The lock provider that confirmed it, for example kiss.

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

Show denied_since schema
string | 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.

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

When the override was applied.

Format: date-time

bystring | null

The staff user who applied the override.

Format: uuid

reasonstring | null

The operator's stated reason.

statestringrequired

The state the case was in when an operator last overrode the ladder.

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

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.

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*$

events_publishedintegerrequired

Domain events published after the commit; zero when publishing failed.

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

Override Lease Delinquency | Facily Developers