{"openapi":"3.1.0","info":{"title":"POST /api/v1/bank-deposits","version":"1.0.0","description":"Create bank deposit"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/bank-deposits":{"post":{"tags":["bank-deposits"],"summary":"Create bank deposit","description":"Group undeposited receipts and ad-hoc lines into a bank deposit.","operationId":"create_bank_deposit_api_v1_bank_deposits_post","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankDepositCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankDepositResponse"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"detail":"Invalid request parameters"}}}},"401":{"description":"Unauthorized - Authentication required","content":{"application/json":{"example":{"detail":"Not authenticated"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"detail":"Not enough permissions"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"detail":"Resource not found"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"BankDepositCreateRequest":{"properties":{"deposit_to_ledger_id":{"type":"string","title":"Deposit To Ledger Id","description":"Bank/cash account the money lands in."},"deposit_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Deposit Date","description":"Deposit date. Defaults to today."},"sales_receipt_ids":{"items":{"type":"string"},"type":"array","title":"Sales Receipt Ids","description":"Undeposited sales receipts to group into this deposit."},"other_lines":{"items":{"$ref":"#/components/schemas/OtherDepositLine"},"type":"array","title":"Other Lines","description":"Optional ad-hoc deposit lines (non-undeposited sources)."},"number":{"anyOf":[{"type":"string","maxLength":100},{"type":"null"}],"title":"Number"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"currency":{"type":"string","maxLength":3,"title":"Currency","default":"USD"}},"type":"object","required":["deposit_to_ledger_id"],"title":"BankDepositCreateRequest","description":"Request schema for creating (and posting) a bank deposit."},"BankDepositResponse":{"properties":{"id":{"type":"string","title":"Id"},"business_id":{"type":"string","title":"Business Id"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"status":{"type":"string","title":"Status"},"deposit_date":{"type":"string","format":"date","title":"Deposit Date"},"deposit_to_ledger_id":{"type":"string","title":"Deposit To Ledger Id"},"deposit_to_ledger_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deposit To Ledger Name"},"sales_receipt_ids":{"items":{"type":"string"},"type":"array","title":"Sales Receipt Ids"},"other_lines":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Other Lines"},"undeposited_total":{"type":"integer","title":"Undeposited Total"},"total":{"type":"integer","title":"Total"},"memo":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Memo"},"currency":{"type":"string","title":"Currency"},"journal_entry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Journal Entry Id"},"void_journal_entry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Void Journal Entry Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","business_id","status","deposit_date","deposit_to_ledger_id","undeposited_total","total","currency","created_at","updated_at"],"title":"BankDepositResponse","description":"Response schema for a bank deposit."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"OtherDepositLine":{"properties":{"from_ledger_id":{"type":"string","title":"From Ledger Id","description":"Account credited for this line (e.g. interest income)."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"amount":{"type":"integer","exclusiveMinimum":0.0,"title":"Amount","description":"Line amount in cents."}},"type":"object","required":["from_ledger_id","amount"],"title":"OtherDepositLine","description":"An ad-hoc deposit line not sourced from undeposited funds."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}