Bank ledger transfers

List bank ledger transfers

Returns a page of the company's bank ledger transfers. Deleted transfers are never included. Requires the bank_ledger_transfers:read permission.

GET
https://services.magicdoor.com/accounting/company-portal/bank-ledger-transfers

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Query parameters

pageinteger

Which page to return, starting at 1.

default: 1
pageSizeinteger

How many transfers per page, between 1 and 100.

default: 50
transferDate.startstring · date

Earliest transfer date to include, read in the company's timezone.

transferDate.endstring · date

Latest transfer date to include, read in the company's timezone.

transferDate.startInclusiveboolean

Whether transferDate.start itself is included.

default: true
transferDate.endInclusiveboolean

Whether transferDate.end itself is included.

default: true
transferTypesenum<string>[]

Only transfers of these kinds.

bankToBankbankDepositbankWithdrawal
memostring

Match against the memo, 1 to 1000 characters.

referencestring

Match against the reference, 1 to 200 characters.

Response

200 · A page of bank ledger transfers.

itemsBankLedgerTransfer[]

The transfers on this page.

totalCountinteger

How many transfers match the filter in total.

totalPagesinteger

How many pages the filter produces at this pageSize.

pageinteger

The page number that was returned.

pageSizeinteger

How many transfers a full page holds.

400 · A query parameter failed validation — `page` below 1, `pageSize` outside 1–100, or an out-of-range `memo` or `reference` length.

401 · The access token is missing, expired, or not for this company.

403 · The caller does not hold the `bank_ledger_transfers:read` permission.