Receive Purchase Order Line Item Segments

PUT /api/.../polineitems/{id}/segments?action=receive

Receive one or more purchase order line item segments.

Request Information

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

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

Property Type Nullable Description
POLineItemSegmentID Integer No POLI segment identifier.
Example
application/json, text/json 
[7,395769]

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 item is received successfully.
ErrorMessage String Description of error
ErrorCode Integer Error code
AdditionalInfo String Segment line number
Example
application/json, text/json 
{
  "RecordsAffected": 2,
  "Message": "The purchase order line item segments were received successfully 
Line 3: There are 1 request(s) for 'Blood of angels : a novel'. 
",
  "Details": [
    {
      "Id": 7,
      "Succeeded": true,
      "ErrorMessage": null,
      "ErrorCode": 0,
      "AdditionalInfo": "1"
    },
    {
      "Id": 395769,
      "Succeeded": true,
      "ErrorMessage": null,
      "ErrorCode": 0,
      "AdditionalInfo": "2"
    }
  ]
}

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_ReleaseReceiveCancelClosePO (based on owner ID)