Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsList Settlements
Search the full API reference Esc to close

List Settlements

Leases · REST API reference

Get support
GET/v1/facilities/{facility_id}/move-outs/settlements
Completed move-outs whose ledger still holds a balance and that staff have not kept on account, oldest first, each with its credit split and the method `payments.refund_policy` preselects.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request GET \
  --url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/move-outs/settlements' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Try a request

Staging · read-only

Explore your organization with a read-only request to staging.

Kept in this tab only. Sent directly to api.staging.facily.ai.

GET

Replace the {placeholders} in the path with your resource IDs.

Response
Your response will appear here.

Parameters

facility_idpath · string | stringrequired

Format: uuid

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "balance": "<VALUE_MATCHING_PATTERN>",
      "credit_before_cutover": "<VALUE_MATCHING_PATTERN>",
      "credit_in_flight": "<VALUE_MATCHING_PATTERN>",
      "credit_since_go_live": "<VALUE_MATCHING_PATTERN>",
      "facility_id": "00000000-0000-4000-8000-000000000001",
      "lease_id": "00000000-0000-4000-8000-000000000001",
      "lease_number": "string",
      "move_out_date": "2026-10-29",
      "quote_id": "00000000-0000-4000-8000-000000000001",
      "tenant_id": "00000000-0000-4000-8000-000000000001",
      "unit_id": "00000000-0000-4000-8000-000000000001",
      "unit_number": "string"
    }
  ],
  "meta": {
    "request_id": "string"
  },
  "pagination": {
    "has_more": false,
    "limit": 0,
    "cursor": "string",
    "total_count": 0
  },
  "metrics": {
    "cards": {},
    "computed_at": "2026-10-29T12:00:00Z",
    "is_stale": false,
    "scope": "facility"
  }
}

application/json

dataMoveOutSettlementRowResponse[]required
Show data schema
balancestringrequired

Positive: owed. Negative: a credit.

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

credit_before_cutoverstringrequired

The rest of a credit; refundable only by check, confirmed.

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

credit_in_flightstringrequired

Refunds already promised against the credit (at the processor, or a card settlement not yet run), left out of the two figures above.

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

credit_since_go_livestringrequired

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

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

default_methodstring | null

What payments.refund_policy preselects for a credit; staff still choose.

Values: "card", "check", "keep"

Show default_method schema
string | null

What payments.refund_policy preselects for a credit; staff still choose.

Variant 1: string
string

Values: "card", "check", "keep"

Variant 2: null
null
facility_idstringrequired

Format: uuid

lease_idstringrequired

Format: uuid

lease_numberstringrequired
move_out_datestring | nullrequired

Format: date

Show move_out_date schema
string | null
Variant 1: string
string
Variant 2: null
null
quote_idstringrequired

Format: uuid

tenant_idstringrequired

Format: uuid

unit_idstringrequired

Format: uuid

unit_numberstringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
metricsEmbeddedMetrics | null
Show metrics schema
EmbeddedMetrics | null
Variant 1: EmbeddedMetrics
cardsobjectrequired
computed_atstring | nullrequired

Format: date-time

Show computed_at schema
string | null
Variant 1: string
string
Variant 2: null
null
is_stalebooleanrequired
scopestringrequired

Values: "facility", "portfolio"

Variant 2: null
null
paginationPaginationBlockrequired

Pagination metadata for list responses.

Show pagination schema
cursorstring | null
Show cursor schema
string | null
Variant 1: string
string
Variant 2: null
null
has_morebooleanrequired
limitintegerrequired
total_countinteger | null
Show total_count schema
integer | null
Variant 1: integer
integer
Variant 2: null
null
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

List Settlements | Facily Developers