plaid

Gets insights data in Cashflow Report

The /cashflow_report/insights/get endpoint retrieves insights data associated with an Item. Insights are only calculated on credit and depository accounts.

post/cashflow_report/insights/get

Request body

client_idstring

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_tokenstring required

The access token associated with the Item for which data is being requested.

secretstring

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.

Response

OK

last_generated_timestring date-time required

Datetime of last Cashflow Report generation in ISO 8601 format ( YYYY-MM-DDTHH:mm:ssZ )

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

Changed in 16 of the 53 revisions of this API.17816

  • e536704a333f91See the full diff
    • added the new charge card enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new commercial line of credit enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new home equity loan enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new installment enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new prediction market enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new ASSETS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ASSETS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new IDEMPOTENCY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new IDEMPOTENCY_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_qualify enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_qualify enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_qualify enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_qualify enum value to the // response property for the response status

      response-property-enum-value-added

  • fb8c3f188d8b24See the full diff
    • added the new BASE_REPORT_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new limited purpose checking enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new fhsa enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new protect_transactions enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new protect_transactions enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new protect_transactions enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new protect_transactions enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new qshr enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new roth 403B enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new roth 457b enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new roth pension enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new roth profit sharing plan enum value to the /// response property for the response status

      response-property-enum-value-added

    • added the new roth thrift savings plan enum value to the /// response property for the response status

      response-property-enum-value-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new cra_plaid_credit_score enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the // response property for the response status

      response-property-enum-value-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the IDENTITY_ERROR enum value from the response property for the response status

      response-property-enum-value-removed

    • removed the IDENTITY_ERROR enum value from the // response property for the response status

      response-property-enum-value-removed

  • f8b9f1a8576744See the full diff
    • added the new IDENTITY_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new IDENTITY_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • added the new USER_ERROR enum value to the response property for the response status

      response-property-enum-value-added

    • added the new USER_ERROR enum value to the // response property for the response status

      response-property-enum-value-added

    • removed the cra_plaid_credit_score enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the // response property for the response status

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the // response property for the response status

      response-property-enum-value-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog