Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsGet Facility Delinquency
Search the full API reference Esc to close

Get Facility Delinquency

Billing · REST API reference

Get support
GET/v1/facilities/{facility_id}/delinquency
The Collections KPI tiles for one facility -- or, with `all`, every facility's stored blocks summed (design 12.1: the pill counts read `by_stage`, and the page is scoped by the sidebar's facility selector, which offers `all`).

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>/delinquency' \
  --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": {
    "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 | nullrequired
Show data schema
DelinquencyDashboardResponse | null
Variant 1: DelinquencyDashboardResponse
by_stageDelinquencyStageSummary[]required

Per-state breakdown of the open cases.

Show by_stage schema
countintegerrequired

Open cases currently in this state.

stagestringrequired

The delinquency state the cases are in, for example delinquent or locked_out.

total_balancestringrequired

Sum of those cases' outstanding balances, credits floored at zero.

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

computed_atstring | null

When the metrics refresh produced these figures.

Format: date-time

Show computed_at schema
string | null

When the metrics refresh produced these figures.

Variant 1: string
string
Variant 2: null
null
cured_30dintegerrequired

Cases closed as cured in the last 30 days.

facility_idstring | stringrequired

The facility these tiles describe.

Format: uuid

Show facility_id schema
string | string

The facility these tiles describe.

Variant 1: string
string
Variant 2: string
string
is_stalebooleanrequired

True when the snapshot is older than the embedded-metrics staleness window.

opened_30dintegerrequired

Cases opened in the last 30 days.

recovery_rate_30dstringrequired

cured_30d / opened_30d to four places; zero when none opened.

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

total_ar_delinquentstringrequired

Total outstanding balance across those cases.

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

total_delinquentintegerrequired

Open delinquency cases.

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 billing operations
Build something that works beautifully.

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

Get Facility Delinquency | Facily Developers