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

List Facility Ar Aging

Reports · REST API reference

Get support
GET/v1/facilities/{facility_id}/ar-aging
One page of a facility's open balances, biggest debtor first by default -- or, with ``facility_id="all"``, of every non-deleted facility's, interleaved.

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>/ar-aging' \
  --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

cursorquery · string | null
limitquery · integer

Default: 50 · Minimum: 1 · Maximum: 200

sortquery · string

Default: "total_due" · Values: "total_due", "current", "days_30", "days_60", "days_90", "days_90_plus"

orderquery · string

Default: "desc" · Values: "asc", "desc"

Responses

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

200Successful Response
JSON · generated example
{
  "data": [
    {
      "balance_divergence": "<VALUE_MATCHING_PATTERN>",
      "current": "<VALUE_MATCHING_PATTERN>",
      "days_30": "<VALUE_MATCHING_PATTERN>",
      "days_60": "<VALUE_MATCHING_PATTERN>",
      "days_90": "<VALUE_MATCHING_PATTERN>",
      "days_90_plus": "<VALUE_MATCHING_PATTERN>",
      "facility_id": "00000000-0000-4000-8000-000000000001",
      "is_autopay": false,
      "tenant_id": "00000000-0000-4000-8000-000000000001",
      "total_due": "<VALUE_MATCHING_PATTERN>",
      "last_payment_at": "2026-10-29T12:00:00Z",
      "tenant": {
        "id": "00000000-0000-4000-8000-000000000001",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "tenant_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

dataArAgingRowResponse[]required
Show data schema
balance_divergencestringrequired

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

currentstringrequired

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

days_30stringrequired

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

days_60stringrequired

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

days_90stringrequired

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

days_90_plusstringrequired

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

facility_idstringrequired

Format: uuid

is_autopaybooleanrequired
last_payment_atstring | null

Format: date-time

Show last_payment_at schema
string | null
Variant 1: string
string
Variant 2: null
null
tenantArAgingTenantRef | null
Show tenant schema
ArAgingTenantRef | null
Variant 1: ArAgingTenantRef
emailstring | null
Show email schema
string | null
Variant 1: string
Variant 2: null
first_namestring | null
Show first_name schema
string | null
Variant 1: string
Variant 2: null
idstringrequired

Format: uuid

last_namestring | null
Show last_name schema
string | null
Variant 1: string
Variant 2: null
phonestring | null
Show phone schema
string | null
Variant 1: string
Variant 2: null
tenant_numberstring | null
Show tenant_number schema
string | null
Variant 1: string
Variant 2: null
Variant 2: null
null
tenant_idstringrequired

Format: uuid

total_duestringrequired

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

unitsstring[]
Show units schema
string
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 reports operations
Build something that works beautifully.

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

List Facility Ar Aging | Facily Developers