Dismiss Unmatched Return
POST/api/returns/reconciliation/:returnReceipt/dismiss
Acknowledge a received return's residual unlinked lines and drop it from the unmatched returns list.
A receipt stays unmatched while any one of its lines is unlinked, so a batch with (say) 31 of 32 lines linked stays open indefinitely because of one item that will never match. Dismissing records who dismissed it, when, and an optional reason.
Dismissal is bookkeeping only: inventory, the authorization links already made, and the receipt's reconciliation status are all left untouched, and the receipt can be restored at any time. Dismissed receipts stay retrievable via filter[dismissed]=only (or =all) on List Unmatched Returns.
Body: reason (optional string, max 500 characters).
Returns 422 if the receipt is already dismissed, or if it is linked to a return authorization and therefore never appeared on the unmatched list.
Requires a Bearer token and the returns.update permission.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.