Delete Sales Order

DELETE /accounting/sales-orders/{id}

Group: Accounting › Sales Orders · Operation ID: deleteSalesOrder

Permanently delete one sales order and every record hanging off it. Refuses an order that is past pending approval, amends another order, or has already produced journal entries, invoices or recognized revenue. Returns an empty output. Every request must carry the Api-Version header.

Permanently deletes one sales order and everything hanging off it — its products and product lines, the subscription lines, invoice-plan lines, revenue records and taxation those lines drive, metrics, attachments, external identifiers, and the sales arrangement when this was its last order.

DELETE accounting/sales-orders/3b7d5e9c-1a24-4f80-9c6d-2e8f70b13a45

The response is empty — what was deleted is what the caller named. Read the order with GET accounting/sales-orders/{id} first if you need its number for a log.

Only an order that has not yet taken effect may be deleted. The call is refused, and nothing is written, when the order is past pending approval (NOT_PENDING_APPROVAL), amends an existing order rather than being a new one (ORDER_IS_MODIFICATION), already has journal entries (HAS_JOURNAL_ENTRIES), has been invoiced (ALREADY_INVOICED), or has revenue recognized against it (REVENUE_RECOGNIZED). These guard the records the order has already produced downstream; an order that has gone further than this is retired through its own business process, not removed.

Deleting an id that does not exist is NOT_FOUND, not a silent success. The call runs in a transaction, so a failure at any point leaves the order and its records untouched.

Open in the interactive reference

Parameters

Name	In	Type	Required	Description
`Api-Version`	header	`"v1"`	yes	The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`.
`Idempotency-Key`	header	string	no	An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored.
`id`	path	string	yes	Id (a UUID) of the sales order to delete; bound from the :id path segment.

Response

200 Success

Response headers

Idempotency-Replayed — Present and true only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as false.

Errors

Code	Status
`NOT_FOUND`	400
`NOT_PENDING_APPROVAL`	400
`ORDER_IS_MODIFICATION`	400
`HAS_JOURNAL_ENTRIES`	400
`ALREADY_INVOICED`	400
`REVENUE_RECOGNIZED`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422

Statuses

400 — Invalid request or business failure. Codes: NOT_FOUND, NOT_PENDING_APPROVAL, ORDER_IS_MODIFICATION, HAS_JOURNAL_ENTRIES, ALREADY_INVOICED, REVENUE_RECOGNIZED
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
409 — The Idempotency-Key is still being processed by another request.
422 — The Idempotency-Key was already used with a different request payload.
429 — Too many requests
500 — Internal server error