/v1/leases/{lease_id}/delinquency/overrideAuthentication
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 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"
}'Parameters
lease_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
actionOverrideActionrequiredValues: "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 | nullwrite_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 | nullwrite_off only: how much to write off; default the whole outstanding balance.
Variant 1: number
numberVariant 2: string
stringVariant 3: null
nullauction_datestring | nullschedule_auction only: the sale date.
Format: date
Show auction_date schema
string | nullschedule_auction only: the sale date.
Variant 1: string
stringVariant 2: null
nullauction_locationstring | nullschedule_auction only: where it is held.
Max length: 255
Show auction_location schema
string | nullschedule_auction only: where it is held.
Variant 1: string
stringVariant 2: null
nullauction_timestring | nullschedule_auction only: the sale time.
Max length: 20
Show auction_time schema
string | nullschedule_auction only: the sale time.
Variant 1: string
stringVariant 2: null
nullcountinteger | nullrecord_publication only: how many times it ran.
Minimum: 1
Show count schema
integer | nullrecord_publication only: how many times it ran.
Variant 1: integer
integerVariant 2: null
nullkindstring | nullapply_lockout only: which lockout to apply.
Values: "gate_lockout", "overlock"
Show kind schema
string | nullapply_lockout only: which lockout to apply.
Variant 1: string
stringValues: "gate_lockout", "overlock"
Variant 2: null
nullledger_entry_idstring | nullwaive_fee only: the engine fee entry to void.
Format: uuid
Show ledger_entry_id schema
string | nullwaive_fee only: the engine fee entry to void.
Variant 1: string
stringVariant 2: null
nullmailed_onstring | nullrecord_mailing only: the date it was mailed.
Format: date
Show mailed_on schema
string | nullrecord_mailing only: the date it was mailed.
Variant 1: string
stringVariant 2: null
nullmethodstring | nullrecord_mailing only: how it was sent.
Values: "certified_mail", "verified_mail", "first_class_mail", "email_with_consent"
Show method schema
string | nullrecord_mailing only: how it was sent.
Variant 1: string
stringValues: "certified_mail", "verified_mail", "first_class_mail", "email_with_consent"
Variant 2: null
nullnotestring | nullset_arrangement only: the note filed on the collection task.
Max length: 2000
Show note schema
string | nullset_arrangement only: the note filed on the collection task.
Variant 1: string
stringVariant 2: null
nulloutletstring | nullrecord_publication only: where it ran.
Max length: 255
Show outlet schema
string | nullrecord_publication only: where it ran.
Variant 1: string
stringVariant 2: null
nullpromise_datestring | nullset_arrangement only: the date the tenant promises to pay by.
Format: date
Show promise_date schema
string | nullset_arrangement only: the date the tenant promises to pay by.
Variant 1: string
stringVariant 2: null
nullpublished_onstring | nullrecord_publication only: the date of first publication.
Format: date
Show published_on schema
string | nullrecord_publication only: the date of first publication.
Variant 1: string
stringVariant 2: null
nullreasonstringrequiredWhy the operator is overriding the engine. Stored on the case and in every audit row.
Min length: 1 · Max length: 255
recipient_idstring | nullrecord_mailing only: the recipient's row. Required for every kind but lienholder, which has none.
Format: uuid
Show recipient_id schema
string | nullrecord_mailing only: the recipient's row. Required for every kind but lienholder, which has none.
Variant 1: string
stringVariant 2: null
nullrecipient_kindstring | nullrecord_mailing only: who the notice went to.
Values: "occupant", "alternate_contact", "lienholder"
Show recipient_kind schema
string | nullrecord_mailing only: who the notice went to.
Variant 1: string
stringValues: "occupant", "alternate_contact", "lienholder"
Variant 2: null
nullrecipient_namestring | nullrecord_mailing only: the lienholder's name; required for recipient_kind=lienholder, which has no row.
Max length: 255
Show recipient_name schema
string | nullrecord_mailing only: the lienholder's name; required for recipient_kind=lienholder, which has no row.
Variant 1: string
stringVariant 2: null
nullstage_keystring | nullrecord_mailing and record_publication only: `{kind}:{index}` of the stage whose notice this is.
Max length: 60
Show stage_key schema
string | nullrecord_mailing and record_publication only: `{kind}:{index}` of the stage whose notice this is.
Variant 1: string
stringVariant 2: null
nulltracking_numberstring | nullrecord_mailing only: the carrier's tracking reference.
Max length: 50
Show tracking_number schema
string | nullrecord_mailing only: the carrier's tracking reference.
Variant 1: string
stringVariant 2: null
nulluntilstring | nullpause and military_hold only: when the pause lifts.
Format: date
Show until schema
string | nullpause and military_hold only: when the pause lifts.
Variant 1: string
stringVariant 2: null
nullResponses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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
dataDelinquencyOverrideResponserequiredWhat one override did: the case as it now stands, and what it produced.
Show data schema
actionOverrideActionrequiredValues: "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[]requiredOne record per effect, with what it produced.
Show actions_taken schema
objectcaseDelinquencyCaseResponserequiredOne row of the collections queue, or one lease's case in full.
Show case schema
assigned_toUserCompactResponse | nullThe arrangement task's assignee.
Show assigned_to schema
UserCompactResponse | nullThe arrangement task's assignee.
Variant 1: UserCompactResponse
display_namestringrequiredemailstringrequiredidstringrequiredFormat: uuid
Variant 2: null
nullauction_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
stringVariant 2: null
nullauction_locationstring | nullWhere the sale takes place.
Show auction_location schema
string | nullWhere the sale takes place.
Variant 1: string
stringVariant 2: null
nullauction_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
stringVariant 2: null
nullbalancestringrequiredOutstanding 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
stringVariant 2: null
nullclosed_reasonstring | nullcured, written_off or lease_closed.
Show closed_reason schema
string | nullcured, written_off or lease_closed.
Variant 1: string
stringVariant 2: null
nullcurrent_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
stringVariant 2: null
nulllast_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
stringVariant 2: null
nullleaseLeaseCompactResponserequiredShow 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
Variant 2: null
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.
Show denied_provider schema
string | nullThe lock provider that confirmed it, for example kiss.
Variant 1: string
Variant 2: null
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
Show denied_since schema
string | 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.
Variant 1: string
Variant 2: null
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
stringVariant 2: null
nullnext_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
stringVariant 2: null
nullnext_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
stringVariant 2: null
nullnext_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
stringVariant 2: null
nullnext_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
stringVariant 2: null
nullopened_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
atstringrequiredWhen the override was applied.
Format: date-time
bystring | nullThe staff user who applied the override.
Format: uuid
reasonstring | nullThe operator's stated reason.
statestringrequiredThe state the case was in when an operator last overrode the ladder.
Variant 2: null
nullpause_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
stringVariant 2: null
nullpaused_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
stringVariant 2: null
nullrecent_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 | nullShow notes schema
string | nullVariant 1: string
Variant 2: null
trigger_daysintegerrequiredstatestringrequiredThe case's current delinquency state.
tenantTenantCompactResponserequiredInline tenant reference. Extended variant adds email/phone.
Show tenant schema
emailstring | nullPrimary email address.
Show email schema
string | nullPrimary email address.
Variant 1: string
Variant 2: null
first_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
Variant 2: null
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*$
events_publishedintegerrequiredDomain events published after the commit; zero when publishing failed.
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