The Supporting Table object
An extracted table printed in the notes to the financial statements.
The retrieve endpoint returns this object on its own. The list endpoint
returns one per document, wrapped as
{ "borrower_id": …, "tables": [ { "extracted_document_id", "document_category", "report_data" } ] }.
A table printed as lines carries them under lines, one figure and one
print mark per column, with its heads in columns, periods or
classes; a debt table carries its rows under debt_schedule with
their printed heads in columns. category, supports and shape say
which note the table belongs to, which side or statement it supports and
how it is laid out. status and signals say whether the table adds
up.
The documents behind this object carry document_category supporting_table, support_table or supporting-table. 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.
Fields
| Key | Type | Present when | Description |
|---|---|---|---|
category | string | Always | The note family the table belongs to, such as debt or lease. |
supports | string, one of asset, liability, equity, balance_sheet, income_statement, cash_flow | Always | The balance sheet side, or the statement, the table supports. |
shape | string | Always | The table’s layout, such as maturity_schedule or debt_composition. |
subject | string | When the document states it | What the table is about, read off its caption and rows, such as regulatory_capital. |
status | string, one of RECONCILED, FLAGGED, PRINTED | Always | RECONCILED when every check the table allows holds, FLAGGED when one does not, PRINTED when the table allows no check. |
signals | array of objects | When the document states it | Each check of the table that does not hold, in words, when any does not. |
entity | string, nullable | When the document states it | The reporting entity’s name as printed, when the page prints one. |
title | string, nullable | When the document states it | The table’s caption or note heading as printed. |
heading | string, nullable | When the document states it | The note heading printed over the table. |
caption | string, nullable | When the document states it | The sentence printed over the table that introduces it. |
period | string, nullable | On a table printed as lines under its heads; absent on a debt table. | The period wording printed over the table, such as the years ended, when it prints one. |
periods | array of objects | On a table printed as lines under its heads; absent on a debt table. | The table’s figure columns as periods, one entry per column. |
as_of | string (YYYY-MM-DD), nullable | On a table printed as lines under its heads; absent on a debt table. | The as-of date the table states. |
as_of_printed | string, nullable | On a table printed as lines under its heads; absent on a debt table. | The as-of date as printed. |
as_of_date | string (as printed) | On a debt table; absent otherwise. | The as-of date of a debt table, as a YYYY-MM-DD date or as printed. |
label_head | string, nullable | On a table printed as lines under its heads; absent on a debt table. | The printed head of the label column, when the table prints one. |
columns | one of: integer; array of string; array of objects | Always | The figure columns: a count when the table heads them by period alone, the printed heads as objects, or on a debt table the printed heads as text with the label column first. |
column_kinds | array of string | On a table printed as lines under its heads; absent on a debt table. | What each column holds, in columns order, such as label, money, rate, year or text. |
column_heads | array of SupportingTableHead | On a table printed as lines under its heads; absent on a debt table. | The heads printed over the figure columns, in order, when the table heads them apart from columns. |
classes | array of SupportingTableHead | On a table printed as lines under its heads; absent on a debt table. | The classes printed over the figure columns, in order. |
plan_groups | array of SupportingTableHead | On a table printed as lines under its heads; absent on a debt table. | The bands printed over runs of columns, in order. |
lines | array of objects | On a table printed as lines under its heads; absent on a debt table. | The table’s printed rows in order, each with one figure and one print mark per column. |
applicant | string, nullable | On a debt table; absent otherwise. | The reporting entity’s name as printed over the debt table, when the page prints one. |
label_terms | array of string | On a debt table; absent otherwise. | Which of interest_rate and maturity_date the rows state in their labels. |
creditor_column | string | On a debt table; absent otherwise. | The head of the column that names each debt. |
balance_column | string | On a debt table; absent otherwise. | The head of the column that holds the balances. |
balance_column_index | integer | On a debt table; absent otherwise. | Position of the balance column in columns, counting from zero. |
total_balance | string (money), nullable | On a debt table; absent otherwise. | The balance column’s total. |
printed_total_balance | string (money), nullable | On a debt table; absent otherwise. | The total the table prints under the balance column. |
debt_schedule | array of objects | On a debt table; absent otherwise. | The debt table’s printed rows in order, captions and totals included. |
direction | string, one of receivable_from, payable_to | On a debt table; absent otherwise. | On a related-party table, whether the balances are owed to the company (receivable_from) or by it (payable_to). |
consolidated_counterparty | string, nullable | On a debt table; absent otherwise. | The related party the table is with, when it names one. |
footnotes | array of objects | When the document states it | The footnotes printed under the table, in page order. |
cpa_engagement | integer | On a statement extracted with its assurance level and presentation read; absent on an older extraction. | The accountant’s level of assurance: 0 unaudited, 1 compiled, 2 reviewed, 3 audited. |
cpa_engagement_label | string | On a statement extracted with its assurance level and presentation read; absent on an older extraction. | The assurance level in words. |
presentation | string, one of formal, free_form | On a statement extracted with its assurance level and presentation read; absent on an older extraction. | How the statement is presented: formal when it is presented as issued financial statements; free_form when it is a report out of the books (accounting software or a spreadsheet). |
reporting_unit | string, one of ones, thousands, millions, billions | Always | The unit the figures are printed in, such as ones or thousands. |
scale_multiplier | integer | Always | Scale of the printed figures: 1 for whole dollars, 1000 when the table is stated in thousands, 1000000 when it is stated in millions. |
billing_years | integer | When the document states it | Years of data billed for the table. |
packet | object | When the document states it | Where the table sat in the financial statement packet it arrived in, when it arrived in one. |
signals[]
A check of the table that does not hold, or a note about its reporting period.
| Key | Type | Present when | Description |
|---|---|---|---|
severity | string, one of info, warn | Always | How much weight the note carries: info or warn. |
code | string, one of coverage_unreadable, debt_maturity_class_total_mismatch, debt_maturity_total_mismatch, debt_total_mismatch, eps_quotient_mismatch, interest_other_total_mismatch, lease_class_total_mismatch, lease_payments_total_mismatch, lease_present_value_mismatch, lease_split_mismatch, no_reporting_period, notes_cross_foot_mismatch, notes_cross_table_mismatch, notes_percent_mismatch, notes_rollforward_mismatch, notes_total_mismatch, year_from_file_metadata, year_from_filename, year_from_page_image, year_matches_print_stamp | Always | The note’s identifier. |
detail | string | Always | The note in words. |
periods[]
One figure column as a period.
| Key | Type | Present when | Description |
|---|---|---|---|
label | string, nullable | Always | The column heading as printed. |
coverage | string, nullable | When the document states it | The span the column covers as printed, when the table prints one. |
start | string (YYYY-MM-DD), nullable | When the document states it | First day of the period the column covers, when it can be dated. |
end | string (YYYY-MM-DD), nullable | When the document states it | Last day of the period the column covers, or the date the column is as of, when it can be dated. |
kind | string, nullable | When the document states it | What the column’s date is, such as a period or an as-of date, when it is dated. |
as_of | string (as printed), nullable | When the document states it | The date the column is as of, as a YYYY-MM-DD date or as printed. |
as_of_printed | string, nullable | When the document states it | The date the column is as of, as printed. |
columns[]
One figure column’s printed head.
| Key | Type | Present when | Description |
|---|---|---|---|
label | string, nullable | Always | The column heading as printed. |
kind | string, nullable | When the document states it | What the column holds, such as money, count, per_share, price, percent or text. |
group | string or integer, nullable | When the document states it | The band printed over a run of columns: its position in plan_groups or its own wording. |
coverage | string, nullable | When the document states it | The span the column covers as printed, when the head prints one. |
start | string (YYYY-MM-DD), nullable | When the document states it | First day of the period the column covers, when it can be dated. |
end | string (YYYY-MM-DD), nullable | When the document states it | Last day of the period the column covers, when it can be dated. |
unit | string | When the document states it | The unit the column is stated in when it differs from the table’s. |
head_marks | array of string | When the document states it | The footnote marks the head wears. |
lines[]
One printed row.
| Key | Type | Present when | Description |
|---|---|---|---|
label | string | Always | The row’s caption as printed. |
kind | string | Always | The row’s kind, such as item, caption or total. |
values | array of string or null | Always | The row’s figure per column as printed and scaled by the reporting unit, a percent, count or per-share figure as printed, text where the cell prints words; null where the cell is blank. |
printed | array of string, one of money, dash, blank, text | Always | How each cell is printed, per column: money, dash for a printed dash, blank for an empty cell, text for words. |
indent | integer | When the document states it | How far the row is indented under its caption. |
level | integer | When the document states it | The row’s depth under its caption. |
year | integer, nullable | When the document states it | The year a maturity row is for. |
percent | array of boolean | When the document states it | Per column, whether the row’s figure is a percent. |
cell_kinds | array of string | When the document states it | Per column, the kind of each cell when it differs from its column, such as money, count, per_share, percent, price or text. |
label_marks | array of string | When the document states it | The footnote marks the row’s label wears. |
debt_schedule[]
One printed row of a debt table.
| Key | Type | Present when | Description |
|---|---|---|---|
cells | array of string or null | Always | The row’s cells in column order as printed, the label first. |
is_total | boolean | Always | True when the row is a printed total. |
creditor_name | string, nullable | Always | The debt the row names, on a debt or a total row; null on a caption or an adjustment. |
current_balance | string (money), nullable | Always | The balance from the balance column, on a debt or a total row; null on a caption, an adjustment or a blank cell. |
interest_rate | string, nullable | When the document states it | Interest rate as printed, when a column or the row’s label carries it. |
maturity_date | string (as printed), nullable | When the document states it | Maturity as printed, when a column or the row’s label 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. |
original_amount | string, nullable | When the document states it | Original amount 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. |
cell_marks | array of array of string or null | When the document states it | The footnote marks each cell wears, in column order; null where a cell wears none. |
footnotes[]
One footnote printed under the table.
| Key | Type | Present when | Description |
|---|---|---|---|
mark | string | Always | The footnote’s mark as printed, such as 1 or a. |
text | string | Always | The footnote in words. |
packet
Where the table sat in the financial statement packet it arrived in, when it arrived in one.
| Key | Type | Present when | Description |
|---|---|---|---|
section_index | integer | Always | Position of the statement among the packet’s statements, counting from zero. |
pages | array of integer | Always | First and last page of the statement within the packet, counting from one. |
letter_date | string (YYYY-MM-DD), nullable | Always | Date of the accountant’s letter that accompanied the packet, when the letter printed one. |
letter_page | integer, nullable | Always | Page of the packet the accountant’s letter is on, when the packet carries one. |
page_list | array of integer | On a statement whose pages in the packet are not one unbroken run; absent otherwise. | Every page of the packet the statement is printed on, counting from one, when they are not one unbroken run; absent otherwise. |
Shared objects
Object types that several keys above carry. The Type column names them.
SupportingTableHead
One head printed over the figure columns.
| Key | Type | Present when | Description |
|---|---|---|---|
label | string, nullable | Always | The head as printed. |
kind | string, nullable | When the document states it | What the head names, when it names one. |