/v1/quotes/{quote_id}Authentication
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 PATCH \
--url 'https://api.staging.facily.ai/v1/quotes/<QUOTE_ID>' \
--header "Authorization: Bearer $FACILY_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"terms": {
"move_in_date": "2026-10-29",
"unit_id": "00000000-0000-4000-8000-000000000001",
"alternate_contact": {
"address": {
"city": "string",
"state": "st",
"street": "string",
"zip": "string",
"country": "US",
"street_2": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"relationship": "string"
},
"alternate_contact_declined": false,
"alternate_contact_id": "00000000-0000-4000-8000-000000000001",
"autopay": {
"consent_version": "string",
"charge_day_offset": 0,
"max_amount": 0,
"payment_method_id": "00000000-0000-4000-8000-000000000001"
},
"existing_balance_override": false,
"fee_rule_ids": [
"00000000-0000-4000-8000-000000000001"
],
"honoured_promotion_id": "00000000-0000-4000-8000-000000000001",
"id_checked": false,
"insurance": {
"coverage_type": "facility_plan",
"insurance_plan_id": "00000000-0000-4000-8000-000000000001",
"own_policy": {
"carrier": "string",
"certificate_document_id": "00000000-0000-4000-8000-000000000001",
"expires_on": "2026-10-29",
"policy_number": "string"
}
},
"lead_id": "00000000-0000-4000-8000-000000000001"
}
}'Parameters
quote_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
termsMoveInTerms-Input | MoveOutTerms | TransferTerms-InputrequiredShow terms schema
MoveInTerms-Input | MoveOutTerms | TransferTerms-InputVariant 1: MoveInTerms-Input
alternate_contactAlternateContactInput | nullA new alternate contact for an existing tenant. A new person's is in new_tenant.
Show alternate_contact schema
AlternateContactInput | nullA new alternate contact for an existing tenant. A new person's is in new_tenant.
Variant 1: AlternateContactInput
addressAddressInputrequiredA structured mailing address.
emailstring | nullMax length: 255
first_namestringrequiredMin length: 1 · Max length: 100
last_namestringrequiredMin length: 1 · Max length: 100
phonestring | nullMax length: 20
relationshipstring | nullMax length: 50
Variant 2: null
nullalternate_contact_declinedbooleanDefault: false
alternate_contact_idstring | nullAn existing tenant's alternate contact for this rental. A new person's is in new_tenant.
Format: uuid
Show alternate_contact_id schema
string | nullAn existing tenant's alternate contact for this rental. A new person's is in new_tenant.
Variant 1: string
stringVariant 2: null
nullautopayAutopayChoice-Input | nullShow autopay schema
AutopayChoice-Input | nullVariant 1: AutopayChoice-Input
charge_day_offsetintegerDefault: 0 · Minimum: 0 · Maximum: 28
consent_versionstringrequiredMin length: 1 · Max length: 50
max_amountnumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
payment_method_idstring | nullA saved method of the tenant. A new tenant's card is vaulted by the move-in payment.
Format: uuid
Variant 2: null
nullexisting_balance_overridebooleanRent to an existing tenant whom `move_in_existing_balance` refuses (arrears or a locked-out unit). Accept checks that the accepting user holds lease.create_unpaid.
Default: false
fee_rule_idsstring[]Optional fees chosen, recurring or one-time.
Show fee_rule_ids schema
stringhonoured_promotion_idstring | nullSet by the server: the promotion quoted on the lead's live hold of this unit. A value sent is replaced.
Format: uuid
Show honoured_promotion_id schema
string | nullSet by the server: the promotion quoted on the lead's live hold of this unit. A value sent is replaced.
Variant 1: string
stringVariant 2: null
nullid_checkedbooleanStaff checked the customer's ID (`move_in_requires_id_verification`).
Default: false
insuranceInsuranceChoice | nullShow insurance schema
InsuranceChoice | nullVariant 1: InsuranceChoice
coverage_typestringrequiredValues: "facility_plan", "own_policy", "declined"
insurance_plan_idstring | nullRequired for facility_plan, refused otherwise.
Format: uuid
own_policyOwnPolicyInput | nullRequired for own_policy, refused otherwise.
Variant 2: null
nulllead_idstring | nullThe lead this move-in converts, if any.
Format: uuid
Show lead_id schema
string | nullThe lead this move-in converts, if any.
Variant 1: string
stringVariant 2: null
nullmove_in_datestringrequiredToday to `operations.move_in_max_days_ahead` days ahead.
Format: date
new_tenantTenantCreate | nullA new person. Accept creates the tenant from it.
Show new_tenant schema
TenantCreate | nullA new person. Accept creates the tenant from it.
Variant 1: TenantCreate
addressAddressInputrequiredA structured mailing address.
alternate_contactAlternateContactInput | nullalternate_contact_declinedbooleanThe tenant declined to name an alternate contact.
Default: false
company_namestring | nullMax length: 255
date_of_birthstring | nullFormat: date
emailstring | nullMax length: 255
first_namestringrequiredMin length: 1 · Max length: 100
is_businessbooleanDefault: false
is_militaryboolean | nullMilitary status. Null means not asked.
last_namestringrequiredMin length: 1 · Max length: 100
middle_initialstring | nullMax length: 2
military_service_end_datestring | nullFormat: date
phonestring | nullAt KISS facilities this number is the app sign-in.
Max length: 20
sms_consentSmsConsentInput | nullA consent staff obtained (attested). A lead's consent is copied only when the phones match.
tax_exemptbooleanDefault: false
tax_exempt_idstring | nullMax length: 50
Variant 2: null
nullpromotion_idstring | nullA promotion chosen.
Format: uuid
Show promotion_id schema
string | nullA promotion chosen.
Variant 1: string
stringVariant 2: null
nullquote_typestringDefault: "move_in"
ratenumber | string | nullA custom monthly rate (needs lease.rate.write). Null: the lead's quoted rate on its held unit, else the unit's street or web rate (`rate_basis`).
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
Show rate schema
number | string | nullA custom monthly rate (needs lease.rate.write). Null: the lead's quoted rate on its held unit, else the unit's street or web rate (`rate_basis`).
Variant 1: number
numberVariant 2: string
stringVariant 3: null
nullrate_basisstringDefault: "street" · Values: "street", "web"
removed_fee_rule_idsstring[]Required fees waived (needs lease.fee.write).
Show removed_fee_rule_ids schema
stringremoved_promotion_idsstring[]Automatic promotions removed (needs lease.fee.write).
Show removed_promotion_ids schema
stringtenant_idstring | nullAn existing tenant at this facility.
Format: uuid
Show tenant_id schema
string | nullAn existing tenant at this facility.
Variant 1: string
stringVariant 2: null
nullunit_idstringrequiredFormat: uuid
waiversWaiver-Input[]Set by the server from the removals, with who made each. A value sent is replaced.
Show waivers schema
amountnumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show amount schema
number | string | nullVariant 1: number
Variant 2: string
Variant 3: null
idstringrequiredFormat: uuid
kindstringrequiredValues: "fee", "promotion"
recorded_atstringrequiredFormat: date-time
recorded_bystringrequiredFormat: uuid
Variant 2: MoveOutTerms
fee_rule_idsstring[]One-time catalog fees to charge at move-out (cleaning, cut lock, a notice fee). Leaving the notice fee out waives it.
Show fee_rule_ids schema
stringlease_idstringrequiredFormat: uuid
move_out_datestringrequiredToday or later, and not before the facility's go-live date.
Format: date
move_out_reasonstring | nullThe attrition picker's reason, stored on the lease as `move_out_reason`.
Max length: 255
Show move_out_reason schema
string | nullThe attrition picker's reason, stored on the lease as `move_out_reason`.
Variant 1: string
stringVariant 2: null
nullquote_typestringDefault: "move_out"
termination_reasonstringDefault: "voluntary" · Values: "voluntary", "nonpayment", "auction", "violation"
Variant 3: TransferTerms-Input
autopayAutopayChoice-Input | nullAutopay on the new lease, with the new agreement's consent. A null `payment_method_id` uses the current mandate's method. Null: no autopay on the new lease (the current mandate ends with its lease).
Show autopay schema
AutopayChoice-Input | nullAutopay on the new lease, with the new agreement's consent. A null `payment_method_id` uses the current mandate's method. Null: no autopay on the new lease (the current mandate ends with its lease).
Variant 1: AutopayChoice-Input
charge_day_offsetintegerDefault: 0 · Minimum: 0 · Maximum: 28
consent_versionstringrequiredMin length: 1 · Max length: 50
max_amountnumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
payment_method_idstring | nullA saved method of the tenant. A new tenant's card is vaulted by the move-in payment.
Format: uuid
Variant 2: null
nullfee_rule_idsstring[]One-time catalog fees to charge at the transfer (the transfer fee).
Show fee_rule_ids schema
stringinsuranceInsuranceChoice | nullThe new lease's coverage. Null: the current lease's coverage is carried.
Show insurance schema
InsuranceChoice | nullThe new lease's coverage. Null: the current lease's coverage is carried.
Variant 1: InsuranceChoice
coverage_typestringrequiredValues: "facility_plan", "own_policy", "declined"
insurance_plan_idstring | nullRequired for facility_plan, refused otherwise.
Format: uuid
own_policyOwnPolicyInput | nullRequired for own_policy, refused otherwise.
Variant 2: null
nulllease_idstringrequiredFormat: uuid
new_unit_idstringrequiredFormat: uuid
quote_typestringDefault: "transfer"
ratenumber | string | nullA custom monthly rate for the new unit (needs lease.rate.write). Null: its street or web rate (`rate_basis`).
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
Show rate schema
number | string | nullA custom monthly rate for the new unit (needs lease.rate.write). Null: its street or web rate (`rate_basis`).
Variant 1: number
numberVariant 2: string
stringVariant 3: null
nullrate_basisstringDefault: "street" · Values: "street", "web"
removed_fee_rule_idsstring[]Optional recurring fees on the current lease NOT to carry to the new one. The rest are carried, and the new unit's required recurring fees are attached as at a move-in.
Show removed_fee_rule_ids schema
stringtransfer_datestringrequiredToday: a transfer executes when it is accepted.
Format: date
waived_fee_rule_idsstring[]One-time catalog fees waived at the transfer (needs lease.fee.write): not charged, and recorded as waivers with who waived them.
Show waived_fee_rule_ids schema
stringwaiversWaiver-Input[]Set by the server from `waived_fee_rule_ids`, with who waived each. A value sent is replaced.
Show waivers schema
amountnumber | string | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show amount schema
number | string | nullVariant 1: number
Variant 2: string
Variant 3: null
idstringrequiredFormat: uuid
kindstringrequiredValues: "fee", "promotion"
recorded_atstringrequiredFormat: date-time
recorded_bystringrequiredFormat: uuid
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"created_at": "2026-10-29T12:00:00Z",
"effective_date": "2026-10-29",
"facility_id": "00000000-0000-4000-8000-000000000001",
"id": "00000000-0000-4000-8000-000000000001",
"line_items": [
{
"amount": "<VALUE_MATCHING_PATTERN>",
"description": "string",
"discount": "<VALUE_MATCHING_PATTERN>",
"source_key": "string",
"subtotal": "<VALUE_MATCHING_PATTERN>",
"tax": "<VALUE_MATCHING_PATTERN>",
"type": "string",
"due_on": "2026-10-29",
"period_end": "2026-10-29",
"period_start": "2026-10-29"
}
],
"quote_number": "string",
"quote_type": "string",
"status": "string",
"subtotal": "<VALUE_MATCHING_PATTERN>",
"tax_amount": "<VALUE_MATCHING_PATTERN>",
"terms": {
"move_in_date": "2026-10-29",
"unit_id": "00000000-0000-4000-8000-000000000001",
"alternate_contact": {
"address": {
"city": "string",
"state": "st",
"street": "string",
"zip": "string",
"country": "US",
"street_2": "string"
},
"first_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"relationship": "string"
},
"alternate_contact_declined": false,
"alternate_contact_id": "00000000-0000-4000-8000-000000000001",
"autopay": {
"consent_version": "string",
"charge_day_offset": 0,
"max_amount": "<VALUE_MATCHING_PATTERN>",
"payment_method_id": "00000000-0000-4000-8000-000000000001"
},
"existing_balance_override": false,
"fee_rule_ids": [
"00000000-0000-4000-8000-000000000001"
],
"honoured_promotion_id": "00000000-0000-4000-8000-000000000001",
"id_checked": false,
"insurance": {
"coverage_type": "facility_plan",
"insurance_plan_id": "00000000-0000-4000-8000-000000000001",
"own_policy": {
"carrier": "string",
"certificate_document_id": "00000000-0000-4000-8000-000000000001",
"expires_on": "2026-10-29",
"policy_number": "string"
}
},
"lead_id": "00000000-0000-4000-8000-000000000001"
},
"total_due": "<VALUE_MATCHING_PATTERN>",
"updated_at": "2026-10-29T12:00:00Z",
"valid_until": "2026-10-29"
},
"meta": {
"request_id": "string"
}
}application/json
dataQuoteResponserequiredShow data schema
accepted_atstring | nullFormat: date-time
Show accepted_at schema
string | nullVariant 1: string
stringVariant 2: null
nullcancel_reasonstring | nullShow cancel_reason schema
string | nullVariant 1: string
stringVariant 2: null
nullcancelled_atstring | nullFormat: date-time
Show cancelled_at schema
string | nullVariant 1: string
stringVariant 2: null
nullcompleted_atstring | nullFormat: date-time
Show completed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullcompletion_statusstring | nullPOST /v1/quotes/{quote_id}/complete-unpaid and /complete-move-out only: completed, or what the move still waits for (the signed agreement, the move-in or move-out date, the device-window acknowledgement). complete-unpaid records its override either way, and it holds until the move-in completes.
Values: "completed", "waiting_for_payment", "waiting_for_date", "waiting_for_signature", "waiting_for_acknowledgement"
Show completion_status schema
string | nullPOST /v1/quotes/{quote_id}/complete-unpaid and /complete-move-out only: completed, or what the move still waits for (the signed agreement, the move-in or move-out date, the device-window acknowledgement). complete-unpaid records its override either way, and it holds until the move-in completes.
Variant 1: string
stringValues: "completed", "waiting_for_payment", "waiting_for_date", "waiting_for_signature", "waiting_for_acknowledgement"
Variant 2: null
nullcreated_atstringrequiredFormat: date-time
declined_atstring | nullFormat: date-time
Show declined_at schema
string | nullVariant 1: string
stringVariant 2: null
nulleffective_datestringrequiredThe move's date.
Format: date
existing_balanceExistingBalanceResponse | nullOn create and update of a move-in for an existing tenant who owes past due or has a locked-out rental: the warning, or the refusal accept will give without an override. Null otherwise.
Show existing_balance schema
ExistingBalanceResponse | nullOn create and update of a move-in for an existing tenant who owes past due or has a locked-out rental: the warning, or the refusal accept will give without an override. Null otherwise.
Variant 1: ExistingBalanceResponse
arrearsstringrequiredUnpaid charges past their due date on the tenant's rentals here.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
locked_outbooleanrequiredA rental of theirs has an open delinquency case at or past locked_out.
refusedstring[]requiredWhat accept refuses (409 existing_balance_refused) unless the terms set existing_balance_override and the accepting user holds lease.create_unpaid. Empty: a warning only.
Show refused schema
stringValues: "arrears", "locked_out"
Variant 2: null
nullexpires_atstring | nullWhen an accepted, unpaid move-in lapses.
Format: date-time
Show expires_at schema
string | nullWhen an accepted, unpaid move-in lapses.
Variant 1: string
stringVariant 2: null
nullfacility_idstringrequiredFormat: uuid
idstringrequiredFormat: uuid
lead_idstring | nullFormat: uuid
Show lead_id schema
string | nullVariant 1: string
stringVariant 2: null
nulllease_idstring | nullFormat: uuid
Show lease_id schema
string | nullVariant 1: string
stringVariant 2: null
nullline_itemsQuoteLineResponse[]requiredShow line_items schema
amountstringrequiredWhat the line posts: subtotal - discount + tax. A move-out's void of a charge is negative.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
descriptionstringrequireddiscountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
due_onstring | nullFormat: date
Show due_on schema
string | nullVariant 1: string
stringVariant 2: null
nullperiod_endstring | nullFormat: date
Show period_end schema
string | nullVariant 1: string
stringVariant 2: null
nullperiod_startstring | nullFormat: date
Show period_start schema
string | nullVariant 1: string
stringVariant 2: null
nullsource_keystringrequiredThe line's posting key, with the lease id as `{lease_id}`.
subtotalstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
taxstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
typestringrequiredrent, insurance, fee, promotion or balance (a promotion line carries 0.00; a move-out's minimum-stay clawback carries what the promotion gave; balance is a transfer's current balance, carried to the new lease).
move_outMoveOutSummaryResponse | nullA move-out quote's balance figures.
Show move_out schema
MoveOutSummaryResponse | nullA move-out quote's balance figures.
Variant 1: MoveOutSummaryResponse
balance_afterstringrequiredAfter the final bill. Positive: owed. Negative: a credit.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
credit_before_cutoverstringrequiredThe rest of the credit: from before cutover, refundable only by check once confirmed.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
credit_since_go_livestringrequiredThe part of the credit Facily payments since go-live carry.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
current_balancestringrequiredThe lease ledger's balance when the quote was priced.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Variant 2: null
nullnew_unit_idstring | nullFormat: uuid
Show new_unit_id schema
string | nullVariant 1: string
stringVariant 2: null
nullquote_numberstringrequiredquote_typestringrequiredmove_in, move_out or transfer.
recurring_totalstring | nullThe period after the first: the monthly figure.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show recurring_total schema
string | nullThe period after the first: the monthly figure.
Variant 1: string
stringVariant 2: null
nullrental_review_warningsRentalReviewWarningResponse[]On create and update of a move-in: people flagged as do not rent whom the customer matches. Never names the tenant; never blocks.
Show rental_review_warnings schema
facility_namestringrequiredThe facility where the matching person is flagged.
flagged_onstringrequiredThe date they were first flagged, at the facility that flagged them.
Format: date
matched_onstring[]requiredWhich of the lead's email, phone and name matched, in that order.
Show matched_on schema
stringreasonstringrequiredWhy they were flagged: delinquency, fraud, damage, conduct or other.
Values: "delinquency", "fraud", "damage", "conduct", "other"
sent_atstring | nullFormat: date-time
Show sent_at schema
string | nullVariant 1: string
stringVariant 2: null
nullstatusstringrequireddraft, sent, accepted, completed, cancelled, declined or expired.
subtotalstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tax_amountstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
tenant_idstring | nullFormat: uuid
Show tenant_id schema
string | nullVariant 1: string
stringVariant 2: null
nulltermsMoveInTerms-Output | MoveOutTerms | TransferTerms-OutputrequiredShow terms schema
MoveInTerms-Output | MoveOutTerms | TransferTerms-OutputVariant 1: MoveInTerms-Output
alternate_contactAlternateContactInput | nullA new alternate contact for an existing tenant. A new person's is in new_tenant.
Show alternate_contact schema
AlternateContactInput | nullA new alternate contact for an existing tenant. A new person's is in new_tenant.
Variant 1: AlternateContactInput
Variant 2: null
alternate_contact_declinedbooleanDefault: false
alternate_contact_idstring | nullAn existing tenant's alternate contact for this rental. A new person's is in new_tenant.
Format: uuid
Show alternate_contact_id schema
string | nullAn existing tenant's alternate contact for this rental. A new person's is in new_tenant.
Variant 1: string
Variant 2: null
autopayAutopayChoice-Output | nullShow autopay schema
AutopayChoice-Output | nullVariant 1: AutopayChoice-Output
Variant 2: null
existing_balance_overridebooleanRent to an existing tenant whom `move_in_existing_balance` refuses (arrears or a locked-out unit). Accept checks that the accepting user holds lease.create_unpaid.
Default: false
fee_rule_idsstring[]Optional fees chosen, recurring or one-time.
Show fee_rule_ids schema
stringhonoured_promotion_idstring | nullSet by the server: the promotion quoted on the lead's live hold of this unit. A value sent is replaced.
Format: uuid
Show honoured_promotion_id schema
string | nullSet by the server: the promotion quoted on the lead's live hold of this unit. A value sent is replaced.
Variant 1: string
Variant 2: null
id_checkedbooleanStaff checked the customer's ID (`move_in_requires_id_verification`).
Default: false
insuranceInsuranceChoice | nullShow insurance schema
InsuranceChoice | nullVariant 1: InsuranceChoice
Variant 2: null
lead_idstring | nullThe lead this move-in converts, if any.
Format: uuid
Show lead_id schema
string | nullThe lead this move-in converts, if any.
Variant 1: string
Variant 2: null
move_in_datestringrequiredToday to `operations.move_in_max_days_ahead` days ahead.
Format: date
new_tenantTenantCreate | nullA new person. Accept creates the tenant from it.
Show new_tenant schema
TenantCreate | nullA new person. Accept creates the tenant from it.
Variant 1: TenantCreate
Variant 2: null
promotion_idstring | nullA promotion chosen.
Format: uuid
Show promotion_id schema
string | nullA promotion chosen.
Variant 1: string
Variant 2: null
quote_typestringDefault: "move_in"
ratestring | nullA custom monthly rate (needs lease.rate.write). Null: the lead's quoted rate on its held unit, else the unit's street or web rate (`rate_basis`).
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
Show rate schema
string | nullA custom monthly rate (needs lease.rate.write). Null: the lead's quoted rate on its held unit, else the unit's street or web rate (`rate_basis`).
Variant 1: string
Variant 2: null
rate_basisstringDefault: "street" · Values: "street", "web"
removed_fee_rule_idsstring[]Required fees waived (needs lease.fee.write).
Show removed_fee_rule_ids schema
stringremoved_promotion_idsstring[]Automatic promotions removed (needs lease.fee.write).
Show removed_promotion_ids schema
stringtenant_idstring | nullAn existing tenant at this facility.
Format: uuid
Show tenant_id schema
string | nullAn existing tenant at this facility.
Variant 1: string
Variant 2: null
unit_idstringrequiredFormat: uuid
waiversWaiver-Output[]Set by the server from the removals, with who made each. A value sent is replaced.
Show waivers schema
amountstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
idstringrequiredFormat: uuid
kindstringrequiredValues: "fee", "promotion"
recorded_atstringrequiredFormat: date-time
recorded_bystringrequiredFormat: uuid
Variant 2: MoveOutTerms
fee_rule_idsstring[]One-time catalog fees to charge at move-out (cleaning, cut lock, a notice fee). Leaving the notice fee out waives it.
Show fee_rule_ids schema
stringlease_idstringrequiredFormat: uuid
move_out_datestringrequiredToday or later, and not before the facility's go-live date.
Format: date
move_out_reasonstring | nullThe attrition picker's reason, stored on the lease as `move_out_reason`.
Max length: 255
Show move_out_reason schema
string | nullThe attrition picker's reason, stored on the lease as `move_out_reason`.
Variant 1: string
Variant 2: null
quote_typestringDefault: "move_out"
termination_reasonstringDefault: "voluntary" · Values: "voluntary", "nonpayment", "auction", "violation"
Variant 3: TransferTerms-Output
autopayAutopayChoice-Output | nullAutopay on the new lease, with the new agreement's consent. A null `payment_method_id` uses the current mandate's method. Null: no autopay on the new lease (the current mandate ends with its lease).
Show autopay schema
AutopayChoice-Output | nullAutopay on the new lease, with the new agreement's consent. A null `payment_method_id` uses the current mandate's method. Null: no autopay on the new lease (the current mandate ends with its lease).
Variant 1: AutopayChoice-Output
Variant 2: null
fee_rule_idsstring[]One-time catalog fees to charge at the transfer (the transfer fee).
Show fee_rule_ids schema
stringinsuranceInsuranceChoice | nullThe new lease's coverage. Null: the current lease's coverage is carried.
Show insurance schema
InsuranceChoice | nullThe new lease's coverage. Null: the current lease's coverage is carried.
Variant 1: InsuranceChoice
Variant 2: null
lease_idstringrequiredFormat: uuid
new_unit_idstringrequiredFormat: uuid
quote_typestringDefault: "transfer"
ratestring | nullA custom monthly rate for the new unit (needs lease.rate.write). Null: its street or web rate (`rate_basis`).
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
Show rate schema
string | nullA custom monthly rate for the new unit (needs lease.rate.write). Null: its street or web rate (`rate_basis`).
Variant 1: string
Variant 2: null
rate_basisstringDefault: "street" · Values: "street", "web"
removed_fee_rule_idsstring[]Optional recurring fees on the current lease NOT to carry to the new one. The rest are carried, and the new unit's required recurring fees are attached as at a move-in.
Show removed_fee_rule_ids schema
stringtransfer_datestringrequiredToday: a transfer executes when it is accepted.
Format: date
waived_fee_rule_idsstring[]One-time catalog fees waived at the transfer (needs lease.fee.write): not charged, and recorded as waivers with who waived them.
Show waived_fee_rule_ids schema
stringwaiversWaiver-Output[]Set by the server from `waived_fee_rule_ids`, with who waived each. A value sent is replaced.
Show waivers schema
amountstring | nullPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
idstringrequiredFormat: uuid
kindstringrequiredValues: "fee", "promotion"
recorded_atstringrequiredFormat: date-time
recorded_bystringrequiredFormat: uuid
total_duestringrequiredEverything the move posts: what must be paid to complete a move-in. A move-out's is what its final bill moves the balance by, negative for a net credit.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
unit_idstring | nullFormat: uuid
Show unit_id schema
string | nullVariant 1: string
stringVariant 2: null
nullupdated_atstringrequiredFormat: date-time
valid_untilstringrequiredThe last facility day a draft or sent quote holds its prices.
Format: date
warningsQuoteWarningResponse[]Things staff should know before accepting; none of them refuses.
Show warnings schema
amountstring | nullimported_charges_after_move_out: their net total.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
Show amount schema
string | nullimported_charges_after_move_out: their net total.
Variant 1: string
stringVariant 2: null
nullcodestringrequiredshort_notice: a move-out dated inside operations.move_out_notice_days. imported_charges_after_move_out: imported lines running past the move-out that the final bill leaves standing (credits, charges a credit overlaps, and charges not classified as rent, insurance or a service by account code); completion files a staff task to review them.
Values: "short_notice", "imported_charges_after_move_out"
countinteger | nullimported_charges_after_move_out: how many.
Show count schema
integer | nullimported_charges_after_move_out: how many.
Variant 1: integer
integerVariant 2: null
nullmetaMetarequiredEnvelope 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