> This page is for API.
> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.spreadspace.app/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.spreadspace.app/_mcp/server.
# The Debt Schedule object
> The extracted debt schedule record: one row per obligation with balances, payments, and rates.
An extracted business debt schedule.
The retrieve endpoint returns this object on its own. The list endpoint
returns one per document, wrapped as
`{ "borrower_id": …, "schedules": [ { "extracted_document_id", "document_category", "report_data" } ] }`.
## Explore
[Retrieve a debt schedule](/api/api-reference/debt-schedules/get-debt-schedule)
GET`/api/borrowers/:borrower_id/extractions/:doc_id/debt-schedule`
[List all debt schedules](/api/api-reference/debt-schedules/get-debt-schedules)
GET`/api/borrowers/:borrower_id/extractions/debt-schedules`
`form_variant` is `sba_2202` or `freeform` and decides which keys the schedule
and its rows carry. `debt_schedule` carries one row per creditor in print
order, and `applicant` and `as_of_date` say who the schedule is for and its
stated date.
The documents behind this object carry `document_category` `debt_schedule` or `sba_2202`. Money keys are JSON strings with exactly two decimals (`"9200000.00"`, `"-1250.50"`). Date keys are as printed on the document unless a key's Type column states a format.
`form_variant` says which shape follows. Each shape's fields are listed under its own heading.
## SBA Form 2202
SBA Form 2202, Schedule of Liabilities.
| Key | Type | Present when | Description |
| ------------------- | ----------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `document_type` | always `debt_schedule` | Always | Which family of document this is. |
| `form_variant` | always `sba_2202` | Always | Always sba_2202. |
| `form_revision` | string, nullable | When the document states it | The form revision printed in the footer. |
| `applicant` | string, nullable | Always | Name of the applicant. |
| `as_of_date` | string (as printed), nullable | Always | Date of the schedule: `YYYY-MM-DD`, `YYYY-MM` or `YYYY` when the printed date reads as one, else the text as printed. |
| `debt_schedule` | array of objects | Always | One entry per liability row. |
| `computed_totals` | object | Always | The liability rows added together, column by column. |
| `signature_present` | boolean | When the document states it | True when the signature line is signed. |
| `signer_title` | string, nullable | When the document states it | The signer's title. |
| `status` | string | Always | Always `EXTRACTED` on a schedule the API returns. |
| `signals` | array of DebtScheduleSignal | When the document states it | Notes about the schedule's date and entity name. |
| `period_source` | string | When the document states it | Which part of the document dates the schedule when its printed heading states no date: the page image (`page_image`), the file's name (`filename`) or the file's own creation date (`file_metadata`); absent when the heading dates the schedule. |
| `entity_source` | string | When the document states it | What names the applicant when the form does not: the page image (`page_image`); absent when the form names the applicant. |
### `debt_schedule[]`
One row of the Schedule of Liabilities.
| Key | Type | Present when | Description |
| ----------------------- | ---------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `creditor_name` | string, nullable | Always | Name of creditor. |
| `original_amount` | string (money), nullable | Always | Original amount. |
| `original_date` | string (YYYY-MM-DD, YYYY-MM or YYYY), nullable | Always | Original date. |
| `current_balance` | string (money), nullable | Always | Current balance. |
| `current_or_delinquent` | string, nullable | Always | Current or delinquent, as printed. |
| `maturity_date` | string (as printed), nullable | Always | Maturity date: `YYYY-MM-DD`, `YYYY-MM` or `YYYY` when the cell reads as a date; the cell's text as printed when it states a term instead, such as revolving or on demand. |
| `payment_amount` | string, nullable | Always | Payment amount; null when the cell prints a term rather than a figure. |
| `how_secured` | string, nullable | Always | How secured or endorsed, and the type of collateral. |
### `computed_totals`
The liability rows added together, column by column.
| Key | Type | Present when | Description |
| --------------------- | ------------------------ | ------------ | -------------------------------- |
| `original_amount_sum` | string (money), nullable | Always | Original amounts added together. |
| `current_balance_sum` | string (money), nullable | Always | Current balances added together. |
| `payment_amount_sum` | string (money), nullable | Always | Payment amounts added together. |
## Filer's own columns
A debt schedule in the filer's own columns.
| Key | Type | Present when | Description |
| ----------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `document_type` | always `debt_schedule` | Always | Which family of document this is. |
| `form_variant` | always `freeform` | Always | Always freeform. |
| `applicant` | string, nullable | Always | The borrower's name from the schedule's title. |
| `as_of_date` | string (as printed), nullable | Always | The schedule's date, when it prints one: `YYYY-MM-DD` when the schedule states a full date, else the month and year as printed. |
| `columns` | array of string | Always | The printed column headers in order. |
| `creditor_column` | string, nullable | Always | Which printed column names the creditor. |
| `balance_column` | string, nullable | Always | Which printed column holds the outstanding balance. |
| `total_balance` | string (money), nullable | Always | Total outstanding balance across the rows. |
| `printed_total_balance` | string | When the document states it | The total balance line as printed, when the schedule prints one. |
| `reporting_unit` | string, nullable | When the document states it | The unit the schedule's figures were printed in, such as ones, thousands or millions; the figures on the wire are already whole dollars. |
| `scale_multiplier` | integer, nullable | When the document states it | Scale applied to the printed figures: 1 for whole dollars, 1000 when the schedule was printed in thousands, 1000000 when it was printed in millions. |
| `debt_schedule` | array of objects | Always | One entry per printed row. |
| `status` | string | Always | Always `EXTRACTED` on a schedule the API returns. |
| `signals` | array of DebtScheduleSignal | Always | Notes about the schedule's date and entity name. |
| `column_roles` | array of objects | When the document states it | What each printed column holds, in column order. |
| `rate_display` | map of string | When the document states it | Interest rate cells with a percent sign, keyed by row and column position. |
| `converted_layout` | object | When the document states it | How the printed columns relate to the standard debt fields. |
| `period_source` | string | When the document states it | Which part of the document dates the schedule when its printed heading states no date: the page image (`page_image`), the file's name (`filename`) or the file's own creation date (`file_metadata`); absent when the heading dates the schedule. |
| `entity_source` | string | When the document states it | What names the borrower when the schedule's title does not: the page image (`page_image`); absent when the title names the borrower. |
| `entity_source_sheet` | string | On a spreadsheet upload whose own sheet does not name the borrower, when the workbook names exactly one company; absent otherwise. | The sheet of the uploaded workbook that names the borrower, when the schedule's own sheet does not and the workbook names exactly one company; absent otherwise. |
### `debt_schedule[]`
One printed row of a free-form schedule.
| Key | Type | Present when | Description |
| ------------------- | ----------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------ |
| `cells` | map of string, nullable | Always | Every printed cell, keyed by column header. An account number is masked to its last four digits. |
| `creditor_name` | string, nullable | Always | The creditor, from the creditor column. |
| `current_balance` | string (money), nullable | Always | The outstanding balance, from the balance column. |
| `is_total` | boolean | Always | True when the row is a printed total. |
| `original_amount` | string, nullable | When the document states it | Original loan amount as printed, when a column carries it. |
| `original_date` | string (as printed), nullable | When the document states it | Original loan date as printed, when a column carries it. |
| `interest_rate` | string, nullable | When the document states it | Interest rate as printed, when a column carries it. |
| `maturity_date` | string (as printed), nullable | When the document states it | Maturity date as printed, when a column carries it. |
| `payment_amount` | string, nullable | When the document states it | Payment amount as printed, when a column carries it. |
| `payment_frequency` | string, nullable | When the document states it | Payment frequency as printed, when a column carries it. |
| `how_secured` | string, nullable | When the document states it | Collateral or security as printed, when a column carries it. |
| `loan_status` | string, nullable | When the document states it | Loan status as printed, when a column carries it. |
### `column_roles[]`
What a printed column holds.
| Key | Type | Present when | Description |
| --------- | ------- | ------------ | ----------------------------------------------------------------------------- |
| `money` | boolean | Always | True when the column holds dollar figures. |
| `rate` | boolean | Always | True when the column holds an interest rate. |
| `compact` | boolean | Always | True when the column holds dollar figures other than a rate or an identifier. |
### `converted_layout`
How the printed columns relate to the standard debt fields.
| Key | Type | Present when | Description |
| -------------- | ---------------- | ------------ | ---------------------------------------------------------------------------- |
| `convert` | boolean | Always | True when at least two standard fields have no printed column of their own. |
| `money_roles` | array of string | Always | The standard money fields the rows carry. |
| `cell_columns` | array of integer | Always | Positions of the printed money columns that do not restate a standard field. |
## Shared objects
Object types that several keys above carry. The Type column names them.
### DebtScheduleSignal
A note about the schedule's date or entity name.
| Key | Type | Present when | Description |
| ---------- | ----------------------------- | ------------ | ----------------------------------------------- |
| `severity` | string, one of `info`, `warn` | Always | How much weight the note carries: info or warn. |
| `code` | string | Always | The note's identifier. |
| `detail` | string | Always | The note in words. |