Skip to main content
POST
/
api
/
goods_in_receipts
/
{id}
/
revert
Revert a goods in receipt
curl --request POST \
  --url https://clarus-api.com/api/goods_in_receipts/{id}/revert \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Clarus-Subdomain: <api-key>'
{
  "data": {
    "id": 1,
    "type": "goods_in_receipts",
    "attributes": {
      "account_id": 1,
      "warehouse_id": 1,
      "reference": "PO-2024-001",
      "status": "pending"
    }
  }
}

​
Behavior

  • Reverts a received receipt back to pending status
  • Cannot revert if any tasks on the receipt are completed
  • Returns the updated receipt

​
No Request Body Required

The receipt ID is provided in the URL path. No request body is needed.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

​
id
integer
required

The unique identifier of the goods in receipt to revert

Response

Receipt reverted successfully

​
data
object