List bank deposits

GET/api/v1/bank-deposits

List bank deposits for the business.

Operation ID: list_bank_deposits_api_v1_bank_deposits_get·View as markdown·OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

statusstring: Filter by status: posted or void.
cursorstring: Cursor for pagination
limitinteger: Pagination limit
directionstringdefault: next: Pagination direction: 'next' or 'prev'
include_total_countbooleandefault: False: Whether to include total count (expensive - avoid if possible)
sort_bystring: Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.
descendingbooleandefault: True: Sort direction: true for descending (newest/largest first), false for ascending

Schema: BankDepositsListResponse

itemsarray · BankDepositResponserequiredBankDepositResponse

List of items

17 fields

totalinteger

Total number of items (null when not calculated for performance)

limitinteger

Pagination limit

next_cursorstring

Cursor for next page

prev_cursorstring

Cursor for previous page

has_nextbooleanrequired

Whether there are more items

has_prevbooleanrequired

Whether there are previous items

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

GET/api/v1/bank-deposits

bash

curl -X GET 'https://api.ondayzero.com/api/v1/bank-deposits' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'