Skip to navigation

The Investment Income Statement object

An extracted net investment income table.

The retrieve endpoint returns this object on its own. The list endpoint returns one per document, wrapped as { "borrower_id": …, "statements": [ { "extracted_document_id", "document_category", "report_data" } ] }.

lines carries the table’s printed rows in order, each with one figure and one print mark per column, and gross_investment_income, investment_expenses and net_investment_income carry the headline rows the same way. status and signals say whether the table adds up.

The documents behind this object carry document_category investment_income_statement, net_investment_income, net_investment_income_statement, investment_income or investment-income-statement. Money keys are JSON strings with exactly two decimals ("9200000.00", "-1250.50"). Date keys are YYYY-MM-DD, as each key’s Type column shows.

Fields

KeyTypePresent whenDescription
entitystring, nullableAlwaysThe reporting entity’s name as printed, when the page prints one.
titlestring, nullableAlwaysThe table’s printed title.
periodstring, nullableAlwaysThe period wording printed over the table, such as the years ended, when it prints one.
periodsarray of objectsAlwaysThe table’s figure columns, one entry per column.
columnsintegerAlwaysNumber of figure columns.
linesarray of objectsAlwaysThe table’s printed lines from the first component through net investment income, in print order.
net_investment_incomearray of string (money) or nullAlwaysNet investment income per column.
investment_expensesarray of string (money) or null, nullableAlwaysInvestment expenses per column, as a negative figure; null in a column where the table prints none.
gross_investment_incomearray of string (money) or null, nullableAlwaysGross investment income per column; null when the table prints no gross investment income line.
net_investment_income_printedarray of string, one of money, dash, blankAlwaysHow each figure of net_investment_income is printed, per column: money, dash for a printed dash, blank for an empty cell.
investment_expenses_printedarray of string, one of money, dash, blankAlwaysHow the investment expenses are printed, per column: dash when every expense cell in the column prints a dash, blank when the column prints none, money otherwise.
gross_investment_income_printedarray of string, one of money, dash, blank, nullableAlwaysHow each figure of gross_investment_income is printed, per column; null when the table prints no gross investment income line.
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).
statusstring, one of RECONCILED, FLAGGEDAlwaysRECONCILED when the components less the investment expenses reach the printed net investment income and a printed gross investment income line equals the components above it, in every column; FLAGGED otherwise.
signalsarray of objectsWhen the document states itEach check of the table that does not hold, in words, when any does not.
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_yearsintegerAlwaysYears 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.

periods[]

One figure column.

KeyTypePresent whenDescription
labelstring, nullableAlwaysThe column heading as printed.
coveragestring, nullableAlwaysThe span the column covers as printed, such as a year ended date, when the table prints one.
startstring (YYYY-MM-DD), nullableAlwaysFirst day of the period the column covers, when it can be dated.
endstring (YYYY-MM-DD), nullableAlwaysLast day of the period the column covers, when it can be dated.

lines[]

One printed line.

KeyTypePresent whenDescription
labelstringAlwaysThe line’s caption as printed; empty on an unlabelled subtotal.
kindstring, one of component, expense, gross, net, subtotal, captionAlwayscomponent for an investment income component, expense for an investment expense, gross for gross investment income, net for net investment income, subtotal for a line that prints the running total of the lines above it, caption for a heading that prints no figures.
valuesarray of string (money) or nullAlwaysThe line’s figure per column; null where the cell is blank.
printedarray of string, one of money, dash, blankAlwaysHow each cell is printed, per column: money, dash for a printed dash, blank for an empty cell.

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, nii_gross_identity_mismatch, nii_net_identity_mismatch, no_reporting_period, year_from_file_metadata, year_from_filename, year_from_page_image, year_matches_print_stampAlwaysThe note’s identifier.
detailstringAlwaysThe note 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.