Sample - Plaid API
POST/cashflow_report/get

Get Cashflow Report transaction data

Retrieves standardized transaction data associated with an Item. Use days_requested to select the date range and count with cursor to paginate through results in reverse chronological order. Data may not be immediately available; listen for the CASHFLOW_REPORT_READY webhook before fetching prepared data.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

7 body fields

Request parameters for retrieving paginated transaction data from an Item.

client_idstringoptional
Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.
access_tokenstringrequired
The access token associated with the Item for which data is being requested.
secretstringoptional
Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.
days_requestedintegerrequired
Number of days to retrieve transactions data for (1 to 730)
countintegeroptional
Number of transactions to fetch per call
Default:100
cursorstringoptional
The cursor value represents the last update requested. Pass in the empty string "" in the first call.
optionsobjectoptional
An optional object to be used with the request. If specified, `options` must not be `null`.

2 status codes
200Returns the Item's accounts, transactions in reverse chronological order, total transaction count, Item metadata, pagination fields including `next_cursor` and `has_more`, the last successful update time, and a `request_id`.
accountsarray<BusinessAccount>required
An array containing the `accounts` associated with the Item for which transactions are being returned. Each transaction can be mapped to its corresponding account via the `account_id` field.
transactionsarray<CashflowReportTransaction>required
An array containing transactions from the account. Transactions are returned in reverse chronological order, with the most recent at the beginning of the array. The maximum number of transactions returned is determined by the `count` parameter.
total_transactionsintegerrequired
The total number of transactions available within the date range specified. If `total_transactions` is larger than the size of the `transactions` array, more transactions are available and can be fetched using the `cursor` parameter.
itemobjectrequired
Metadata about the Item.
next_cursorstringrequired
Cursor used for fetching any future updates after the latest update provided in this response.
has_morebooleanrequired
Represents if more than requested count of transactions exists to be fetched
last_successful_update_timestringrequired
The last successful update time in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format ( `YYYY-MM-DDTHH:mm:ssZ` )
request_idstringrequired
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.
defaultError response
error_typestringrequired
A broad categorization of the error. Safe for programmatic use.
Allowed:INVALID_REQUESTINVALID_RESULTINVALID_INPUTINSTITUTION_ERRORRATE_LIMIT_EXCEEDEDAPI_ERRORITEM_ERRORASSET_REPORT_ERRORBASE_REPORT_ERRORRECAPTCHA_ERROROAUTH_ERRORPAYMENT_ERROR
error_codestringrequired
The particular error code. Safe for programmatic use.
error_code_reasonstringoptional
The specific reason for the error code. Currently, reasons are only supported for OAuth-based item errors; `null` will be returned otherwise. Safe for programmatic use. Possible values: `OAUTH_INVALID_TOKEN`: The user's OAuth connection to this institution has been invalidated. `OAUTH_CONSENT_EXPIRED`: The user's access consent for this OAuth connection to this institution has expired. `OAUTH_USER_REVOKED`: The user's OAuth connection to this institution is invalid because the user revoked their connection.
error_messagestringrequired
A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.
display_messagestringrequired
A user-friendly representation of the error code. `null` if the error is not related to user action. This may change over time and is not safe for programmatic use.
request_idstringoptional
A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.
causesarrayoptional
In this product, a request can pertain to more than one Item. If an error is returned for such a request, `causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. `causes` will be provided for the `error_type` `ASSET_REPORT_ERROR` or `CHECK_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object.
statusintegeroptional
The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.
documentation_urlstringoptional
The URL of a Plaid documentation page with more information about the error
suggested_actionstringoptional
Suggested steps for resolving the error
required_account_subtypesarray<string>optional
A list of the account subtypes that were requested via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.
provided_account_subtypesarray<string>optional
A list of the account subtypes that were extracted but did not match the requested subtypes via the `account_filters` parameter in `/link/token/create`. Currently only populated for `NO_ACCOUNTS` errors from Items with `investments_auth` as an enabled product.

Error handling

access_token and days_requested are required. days_requested must be between 1 and 730, while count must be between 1 and 500 and defaults to 100 when omitted. Pass an empty cursor for the first request, and use options.account_ids only for accounts associated with the Item.