Cancel a goods receipt
PATCH
Cancels a goods receipt that is still a DRAFT. Stock was never changed by a draft, so nothing is reversed. Confirmed or already cancelled receipts are rejected.
How to use it
- Get the receipt ID from List goods receipts and check its status is DRAFT.
- Cancel it. Status becomes CANCELLED and it can no longer be confirmed.
BearerAuthheader
AuthorizationBearer <JWT>id*stringID of the record (UUID).
Format
uuidX-TenantID*stringYour merchant's tenant code — the value typed in the Domain field on the iotoms login screen. See Concepts.
OK
*/*- response
status*stringOutcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.
message*stringShort human-readable message describing the outcome.
data?The goods receipt with its lines.
Example Request
curl -X PATCH 'https://beta.iotoms.com/api/v1/procurement/receipts/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel' \ -H 'X-TenantID: your-tenant-code'Example Response
{ "status": "string", "message": "string", "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "grnNumber": "string", "purchaseOrderId": "84a099d9-2935-4997-a6ac-0d3ee9bbef72", "vendorId": "e9b57fab-1850-44d4-8499-71fd15c845a0", "vendorName": "string", "status": "string", "receivedDate": "2019-08-24", "deliveryNoteNumber": "string", "receivedBy": "string", "confirmedBy": "string", "confirmedAt": "2019-08-24T14:15:22Z", "notes": "string", "items": [ { "id": 0, "itemId": "string", "itemName": "string", "receivedQty": 0, "acceptedQty": 0, "rejectedQty": 0, "condition": "string", "receivingLocationId": "f1f8626b-ea08-4582-99e5-64aabd817e6a", "receivingLocationName": "string", "unitCost": 0, "measuredGrossWeight": 0, "measuredNetWeight": 0, "rejectedWeight": 0, "packWeights": [ 0 ], "expectedWeight": 0, "variancePct": 0, "costPerBaseUnit": 0 } ], "createdAt": "2019-08-24T14:15:22Z" }}