Skip to navigation

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

KeyTypePresent whenDescription
categorystringAlwaysThe note family the table belongs to, such as debt or lease.
supportsstring, one of asset, liability, equity, balance_sheet, income_statement, cash_flowAlwaysThe balance sheet side, or the statement, the table supports.
shapestringAlwaysThe table’s layout, such as maturity_schedule or debt_composition.
subjectstringWhen the document states itWhat the table is about, read off its caption and rows, such as regulatory_capital.
statusstring, one of RECONCILED, FLAGGED, PRINTEDAlwaysRECONCILED when every check the table allows holds, FLAGGED when one does not, PRINTED when the table allows no check.
signalsarray of objectsWhen the document states itEach check of the table that does not hold, in words, when any does not.
entitystring, nullableWhen the document states itThe reporting entity’s name as printed, when the page prints one.
titlestring, nullableWhen the document states itThe table’s caption or note heading as printed.
headingstring, nullableWhen the document states itThe note heading printed over the table.
captionstring, nullableWhen the document states itThe sentence printed over the table that introduces it.
periodstring, nullableOn 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.
periodsarray of objectsOn 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_ofstring (YYYY-MM-DD), nullableOn a table printed as lines under its heads; absent on a debt table.The as-of date the table states.
as_of_printedstring, nullableOn a table printed as lines under its heads; absent on a debt table.The as-of date as printed.
as_of_datestring (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_headstring, nullableOn 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.
columnsone of: integer; array of string; array of objectsAlwaysThe 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_kindsarray of stringOn 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_headsarray of SupportingTableHeadOn 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.
classesarray of SupportingTableHeadOn a table printed as lines under its heads; absent on a debt table.The classes printed over the figure columns, in order.
plan_groupsarray of SupportingTableHeadOn a table printed as lines under its heads; absent on a debt table.The bands printed over runs of columns, in order.
linesarray of objectsOn 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.
applicantstring, nullableOn a debt table; absent otherwise.The reporting entity’s name as printed over the debt table, when the page prints one.
label_termsarray of stringOn a debt table; absent otherwise.Which of interest_rate and maturity_date the rows state in their labels.
creditor_columnstringOn a debt table; absent otherwise.The head of the column that names each debt.
balance_columnstringOn a debt table; absent otherwise.The head of the column that holds the balances.
balance_column_indexintegerOn a debt table; absent otherwise.Position of the balance column in columns, counting from zero.
total_balancestring (money), nullableOn a debt table; absent otherwise.The balance column’s total.
printed_total_balancestring (money), nullableOn a debt table; absent otherwise.The total the table prints under the balance column.
debt_schedulearray of objectsOn a debt table; absent otherwise.The debt table’s printed rows in order, captions and totals included.
directionstring, one of receivable_from, payable_toOn 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_counterpartystring, nullableOn a debt table; absent otherwise.The related party the table is with, when it names one.
footnotesarray of objectsWhen the document states itThe footnotes printed under the table, in page order.
cpa_engagementintegerOn 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_labelstringOn a statement extracted with its assurance level and presentation read; absent on an older extraction.The assurance level in words.
presentationstring, one of formal, free_formOn 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_unitstring, one of ones, thousands, millions, billionsAlwaysThe unit the figures are printed in, such as ones or thousands.
scale_multiplierintegerAlwaysScale of the printed figures: 1 for whole dollars, 1000 when the table is stated in thousands, 1000000 when it is stated in millions.
billing_yearsintegerWhen the document states itYears of data billed for the table.
packetobjectWhen the document states itWhere 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.

KeyTypePresent whenDescription
severitystring, one of info, warnAlwaysHow much weight the note carries: info or warn.
codestring, 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_stampAlwaysThe note’s identifier.
detailstringAlwaysThe note in words.

periods[]

One figure column as a period.

KeyTypePresent whenDescription
labelstring, nullableAlwaysThe column heading as printed.
coveragestring, nullableWhen the document states itThe span the column covers as printed, when the table prints one.
startstring (YYYY-MM-DD), nullableWhen the document states itFirst day of the period the column covers, when it can be dated.
endstring (YYYY-MM-DD), nullableWhen the document states itLast day of the period the column covers, or the date the column is as of, when it can be dated.
kindstring, nullableWhen the document states itWhat the column’s date is, such as a period or an as-of date, when it is dated.
as_ofstring (as printed), nullableWhen the document states itThe date the column is as of, as a YYYY-MM-DD date or as printed.
as_of_printedstring, nullableWhen the document states itThe date the column is as of, as printed.

columns[]

One figure column’s printed head.

KeyTypePresent whenDescription
labelstring, nullableAlwaysThe column heading as printed.
kindstring, nullableWhen the document states itWhat the column holds, such as money, count, per_share, price, percent or text.
groupstring or integer, nullableWhen the document states itThe band printed over a run of columns: its position in plan_groups or its own wording.
coveragestring, nullableWhen the document states itThe span the column covers as printed, when the head prints one.
startstring (YYYY-MM-DD), nullableWhen the document states itFirst day of the period the column covers, when it can be dated.
endstring (YYYY-MM-DD), nullableWhen the document states itLast day of the period the column covers, when it can be dated.
unitstringWhen the document states itThe unit the column is stated in when it differs from the table’s.
head_marksarray of stringWhen the document states itThe footnote marks the head wears.

lines[]

One printed row.

KeyTypePresent whenDescription
labelstringAlwaysThe row’s caption as printed.
kindstringAlwaysThe row’s kind, such as item, caption or total.
valuesarray of string or nullAlwaysThe 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.
printedarray of string, one of money, dash, blank, textAlwaysHow each cell is printed, per column: money, dash for a printed dash, blank for an empty cell, text for words.
indentintegerWhen the document states itHow far the row is indented under its caption.
levelintegerWhen the document states itThe row’s depth under its caption.
yearinteger, nullableWhen the document states itThe year a maturity row is for.
percentarray of booleanWhen the document states itPer column, whether the row’s figure is a percent.
cell_kindsarray of stringWhen the document states itPer column, the kind of each cell when it differs from its column, such as money, count, per_share, percent, price or text.
label_marksarray of stringWhen the document states itThe footnote marks the row’s label wears.

debt_schedule[]

One printed row of a debt table.

KeyTypePresent whenDescription
cellsarray of string or nullAlwaysThe row’s cells in column order as printed, the label first.
is_totalbooleanAlwaysTrue when the row is a printed total.
creditor_namestring, nullableAlwaysThe debt the row names, on a debt or a total row; null on a caption or an adjustment.
current_balancestring (money), nullableAlwaysThe balance from the balance column, on a debt or a total row; null on a caption, an adjustment or a blank cell.
interest_ratestring, nullableWhen the document states itInterest rate as printed, when a column or the row’s label carries it.
maturity_datestring (as printed), nullableWhen the document states itMaturity as printed, when a column or the row’s label carries it.
payment_amountstring, nullableWhen the document states itPayment amount as printed, when a column carries it.
payment_frequencystring, nullableWhen the document states itPayment frequency as printed, when a column carries it.
original_amountstring, nullableWhen the document states itOriginal amount as printed, when a column carries it.
how_securedstring, nullableWhen the document states itCollateral or security as printed, when a column carries it.
cell_marksarray of array of string or nullWhen the document states itThe footnote marks each cell wears, in column order; null where a cell wears none.

footnotes[]

One footnote printed under the table.

KeyTypePresent whenDescription
markstringAlwaysThe footnote’s mark as printed, such as 1 or a.
textstringAlwaysThe footnote in words.

packet

Where the table sat in the financial statement packet it arrived in, when it arrived in one.

KeyTypePresent whenDescription
section_indexintegerAlwaysPosition of the statement among the packet’s statements, counting from zero.
pagesarray of integerAlwaysFirst and last page of the statement within the packet, counting from one.
letter_datestring (YYYY-MM-DD), nullableAlwaysDate of the accountant’s letter that accompanied the packet, when the letter printed one.
letter_pageinteger, nullableAlwaysPage of the packet the accountant’s letter is on, when the packet carries one.
page_listarray of integerOn 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.

KeyTypePresent whenDescription
labelstring, nullableAlwaysThe head as printed.
kindstring, nullableWhen the document states itWhat the head names, when it names one.