Bank Statement Transactions

List bank statement transactions

Changed on

Endpoint for retrieving a list of bank statement transactions.

get/bank-accounts/{bank_account_id}/statement-transactions/

Request

  • Base URL
    https://api.wafeq.com/v1
  • URL
    https://api.wafeq.com/v1/bank-accounts/{bank_account_id}/statement-transactions/
  • Auth
    API key in header Authorization

Path parameters

bank_account_idstring required

The public ID of the bank account containing the statement transactions.

Query parameters

amount_maxnumber double

Amount

amount_minnumber double

Amount

created_ts_afterstring date-time

The timestamp in UTC when the transaction was created

created_ts_beforestring date-time

The timestamp in UTC when the transaction was created

date_afterstring date

Date

date_beforestring date

Date

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: account, account.parent, bank_account, bank_account.account, project, cost_center. Nested relations are joined with a dot.

is_postedboolean

Whether the statement transaction is reconciled.

modified_ts_afterstring date-time

The timestamp in UTC when the transaction was last modified

modified_ts_beforestring date-time

The timestamp in UTC when the transaction was last modified

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

projectstring

The unique identifier of the project.

referencestring

Reference

Response

countinteger required

The total number of results across all pages.

nextstring uri nullable

The URL of the next page of results, or null on the last page.

previousstring uri nullable

The URL of the previous page of results, or null on the first page.

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

    • info

      added the new optional query request parameter amount_max

    • info

      added the new optional query request parameter amount_min

    • info

      added the new optional query request parameter created_ts_after

    • info

      added the new optional query request parameter created_ts_before

    • info

      added the new optional query request parameter date_after

    • info

      added the new optional query request parameter date_before

    • info

      added the new optional query request parameter expand

    • info

      added the new optional query request parameter is_posted

    • info

      added the new optional query request parameter modified_ts_after

    • info

      added the new optional query request parameter modified_ts_before

    • info

      added the new optional query request parameter project

    • info

      added the new optional query request parameter reference