Routes
Purchase Orders
Items

Get Purchase Order Items

Changed on

This request gets information associated with PO items. Every line item on a PO is an item returned by this call.

Return data description

PropertyDescription
poIDThe unique ID of the purchase order associated to this item.
poItemIDThe unique ID of this Purchase Order Item
itemTypeWhich type (Part, Service, or Other) this item is.
nameThe name of the item.
descriptionA more detailed description of the item.
glIDThe unique ID of the GL associated to this item.
partIDThe unique ID of the part associated to this item.
taskIDThe unique ID of the task associated to this item.
poNumberThe user-set Purchase Order number.
qtyThe quantity purchased.
rateThe billing rate for the item on the Purchase Order.
taxThe tax percent rate for the item on the Purchase Order.
discountThe discount percent rate for the item on the Purchase Order.
shippingThe shipping rate for the item on the Purchase Order.
qtyReceivedA number representing the total quantity that has been marked as "received" for this item.
lastEditedLast time this PO item was edited, this field outputs a UNIX timestamp.
orderUnitAbbreviationThe abbreviation for the unit of measure in which the PO item was ordered. (NULL for items not assigned to a unit of measure)
get/v2/po/items

Request

Query parameters

posstring

This parameter is used to only get specific POs. This parameter expects a comma delimited list of PO IDs.

itemsstring

This parameter is used to only get specific PO Items by ID. This parameter expects a comma delimited list of poItem IDs.

numbersstring

This parameter is used to only get specific POs by Number. This parameter expects a comma delimited list of PO Numbers.

cursorinteger

This parameter is a cursor that selects what vendorID you want to start receiving results at. e.g. passing 137 here will only get you vendors with an id greater than 137.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time. Maximum allowed value is 1000.

lastEditedStartinteger

This parameter is used to only get PO items that were last edited after the unix timestamp passed into the start parameter. For example, all PO items that were last edited after April 18th, 2018.

lastEditedEndinteger

This parameter is used to only get POs items that were last edited before the unix timestamp passed in.

Response

Get Purchase Order Items

poIDinteger
poItemIDinteger
itemTypeinteger
nameunknown
descriptionunknown
glIDinteger
partIDinteger
taskIDinteger
poNumberinteger
qtyinteger
rateinteger
taxinteger
discountinteger
shippinginteger
qtyReceivedinteger
orderUnitAbbreviationunknown
lastEditedinteger

Changes

    • warning

      for the query request parameter limit, the max was set to 1000.00

    • warning

      for the query request parameter limit, the min was set to 1.00

    • info

      added the non-success response with the status