WAwafeq
Bank Ledger Transactions

List bank ledger transactions

Changed on

Endpoint for retrieving a list of bank ledger transactions.

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

Request

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

Path parameters

bank_account_idstring required

Query parameters

expandstring

Comma-separated related objects to return in full instead of as IDs. Accepted values: account, account.parent, bank_account, bank_account.account, contact, contact.persons, journal, project, tax_rate. Nested relations are joined with a dot. Pass journal to replace the journal ID with its object (ID, date, currency, reference, notes and timestamps). Documents without a journal still return null. Journal line items are retrieved separately with GET /v1/journal-line-items/?journal={journal_id}.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

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

  • b8f5e10134b4Revision changes
    • info

      added the new optional query request parameter expand

    • info

      added the required property // to the response with the status