/v1/facilities/{facility_id}/ar-agingAuthentication
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 GET \
--url 'https://api.staging.facily.ai/v1/facilities/<FACILITY_ID>/ar-aging' \
--header "Authorization: Bearer $FACILY_API_KEY"Try a request
Staging · read-onlyExplore your organization with a read-only request to staging.
Parameters
facility_idpath · string | stringrequiredFormat: uuid
cursorquery · string | nulllimitquery · integerDefault: 50 · Minimum: 1 · Maximum: 200
sortquery · stringDefault: "total_due" · Values: "total_due", "current", "days_30", "days_60", "days_90", "days_90_plus"
orderquery · stringDefault: "desc" · Values: "asc", "desc"
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"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[]requiredShow data schema
balance_divergencestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
currentstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
days_30stringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
days_60stringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
days_90stringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
days_90_plusstringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
facility_idstringrequiredFormat: uuid
is_autopaybooleanrequiredlast_payment_atstring | nullFormat: date-time
Show last_payment_at schema
string | nullVariant 1: string
stringVariant 2: null
nulltenantArAgingTenantRef | nullShow tenant schema
ArAgingTenantRef | nullVariant 1: ArAgingTenantRef
emailstring | nullShow email schema
string | nullVariant 1: string
Variant 2: null
first_namestring | nullShow first_name schema
string | nullVariant 1: string
Variant 2: null
idstringrequiredFormat: uuid
last_namestring | nullShow last_name schema
string | nullVariant 1: string
Variant 2: null
phonestring | nullShow phone schema
string | nullVariant 1: string
Variant 2: null
tenant_numberstring | nullShow tenant_number schema
string | nullVariant 1: string
Variant 2: null
Variant 2: null
nulltenant_idstringrequiredFormat: uuid
total_duestringrequiredPattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
unitsstring[]Show units schema
stringmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequiredmetricsEmbeddedMetrics | nullShow metrics schema
EmbeddedMetrics | nullVariant 1: EmbeddedMetrics
cardsobjectrequiredcomputed_atstring | nullrequiredFormat: date-time
Show computed_at schema
string | nullVariant 1: string
stringVariant 2: null
nullis_stalebooleanrequiredscopestringrequiredValues: "facility", "portfolio"
Variant 2: null
nullpaginationPaginationBlockrequiredPagination metadata for list responses.
Show pagination schema
cursorstring | nullShow cursor schema
string | nullVariant 1: string
stringVariant 2: null
nullhas_morebooleanrequiredlimitintegerrequiredtotal_countinteger | nullShow total_count schema
integer | nullVariant 1: integer
integerVariant 2: null
null400Validation 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