Statements

List statements

List the statements for a given financial account.

get/v1/financial_accounts/{financial_account_token}/statements

Path parameters

financial_account_tokenstring uuid required

Globally unique identifier for financial account.

Globally unique identifier for financial account.

Query parameters

beginstring date

Date string in RFC 3339 format. Only entries created after the specified date will be included.

Date string in RFC 3339 format. Only entries created after the specified date will be included.

endstring date

Date string in RFC 3339 format. Only entries created before the specified date will be included.

Date string in RFC 3339 format. Only entries created before the specified date will be included.

ending_beforestring

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

page_sizeinteger

Page size (for pagination).

Page size (for pagination).

starting_afterstring

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

include_initial_statementsboolean

Whether to include the initial statement. It is not included by default.

Whether to include the initial statement. It is not included by default.

Response

OK

has_moreboolean required

Changes

Changed in 4 of the 83 revisions of this API.306

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the non-success response with the status 422

      response-non-success-status-added

    • added the non-success response with the status 429

      response-non-success-status-added

    • the response property data/items/next_payment_due_date became nullable for the status 200

      response-property-became-nullable

    • the response property data/items/next_statement_end_date became nullable for the status 200

      response-property-became-nullable

    • added credit_details subschema #1 to the data/items/period_totals/credit_details response property oneOf list for the response status 200

      response-property-one-of-added

    • added credit_details subschema #1 to the data/items/statement_totals/credit_details response property oneOf list for the response status 200

      response-property-one-of-added

    • added credit_details subschema #1 to the data/items/ytd_totals/credit_details response property oneOf list for the response status 200

      response-property-one-of-added

    • added debit_details subschema #1 to the data/items/period_totals/debit_details response property oneOf list for the response status 200

      response-property-one-of-added

    • added debit_details subschema #1 to the data/items/statement_totals/debit_details response property oneOf list for the response status 200

      response-property-one-of-added

    • added debit_details subschema #1 to the data/items/ytd_totals/debit_details response property oneOf list for the response status 200

      response-property-one-of-added

    • added payment_details subschema #1 to the data/items/period_totals/payment_details response property oneOf list for the response status 200

      response-property-one-of-added

    • added payment_details subschema #1 to the data/items/statement_totals/payment_details response property oneOf list for the response status 200

      response-property-one-of-added

    • added payment_details subschema #1 to the data/items/ytd_totals/payment_details response property oneOf list for the response status 200

      response-property-one-of-added

    • removed the pattern property ^.*$ from the data/items/period_totals/credit_details response property for the status 200

      response-property-pattern-property-removed

    • removed the pattern property ^.*$ from the data/items/period_totals/debit_details response property for the status 200

      response-property-pattern-property-removed

    • removed the pattern property ^.*$ from the data/items/period_totals/payment_details response property for the status 200

      response-property-pattern-property-removed

    • removed the pattern property ^.*$ from the data/items/statement_totals/credit_details response property for the status 200

      response-property-pattern-property-removed

    • removed the pattern property ^.*$ from the data/items/statement_totals/debit_details response property for the status 200

      response-property-pattern-property-removed

    • removed the pattern property ^.*$ from the data/items/statement_totals/payment_details response property for the status 200

      response-property-pattern-property-removed

    • removed the pattern property ^.*$ from the data/items/ytd_totals/credit_details response property for the status 200

      response-property-pattern-property-removed

    • removed the pattern property ^.*$ from the data/items/ytd_totals/debit_details response property for the status 200

      response-property-pattern-property-removed

    • removed the pattern property ^.*$ from the data/items/ytd_totals/payment_details response property for the status 200

      response-property-pattern-property-removed

    • the data/items/period_totals/credit_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the data/items/period_totals/debit_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the data/items/period_totals/payment_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the data/items/statement_totals/credit_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the data/items/statement_totals/debit_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the data/items/statement_totals/payment_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the data/items/ytd_totals/credit_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the data/items/ytd_totals/debit_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the data/items/ytd_totals/payment_details response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • response property data/items/credit_product_token list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • added the optional property data/items/statement_totals to the response with the 200 status

      response-optional-property-added