Modify Purchase Order Line Item Status

PUT /api/.../polineitems/{id}/status

Modify POLI Status. This action is only available if the POLI status is not currently set to one of the following:

  • Cancelled (2)
  • Closed (19)
  • Currently Received (7)
  • Partly Received (18)
  • Pending (12)
  • Received (13)
This action may additionally update all attached POLI segment statuses.

The following status changes are not allowed:

  • Canceled
  • Closed
  • Pending Claim
  • Claimed
  • Completed
  • Confirmed
  • Currently Received
  • Partly Received
  • Pending
  • Received

Request Information

Parameters
Name Type Required Description
id Integer Yes The unique id assigned to the purchase order line item.
DtoModifyPoliStatusReq
Property Type Nullable Description
PoliStatusID int No The status id that the POLI will be updated to.
Request body

Example that modifies the status to Backordered (1).
See Get Line Item Statuses for more information.

application/json, text/json 
    {PoliStatusID: 1}

Response Information

True is returned upon success.

Example
application/json, text/json 
    true

HTTP Response Codes

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

Required Permissions

Permission IDs found here.

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