/v1/facilities/{facility_id}/delinquencyAuthentication
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>/delinquency' \
--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
Responses
Expand a status to inspect its schema. Generated examples show structure and synthetic values.
200Successful Response
{
"data": {
"by_stage": [
{
"count": 0,
"stage": "string",
"total_balance": "<VALUE_MATCHING_PATTERN>"
}
],
"cured_30d": 0,
"facility_id": "00000000-0000-4000-8000-000000000001",
"is_stale": false,
"opened_30d": 0,
"recovery_rate_30d": "<VALUE_MATCHING_PATTERN>",
"total_ar_delinquent": "<VALUE_MATCHING_PATTERN>",
"total_delinquent": 0,
"computed_at": "2026-10-29T12:00:00Z"
},
"meta": {
"request_id": "string"
}
}application/json
dataDelinquencyDashboardResponse | nullrequiredShow data schema
DelinquencyDashboardResponse | nullVariant 1: DelinquencyDashboardResponse
by_stageDelinquencyStageSummary[]requiredPer-state breakdown of the open cases.
Show by_stage schema
countintegerrequiredOpen cases currently in this state.
stagestringrequiredThe delinquency state the cases are in, for example delinquent or locked_out.
total_balancestringrequiredSum of those cases' outstanding balances, credits floored at zero.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
computed_atstring | nullWhen the metrics refresh produced these figures.
Format: date-time
Show computed_at schema
string | nullWhen the metrics refresh produced these figures.
Variant 1: string
stringVariant 2: null
nullcured_30dintegerrequiredCases closed as cured in the last 30 days.
facility_idstring | stringrequiredThe facility these tiles describe.
Format: uuid
Show facility_id schema
string | stringThe facility these tiles describe.
Variant 1: string
stringVariant 2: string
stringis_stalebooleanrequiredTrue when the snapshot is older than the embedded-metrics staleness window.
opened_30dintegerrequiredCases opened in the last 30 days.
recovery_rate_30dstringrequiredcured_30d / opened_30d to four places; zero when none opened.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_ar_delinquentstringrequiredTotal outstanding balance across those cases.
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_delinquentintegerrequiredOpen delinquency cases.
Variant 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