Purchase Order Line Items Undo Receipt

PUT /api/.../purchaseorders/{id}/polineitems?action=undoreceipt

Undo receipt for one or more purchase order line items.

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the purchase order.
action String Yes. Value should be 'undoreceipt' action identifier
Request Body

A JSON array of purchase order line item identifiers represented as numbers.

Property Type Nullable Description
POLineItemID Integer No PO line item identifier.
Example
application/json, text/json 
[19, 38,56,58]

Response Information

Returns a result object with how many records are succeeded (RecordsAffected), a success or failure message (Message) and list of JSON objects (Details)

Property Type Description
ID Integer PO line item identifier.
Succeeded Boolean Indicates if the undo receipt is succeeded.
ErrorMessage String Description of error
ErrorCode Integer Error code
AdditionalInfo String PO line item's line number
Example
application/json, text/json 
{
  "RecordsAffected": 1,
  "Message": "Undo receipt process succeeded for 1 item(s) and failed for 3 item(s)",
  "Details": [
    {
      "Id": 19,
      "Succeeded": false,
      "ErrorMessage": "Undo receipt failed for line item 6. Check the linked item’s circulation status.",
      "ErrorCode": 20044,
      "AdditionalInfo": "6"
    },
    {
      "Id": 38,
      "Succeeded": false,
      "ErrorMessage": "Undo receipt failed for line item 25. There are holds on linked item records.",
      "ErrorCode": 20045,
      "AdditionalInfo": "25"
    },
    {
      "Id": 56,
      "Succeeded": false,
      "ErrorMessage": "Undo receipt failed. PO Line ID 56 is currently not 'Received'.",
      "ErrorCode": 20047,
      "AdditionalInfo": "43"
    },
    {
      "Id": 58,
      "Succeeded": true,
      "ErrorMessage": null,
      "ErrorCode": 0,
      "AdditionalInfo": "45"
    }
  ]
}

Error Codes

Code Description
20044 Linked item's exist
20045 Hold exists on linked item(s)
20046 Unexpected error
20047 Invalid purchase order line item status

HTTP Response Codes

Code Description
200 OK. Success
400 FAILURE.
  • Bad request
  • Invalid purchase order ID
  • Invalid poline item ID
404 FAILURE.
  • Purchase order not found
  • Purchase order line item not found

Required Permissions

Permission IDs found here.

    CR_AccessAcquisitions_Allow (),
    CR_PurchaseOrders_Access (based on owner ID),
    CR_PurchaseOrders_UndoReceipt (based on owner ID)