{"openapi":"3.1.0","info":{"title":"POST /api/v1/invoices/drafts/bulk-delete","version":"1.0.0","description":"Bulk delete draft invoices"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/invoices/drafts/bulk-delete":{"post":{"tags":["invoices"],"summary":"Bulk delete draft invoices","description":"Delete many draft invoices in one call: name them with `invoice_ids`, or set `all_drafts` (optionally with a due-date window) to clear every draft. Only drafts can be deleted: a selection that includes any other status is refused whole (400) and nothing is deleted. Each deletion runs the single-invoice path in its own savepoint, so a draft that cannot be deleted is reported without blocking the rest.","operationId":"bulk_delete_draft_invoices","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/BulkDeleteDraftInvoicesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_BulkDeleteDraftInvoicesResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"}}}}},"x-fastapi-operation-id":"bulk_delete_draft_invoices_api_v1_invoices_drafts_bulk_delete_post"}}},"components":{"schemas":{"BulkDeleteDraftInvoiceRowResult":{"properties":{"index":{"type":"integer","title":"Index"},"invoice_id":{"type":"string","title":"Invoice Id"},"number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Number"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total","description":"Invoice total in cents."},"due_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Due Date"},"success":{"type":"boolean","title":"Success"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["index","invoice_id","success"],"title":"BulkDeleteDraftInvoiceRowResult","description":"Outcome for one draft."},"BulkDeleteDraftInvoicesRequest":{"properties":{"invoice_ids":{"anyOf":[{"items":{"type":"string"},"type":"array","maxItems":500,"minItems":1},{"type":"null"}],"title":"Invoice Ids","description":"Draft invoice UUIDs to delete (1-500). Every id must be a draft or nothing is deleted. Mutually exclusive with all_drafts."},"all_drafts":{"type":"boolean","title":"All Drafts","description":"Delete every draft invoice of the business, optionally limited by start_date / end_date. Mutually exclusive with invoice_ids. At most 500 are deleted per call; `remaining` says how many are left.","default":false},"start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Start Date","description":"With all_drafts: only drafts due on or after this date."},"end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"End Date","description":"With all_drafts: only drafts due on or before this date."},"dry_run":{"type":"boolean","title":"Dry Run","description":"List the drafts that would be deleted; delete nothing.","default":false}},"type":"object","title":"BulkDeleteDraftInvoicesRequest","description":"Selection of draft invoices to delete."},"BulkDeleteDraftInvoicesResponse":{"properties":{"dry_run":{"type":"boolean","title":"Dry Run","default":false},"total_requested":{"type":"integer","title":"Total Requested","description":"Drafts selected in this call (after the per-call cap)."},"total_deleted":{"type":"integer","title":"Total Deleted"},"total_failed":{"type":"integer","title":"Total Failed"},"partial":{"type":"boolean","title":"Partial","default":false},"remaining":{"type":"integer","title":"Remaining","description":"Matching drafts left after this call (all_drafts selections larger than the per-call cap); call again to continue.","default":0},"results":{"items":{"$ref":"#/components/schemas/BulkDeleteDraftInvoiceRowResult"},"type":"array","title":"Results"}},"type":"object","required":["total_requested","total_deleted","total_failed"],"title":"BulkDeleteDraftInvoicesResponse","description":"Result of a bulk draft delete."},"SuccessEnvelope_BulkDeleteDraftInvoicesResponse_":{"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/BulkDeleteDraftInvoicesResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[BulkDeleteDraftInvoicesResponse]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}