Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsComplete Unpaid
Search the full API reference Esc to close

Complete Unpaid

Quotes · REST API reference

Get support
POST/v1/quotes/{quote_id}/complete-unpaid
Complete an accepted move-in before its first charges are paid (lease.create_unpaid at the quote's facility). The override is recorded on the quote and audited `move_in.completed_unpaid` when given, and holds for every later completion: a move-in still waiting for its signed agreement, its date or the device-window acknowledgement (`completion_status` says which) completes when that arrives, unpaid. A completed move-in answers `completed` again. 409 `quote_not_accepted`, `quote_busy`, `lead_busy`, `unit_busy`, `unit_not_available`.

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/quotes/<QUOTE_ID>/complete-unpaid' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "device_window_acknowledged": false
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

quote_idpath · stringrequired

Format: uuid

Request body

application/json

CompleteUnpaidRequest | null
Variant 1: CompleteUnpaidRequest
device_window_acknowledgedboolean

Staff told the tenant that the last tenant's phone may still open the unit for up to about 8 hours. Recorded on the quote; needed to complete a move-in on the day, on a unit whose last access grant was revoked within the provider's device window, at a facility whose access sync runs.

Default: false

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": {
    "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

dataQuoteResponserequired
Show data schema
accepted_atstring | null

Format: date-time

Show accepted_at schema
string | null
Variant 1: string
string
Variant 2: null
null
cancel_reasonstring | null
Show cancel_reason schema
string | null
Variant 1: string
string
Variant 2: null
null
cancelled_atstring | null

Format: date-time

Show cancelled_at schema
string | null
Variant 1: string
string
Variant 2: null
null
completed_atstring | null

Format: date-time

Show completed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
completion_statusstring | null

POST /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 | null

POST /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
string

Values: "completed", "waiting_for_payment", "waiting_for_date", "waiting_for_signature", "waiting_for_acknowledgement"

Variant 2: null
null
created_atstringrequired

Format: date-time

declined_atstring | null

Format: date-time

Show declined_at schema
string | null
Variant 1: string
string
Variant 2: null
null
effective_datestringrequired

The move's date.

Format: date

existing_balanceExistingBalanceResponse | null

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

On 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
arrearsstringrequired

Unpaid charges past their due date on the tenant's rentals here.

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

locked_outbooleanrequired

A rental of theirs has an open delinquency case at or past locked_out.

refusedstring[]required

What 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
string

Values: "arrears", "locked_out"

Variant 2: null
null
expires_atstring | null

When an accepted, unpaid move-in lapses.

Format: date-time

Show expires_at schema
string | null

When an accepted, unpaid move-in lapses.

Variant 1: string
string
Variant 2: null
null
facility_idstringrequired

Format: uuid

idstringrequired

Format: uuid

lead_idstring | null

Format: uuid

Show lead_id schema
string | null
Variant 1: string
string
Variant 2: null
null
lease_idstring | null

Format: uuid

Show lease_id schema
string | null
Variant 1: string
string
Variant 2: null
null
line_itemsQuoteLineResponse[]required
Show line_items schema
amountstringrequired

What the line posts: subtotal - discount + tax. A move-out's void of a charge is negative.

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

descriptionstringrequired
discountstringrequired

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

due_onstring | null

Format: date

Show due_on schema
string | null
Variant 1: string
string
Variant 2: null
null
period_endstring | null

Format: date

Show period_end schema
string | null
Variant 1: string
string
Variant 2: null
null
period_startstring | null

Format: date

Show period_start schema
string | null
Variant 1: string
string
Variant 2: null
null
source_keystringrequired

The line's posting key, with the lease id as `{lease_id}`.

subtotalstringrequired

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

taxstringrequired

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

typestringrequired

rent, 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 | null

A move-out quote's balance figures.

Show move_out schema
MoveOutSummaryResponse | null

A move-out quote's balance figures.

Variant 1: MoveOutSummaryResponse
balance_afterstringrequired

After the final bill. Positive: owed. Negative: a credit.

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

credit_before_cutoverstringrequired

The rest of the credit: from before cutover, refundable only by check once confirmed.

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

credit_since_go_livestringrequired

The part of the credit Facily payments since go-live carry.

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

current_balancestringrequired

The lease ledger's balance when the quote was priced.

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

Variant 2: null
null
new_unit_idstring | null

Format: uuid

Show new_unit_id schema
string | null
Variant 1: string
string
Variant 2: null
null
quote_numberstringrequired
quote_typestringrequired

move_in, move_out or transfer.

recurring_totalstring | null

The period after the first: the monthly figure.

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

Show recurring_total schema
string | null

The period after the first: the monthly figure.

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

The facility where the matching person is flagged.

flagged_onstringrequired

The date they were first flagged, at the facility that flagged them.

Format: date

matched_onstring[]required

Which of the lead's email, phone and name matched, in that order.

Show matched_on schema
string
reasonstringrequired

Why they were flagged: delinquency, fraud, damage, conduct or other.

Values: "delinquency", "fraud", "damage", "conduct", "other"

sent_atstring | null

Format: date-time

Show sent_at schema
string | null
Variant 1: string
string
Variant 2: null
null
statusstringrequired

draft, sent, accepted, completed, cancelled, declined or expired.

subtotalstringrequired

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

tax_amountstringrequired

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

tenant_idstring | null

Format: uuid

Show tenant_id schema
string | null
Variant 1: string
string
Variant 2: null
null
termsMoveInTerms-Output | MoveOutTerms | TransferTerms-Outputrequired
Show terms schema
MoveInTerms-Output | MoveOutTerms | TransferTerms-Output
Variant 1: MoveInTerms-Output
alternate_contactAlternateContactInput | null

A new alternate contact for an existing tenant. A new person's is in new_tenant.

Show alternate_contact schema
AlternateContactInput | null

A new alternate contact for an existing tenant. A new person's is in new_tenant.

Variant 1: AlternateContactInput
Variant 2: null
alternate_contact_declinedboolean

Default: false

alternate_contact_idstring | null

An existing tenant's alternate contact for this rental. A new person's is in new_tenant.

Format: uuid

Show alternate_contact_id schema
string | null

An existing tenant's alternate contact for this rental. A new person's is in new_tenant.

Variant 1: string
Variant 2: null
autopayAutopayChoice-Output | null
Show autopay schema
AutopayChoice-Output | null
Variant 1: AutopayChoice-Output
Variant 2: null
existing_balance_overrideboolean

Rent 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
string
honoured_promotion_idstring | null

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

Set 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_checkedboolean

Staff checked the customer's ID (`move_in_requires_id_verification`).

Default: false

insuranceInsuranceChoice | null
Show insurance schema
InsuranceChoice | null
Variant 1: InsuranceChoice
Variant 2: null
lead_idstring | null

The lead this move-in converts, if any.

Format: uuid

Show lead_id schema
string | null

The lead this move-in converts, if any.

Variant 1: string
Variant 2: null
move_in_datestringrequired

Today to `operations.move_in_max_days_ahead` days ahead.

Format: date

new_tenantTenantCreate | null

A new person. Accept creates the tenant from it.

Show new_tenant schema
TenantCreate | null

A new person. Accept creates the tenant from it.

Variant 1: TenantCreate
Variant 2: null
promotion_idstring | null

A promotion chosen.

Format: uuid

Show promotion_id schema
string | null

A promotion chosen.

Variant 1: string
Variant 2: null
quote_typestring

Default: "move_in"

ratestring | null

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

A 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_basisstring

Default: "street" · Values: "street", "web"

removed_fee_rule_idsstring[]

Required fees waived (needs lease.fee.write).

Show removed_fee_rule_ids schema
string
removed_promotion_idsstring[]

Automatic promotions removed (needs lease.fee.write).

Show removed_promotion_ids schema
string
tenant_idstring | null

An existing tenant at this facility.

Format: uuid

Show tenant_id schema
string | null

An existing tenant at this facility.

Variant 1: string
Variant 2: null
unit_idstringrequired

Format: uuid

waiversWaiver-Output[]

Set by the server from the removals, with who made each. A value sent is replaced.

Show waivers schema
amountstring | null

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

idstringrequired

Format: uuid

kindstringrequired

Values: "fee", "promotion"

recorded_atstringrequired

Format: date-time

recorded_bystringrequired

Format: 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
string
lease_idstringrequired

Format: uuid

move_out_datestringrequired

Today or later, and not before the facility's go-live date.

Format: date

move_out_reasonstring | null

The attrition picker's reason, stored on the lease as `move_out_reason`.

Max length: 255

Show move_out_reason schema
string | null

The attrition picker's reason, stored on the lease as `move_out_reason`.

Variant 1: string
Variant 2: null
quote_typestring

Default: "move_out"

termination_reasonstring

Default: "voluntary" · Values: "voluntary", "nonpayment", "auction", "violation"

Variant 3: TransferTerms-Output
autopayAutopayChoice-Output | null

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

Autopay 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
string
insuranceInsuranceChoice | null

The new lease's coverage. Null: the current lease's coverage is carried.

Show insurance schema
InsuranceChoice | null

The new lease's coverage. Null: the current lease's coverage is carried.

Variant 1: InsuranceChoice
Variant 2: null
lease_idstringrequired

Format: uuid

new_unit_idstringrequired

Format: uuid

quote_typestring

Default: "transfer"

ratestring | null

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

A 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_basisstring

Default: "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
string
transfer_datestringrequired

Today: 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
string
waiversWaiver-Output[]

Set by the server from `waived_fee_rule_ids`, with who waived each. A value sent is replaced.

Show waivers schema
amountstring | null

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

idstringrequired

Format: uuid

kindstringrequired

Values: "fee", "promotion"

recorded_atstringrequired

Format: date-time

recorded_bystringrequired

Format: uuid

total_duestringrequired

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

Format: uuid

Show unit_id schema
string | null
Variant 1: string
string
Variant 2: null
null
updated_atstringrequired

Format: date-time

valid_untilstringrequired

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

imported_charges_after_move_out: their net total.

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

Show amount schema
string | null

imported_charges_after_move_out: their net total.

Variant 1: string
string
Variant 2: null
null
codestringrequired

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

imported_charges_after_move_out: how many.

Show count schema
integer | null

imported_charges_after_move_out: how many.

Variant 1: integer
integer
Variant 2: null
null
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 quotes operations
Build something that works beautifully.

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

Complete Unpaid | Facily Developers