{"openapi":"3.1.0","info":{"title":"GET /api/v1/ledgers/{ledger_id}/cascade-preview","version":"1.0.0","description":"Preview ledger cascade delete"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/ledgers/{ledger_id}/cascade-preview":{"get":{"tags":["ledgers"],"summary":"Preview ledger cascade delete","description":"Preview dependent records that would be deleted when permanently removing a ledger.","operationId":"preview_ledger_cascade_delete_api_v1_ledgers__ledger_id__cascade_preview_get","parameters":[{"name":"ledger_id","in":"path","required":true,"schema":{"type":"string","title":"Ledger Id"}},{"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"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_LedgerCascadeDeletePreviewResponse_"}}}},"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":{"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"LedgerCascadeDeleteCounts":{"properties":{"journal_entries":{"type":"integer","title":"Journal Entries","default":0},"line_entries":{"type":"integer","title":"Line Entries","default":0},"transactions":{"type":"integer","title":"Transactions","default":0},"bill_payments":{"type":"integer","title":"Bill Payments","default":0},"reconciliations":{"type":"integer","title":"Reconciliations","default":0},"teal_account_links":{"type":"integer","title":"Teal Account Links","default":0},"entity_tags":{"type":"integer","title":"Entity Tags","default":0},"sales_receipts":{"type":"integer","title":"Sales Receipts","default":0},"bank_deposits":{"type":"integer","title":"Bank Deposits","default":0}},"type":"object","title":"LedgerCascadeDeleteCounts","description":"Dependent record counts for a ledger cascade delete preview."},"LedgerCascadeDeletePreviewResponse":{"properties":{"ledger_id":{"type":"string","title":"Ledger Id"},"ledger_name":{"type":"string","title":"Ledger Name"},"ledger_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ledger Type"},"is_teal_backed":{"type":"boolean","title":"Is Teal Backed","default":false},"teal_instance_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Teal Instance Id"},"counts":{"$ref":"#/components/schemas/LedgerCascadeDeleteCounts"}},"type":"object","required":["ledger_id","ledger_name","counts"],"title":"LedgerCascadeDeletePreviewResponse","description":"Preview of records that would be deleted in a ledger cascade delete."},"SuccessEnvelope_LedgerCascadeDeletePreviewResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/LedgerCascadeDeletePreviewResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[LedgerCascadeDeletePreviewResponse]"},"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":[]}]}