Borrower Settlements - Command by ClearGrid AI

Property	Value
Dataset code	`D15`
Section code	`S2` — Payments & Settlements
Endpoint path	`/exports/S2/D15`
Cursor field	`updated_at`
Page size	`1`–`1000` (default `500`)
Availability	Phase 1 — generally available
Pagination	Direct (constant page size)

Lender-approved settlement / promise-to-pay plans. The borrower proposes a settlement; once you approve it, the agreed schedule is tracked here. Broken installments cause the deal to return to active collections.

Fields

Field	Type	Description	Notes
`public_id`	string	Stable unique identifier for this settlement row. Use as the primary key for warehouse upserts.	Available as of v1.1
`status`	string	Settlement status.
`payment_type`	string	How the settlement is paid (e.g. lump sum, installments).
`hardship_reason`	string \| null	Borrower-stated reason for hardship.
`employment_status`	string \| null	Borrower-stated employment status.
`proposed_settlement_amount`	integer	Proposed settlement amount in minor units (fils/cents).
`down_payment`	integer	Up-front down payment in minor units.
`monthly_installment`	integer	Monthly installment amount in minor units.
`number_of_installments`	integer	Number of installments in the settlement schedule.
`principal_amount`	integer	Principal amount the settlement covers, in minor units.
`write_off_amount`	integer	Amount written off as part of the settlement, in minor units.
`start_date`	string \| null	Settlement start date (ISO-8601).
`end_date`	string \| null	Settlement end date (ISO-8601).
`paid_at`	string \| null	When the settlement was fully paid (ISO-8601).
`is_paid`	boolean	Whether the settlement is fully paid.
`is_active`	boolean	Whether the settlement is currently active.
`created_at`	string	Row creation timestamp (ISO-8601).
`updated_at`	string	Last-modified timestamp (ISO-8601).	Cursor field

Sample row

{
  "public_id": "b3d9f2a1-6c47-4e08-9a52-1f7c0d8b3e64",
  "status": "ACTIVE",
  "payment_type": "INSTALLMENTS",
  "hardship_reason": "REDUCED_INCOME",
  "employment_status": "EMPLOYED",
  "proposed_settlement_amount": 450000,
  "down_payment": 100000,
  "monthly_installment": 70000,
  "number_of_installments": 5,
  "principal_amount": 600000,
  "write_off_amount": 150000,
  "start_date": "2026-05-01T00:00:00.000Z",
  "end_date": "2026-09-30T00:00:00.000Z",
  "paid_at": null,
  "is_paid": false,
  "is_active": true,
  "created_at": "2026-04-25T11:30:18.770Z",
  "updated_at": "2026-05-20T08:45:02.300Z"
}

Pagination characteristics

This dataset is direct — filtered to your tenant by lender_id on the collection itself, so each page returns a constant number of rows until the last page.

Use cases

Settlement take-up rate analysis.
Write-off-amount aggregation.
Settlement → broken-promise conversion rate.

The schema is new and still maturing — the field set may grow in minor releases. Row counts are currently very low.