Deposit slips

List deposit slip candidates

Returns a page of transactions on one bank account that are eligible to be grouped onto a deposit slip and not already on one. Requires the deposit_slips:read permission.

GET

https://services.magicdoor.com/accounting/company-portal/deposit-slips/candidates

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

bankAccountIdstringrequired

The bank account to look in. Candidates are always scoped to one account, because a slip cannot mix accounts.

example: 1830472847398404096

pageinteger

Which page to return, starting at 1.

default: 1

pageSizeinteger

How many transactions per page, between 1 and 100.

default: 50

transactionDate.startstring · date

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

transactionDate.endstring · date

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

transactionDate.startInclusiveboolean

Whether transactionDate.start itself is included.

default: true

transactionDate.endInclusiveboolean

Whether transactionDate.end itself is included.

default: true

finalizedDate.startstring · date

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

finalizedDate.endstring · date

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

finalizedDate.startInclusiveboolean

Whether finalizedDate.start itself is included.

default: true

finalizedDate.endInclusiveboolean

Whether finalizedDate.end itself is included.

default: true

Response

200 · A page of eligible, unclaimed transactions.

itemsCandidate[]

The transactions you can pass to create a deposit slip.

totalCountinteger

How many candidates match in total.

totalPagesinteger

How many pages that is at this pageSize.

pageinteger

The page number that was returned.

pageSizeinteger

How many candidates a full page holds.

400 · `bankAccountId` is missing or not a Snowflake, or a pagination value is out of range.

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

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

404 · No bank account with that id belongs to the caller's company.

What can go on a deposit slip

Only a transaction that is money coming in (direction: "in"), has status success, has an amount greater than zero, was recorded as an offline payment rather than one taken through a processor, is not deleted, and is not already claimed by another deposit slip. Anything else is not a candidate and cannot be added.