The response body is of type object.

Returns a JSON array that contains the information for each purchase order line item that matches the filter parameters. If no matching line items are found, an empty object is returned.

The following properties are returned.

po_id (string)

The purchase order ID.

po_line_no (integer)

The line number in the purchase order.

vend_id (string)

The vendor ID.

item_id (string)

The ID of the item being ordered.

item_desc (string)

The description of the item being ordered.

num_decimals (integer)

The number of decimals allowed for the item being ordered.

item_uom_id (integer)

The ID of the unit of measure (UOM) for the item being ordered.

item_uom_description (string)

The description of the UOM for the item being ordered.

vendor_item_id (string)

The ID that the vendor uses to refer to the item being ordered.

quantity (double)

The amount of the item being ordered.

uom_id (integer)

The ID of the UOM that has been defined for the line item. Will be null if a UOM has not been defined for the line item.

description (string)

The description of the UOM that will be used for the line item. Will be null if a UOM has not been defined for the line item.

po_line_uom_id (integer)

The ID of the UOM that is being used for the line item's quantity in the purchase order.

• If uom_id has a value other than null, this value will be the line item UOM ID (that is, the value for uom_id).
• If uom_id value is null, this value will be the item UOM ID (that is, the value for item_uom_id).

po_line_uom_description (string)

The description of the UOM that is being used for the line item's quantity in the purchase order.

• If uom_id has a value other than null, this value will be the line item UOM description (that is, the value for description).
• If uom_id value is null, this value will be the item UOM description (that is, the value for item_uom_description).

min_qty (double)

The minimum quantity that, once shipped, will allow the order to be completed.

max_qty (double)

The maximum quantity that can be shipped against this line item. A null value indicates no limit.

line_price (double)

The total price for this line item.

reqd_by_utc (datetime)

The date and time when the line item is required in UTC.

reqd_by_local (datetime)

The date and time when the line item is required in the local time of the MES Middleware server where the call was processed.

reqd_by (datetime)

The date and time when the line item is required in the local time of the time zone that was specified in the tz_id parameter in the call header or URL. If the tz_id parameter was not provided or was not valid, then the time is in UTC.

spare1 (string)

The contents of the spare1 field.

spare2 (string)

The contents of the spare2 field.

spare3 (string)

The contents of the spare3 field.

spare4 (string)

The contents of the spare4 field.

last_edit_comment (string)

The comments about why the record was added or updated.

last_edit_by (string)

The ID of the user who added or last updated this record.

last_edit_at (datetime)

The date and time, in UTC, when the record was added or last updated.

To get all purchase order line items:

api/PurchaseOrderLine

To get the line items for the purchase order with the ID PO12345677:

api/PurchaseOrderLine?poId=PO12345677

To get the line items that are linked to the item BAG-MXD-NUTS in any purchase order:

api/PurchaseOrderLine?itemId=BAG-MXD-NUTS

To get the line items that are linked to the item BAG-MXD-NUTS for the purchase order with the ID PO12345677:

api/PurchaseOrderLine?poId=PO12345677&itemId=BAG-MXD-NUTS

Examples: Work Tasks Lookups

To get all purchase order line items:

api/PurchaseOrderLine

To get the line items for a specific purchase order:

api/PurchaseOrderLine?poId={poId}

To get the line items that are linked to a specific item in any purchase order:

api/PurchaseOrderLine?itemId={itemId}

To get the line items that are linked to a specific item in a specific purchase order:

api/PurchaseOrderLine?poId={poId}&itemId={itemId}

The purchase order line items to be retrieved are determined by the filter parameters.

• Passing a purchase order ID and an item ID will retrieve information for only the corresponding line item.
• Passing a purchase order ID but no item ID will retrieve information for all line items in the purchase order.
• Passing no filter parameters will retrieve information for all line items for all purchase orders.