Preview ledger cascade delete

GET/api/v1/ledgers/{ledger_id}/cascade-preview

Preview dependent records that would be deleted when permanently removing a ledger.

Operation ID: preview_ledger_cascade_delete_api_v1_ledgers__ledger_id__cascade_preview_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

ledger_idstringrequired

Responses

200Successful Response

Schema: SuccessEnvelope_LedgerCascadeDeletePreviewResponse_

successboolean
messagestring
codestring
dataLedgerCascadeDeletePreviewResponse

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

Code samples

GET/api/v1/ledgers/{ledger_id}/cascade-preview

bash

curl -X GET 'https://api.ondayzero.com/api/v1/ledgers/{ledger_id}/cascade-preview' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID'