Get bank deposit

GET/api/v1/bank-deposits/{deposit_id}

Get details of a specific bank deposit.

Operation ID: get_bank_deposit_api_v1_bank_deposits__deposit_id__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.

Parameters

Path

deposit_idstringrequired

Responses

200Successful Response

Schema: BankDepositResponse

idstringrequired
business_idstringrequired
numberstring
statusstringrequired
deposit_datestring · daterequired
deposit_to_ledger_idstringrequired
deposit_to_ledger_namestring
sales_receipt_idsarray · string
other_linesarray · object
undeposited_totalintegerrequired
totalintegerrequired
memostring
currencystringrequired
journal_entry_idstring
void_journal_entry_idstring
created_atstring · date-timerequired
updated_atstring · date-timerequired

401Unauthorized - Authentication required

403Forbidden - Insufficient permissions

404Not Found - Resource does not exist

422Validation Error

Schema: HTTPValidationError

detailarray · ValidationErrorValidationError

5 fields

locarray · string | integerrequired
msgstringrequired
typestringrequired
inputobject
ctxobject

Code samples

GET/api/v1/bank-deposits/{deposit_id}

bash

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