Update Accounting Sales Return

PATCH /accounting/sales-returns/{id}

Group: Accounting › Sales Returns · Operation ID: updateAccountingSalesReturn

Updates the sales return with the given identifier. Only the fields in the request body change. Use the sales return's id, not its salesReturnNumber.

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	The unique identifier for the sales return to update.

Required, application/json: updateAccountingSalesReturnInput.

Field	Type	Required	Description
`notes`	string or null	no	New free-form notes for the return.
`reasonCode`	string or null	no	The new header-level reason for the return. Accepted values: 'defectiveItem', 'wrongItemShipped', 'damagedInTransit', 'customerRequest', 'duplicateOrder', 'notAsDescribed', 'other'.
`returnTrackingNumber`	string or null	no	The new carrier tracking number for the inbound return shipment.

Example:

{
  "notes": "<notes>",
  "reasonCode": "<reasonCode>",
  "returnTrackingNumber": "<returnTrackingNumber>"
}

200 Success

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.

Code	Status
`NOT_FOUND`	400
`IDEMPOTENCY_KEY_CONFLICT`	409
`IDEMPOTENCY_PAYLOAD_MISMATCH`	422