Skip to navigation
APICash Flow Statements

Retrieve a cash flow statement

Retrieves a single extracted cash flow statement. Requesting a document of any other type returns a 404.

Requires the extractions:read scope. Rate limit: 200 requests per minute per key (the api lane).

Authentication

AuthorizationBearer

Bearer token. Use ss_live_… for live data or ss_test_… for the sandbox (test mode). See Authentication.

Path parameters

borrower_idstringRequired
The borrower's id.
doc_idstringRequired
The document's id.

Headers

SpreadSpace-VersionstringOptionalformat: "^\d{4}-\d{2}-\d{2}$"

Pin the API version, e.g. 2026-10-07. Omit to get the latest. See Versioning.

Response headers

X-Request-IDstringOptional
Correlation ID for this request. Quote it in support tickets.
SpreadSpace-VersionstringOptional

The API surface version the server resolved for this request. Always present, regardless of whether the client supplied the request-side SpreadSpace-Version header. Default: 2026-10-07.

RateLimit-Limitinteger

Request budget of the endpoint’s rate-limit policy per 60-second sliding window. See Rate limits.

RateLimit-Remaininginteger

Requests left in the current window. Suppressed on 429 responses produced outside the rate limiter (for example a usage throttle), where a remaining budget would be misleading.

RateLimit-Resetinteger

Seconds until a guaranteed-fresh window.

RateLimit-PolicystringOptional

The active policy in limit;w=window-seconds form.

Response

OK
entitystring or null
The reporting entity's name as printed.
titlestring or null
The statement's printed title.
cpa_engagementinteger0-3

The accountant’s level of assurance: 0 unaudited, 1 compiled, 2 reviewed, 3 audited.

cpa_engagement_labelstring
The assurance level in words.
periodslist of objects
The statement's figure columns, one entry per column.
billing_yearsinteger

Years of data billed: the distinct years among columns that print a non-zero figure; 0 when no column prints one (such a document is not billed).

reporting_unitstring or null
The unit the figures are printed in, such as ones or thousands.
scale_multiplierinteger or null

Scale of the printed figures: 1 for whole dollars, 1000 when the statement is stated in thousands, 1000000 when it is stated in millions.

operatinglist of objects
The operating activities lines.
investinglist of objects
The investing activities lines.
financinglist of objects
The financing activities lines.
operating_subtotalobject or null
Net cash from operating activities, as printed.
investing_subtotalobject or null
Net cash from investing activities, as printed.
financing_subtotalobject or null
Net cash from financing activities, as printed.
adjustments_subtotalobject or null
Total adjustments to reconcile net income, when printed.
beginning_cashobject or null
Cash at the beginning of the period.
ending_cashobject or null
Cash at the end of the period.
net_changeobject or null
Net change in cash.
fxobject or null
Effect of exchange rate changes on cash, when printed.
discontinued_operationsobject or null
Cash flows of discontinued operations, when printed.
supplementallist of objects
Supplemental disclosures such as cash paid for interest and for income taxes.
entity_sourcestringOptional

What names the entity when the statement’s own page does not: the page image (page_image), the filing’s cover page (filing_cover), or the opening pages of the financial statement packet the statement arrived in (packet_text); absent when the statement’s own page names it.

entity_source_sheetstringOptional

The sheet of the uploaded workbook that names the company, when this statement’s own sheet does not and the workbook names exactly one company; absent otherwise.

presentationenumOptional

How the statement is presented: formal when it is presented as issued financial statements (a CPA engagement stated, a reference to the notes to the financial statements, a per-share block, the supplemental cash flow disclosures, the preparation legend that no assurance is provided, a plural statement title such as balance sheets or statements of income, or a statement of changes in equity or plural statement titles in the packet it arrived in); free_form when it is a report out of the books (accounting software or a spreadsheet).

Allowed values:
billing_groupstringOptional

Present when one file carries several statements: an identifier shared by that file’s statements.

unit_exceptionslist of stringsOptional

The carve-outs the statement’s unit declaration lists, such as per share amounts, whose lines and columns keep their printed figures; empty when it lists none.

unit_sourceenumOptional

Where the statement states its unit: printed when the statement header, a column header or a heading line prints it; none when nothing is printed and the figures are whole dollars as printed.

Allowed values:
reconcilinglist of objectsOptional
The rows printed between the last section total and the net change in cash, such as a reclassification to held for sale or an intermediate net change, when the statement prints any.
discontinuedlist of objectsOptional
The cash flows of discontinued operations printed outside the three sections, one row each, when the statement prints any.
consolidatingbooleanOptional

True on a consolidating statement, whose columns are entities under one period; absent otherwise.

statusenumOptional

RECONCILED when the sections add up to the net change and beginning cash plus the net change equals ending cash in every period; FLAGGED otherwise.

Allowed values:
signalslist of objectsOptional
Notes about the statement's reporting period, when any.
period_sourcestringOptional

Which part of the document dates the periods when the column headers state no date: the date the statement was printed on (print_stamp), the page image (page_image), the file’s name (filename) or the file’s own creation date (file_metadata); absent when the column headers date the periods.

canonicalobjectOptional
The printed lines mapped onto standard line names.
packetobjectOptional
Where the statement sat in the financial statement packet it arrived in, when it arrived in one.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error