Get Started

Create bank deposit

POST/api/v1/bank-deposits

Group undeposited receipts and ad-hoc lines into a bank deposit.

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

Request body

Schema: BankDepositCreateRequest

deposit_to_ledger_idstringrequired

Bank/cash account the money lands in.

deposit_datestring · date

Deposit date. Defaults to today.

sales_receipt_idsarray · string

Undeposited sales receipts to group into this deposit.

other_linesarray · OtherDepositLineOtherDepositLine

Optional ad-hoc deposit lines (non-undeposited sources).

3 fields
from_ledger_idstringrequired

Account credited for this line (e.g. interest income).

descriptionstring
amountintegerrequired

Line amount in cents.

numberstring
memostring
currencystring

Responses

201Successful 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

400Bad Request - Invalid input

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