Purchase_item

A purchase item [Purchase_item] is an entry in a purchase order.

Review the Usage Guidelines for the Purchase_item object.

—	XML	SOAP	REST	Database table
Object	Purchase_item	oaPurchase_item	—	purchase_item
Supported Commands	Add, Read, Modify, Delete	add(), read(), modify(), upsert(), delete()	—	—

The Purchase_item object has the following standard properties:

Note:

Purchase_item object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML / SOAP	Database	Description
acct_date	acct_date	The accounting period date of the purchase item. See Date Fields.
allow_vendor_substitution	allow_vendor_substitution	A 1/0 field indicating whether the vendor may be substituted.
approved_cost	approved_cost	A snap-shot of the approved cost from the request item (in the currency of the purchase order). 3 decimal places for handling amounts like mileage at 32.5 cents. Dated by the date field.
attachmentid	attachment_id	If non-zero, the attachment record associated with this purchaseitem.
cost	cost	The cost per unit of measure at which the product is ordered (in the currency of the purchase order). 3 decimal places for handling amounts like mileage at 32.5 cents. Dated by the date field.
created	created	[Read-only] Time the record was created. See Date Fields.
currency	currency	Currency for the money fields in the record.
customerid	customer_id	The ID of the associated customer.
date	date	[Required] The date of the purchase item. The same as the purchase order date. See Date Fields.
date_fulfilled	date_fulfilled	The date on which all of the quantity was fulfilled. See Date Fields.
id	id	[Read-only] Unique ID. Automatically assigned by OpenAir.
manufacturer_part	manufacturer_part	The manufacturer's part number, SKU or other unique identification for this product.
manufacturerid	manufacturer_id	The ID of the associated manufacturer.
name	name	The purchase name.
non_po	non_po	A 1/0 field indicating that this purchase item was created without a purchase order.
notes	notes	Notes associated with this purchase order block.
order_reference_number	order_reference_number	Unique reference number within purchase order.
productid	product_id	The ID of the associated product.
project_taskid	project_task_id	The ID of the associated project task.
projectid	project_id	The ID of the associated project.
purchaseorderid	purchaseorder_id	[Read-only] The ID of the associated purchase order.
purchaserequestid	purchaserequest_id	The ID of the associated purchase request.
purchaserid	purchaser_id	The ID of the purchaser or purchasing agent. This is always the same as the purchase order creator (purchaser_id).
quantity	quantity	[Read-only] The quantity of product_id for this purchase.
quantity_fulfilled	quantity_fulfilled	The quantity that has been fulfilled.
quantity_payable	quantity_payable	The quantity that is payable.
request_itemid	request_item_id	The ID of the associated request item.
tax_location_name	—	The name of the tax location.
total	total	The total value of the purchase (in the currency of the purchase order). Dated by the date field. Overridden by calculated value when adding or modifying an object.
total_with_tax	—	The total value of the purchase (in the currency of the purchase order)including tax. Dated by the date field.
um	um	The unit of measure for the product, e.g. EA.
updated	updated	[Read-only] Time the record was last updated or modified. See Date Fields.
userid	userid	The ID of the requester.
vendor_quote_number	vendor_quote_number	The vendor's quote number.
vendor_sku	vendor_sku	The vendor's sku for this product.
vendorid	vendor_id	The ID of the associated vendor

Usage Guidelines

There are several limitations impacting the addition or modification of purchase item information into OpenAir:

• You can add or modify a purchase item record only if it is not associated with a PO record. These purchase items are also referred to as "Quick POs" or "non-po purchase items".

  • The Quick PO functionality must be enabled for your OpenAir account. Otherwise, the API returns the following error: "Error code 846: Cannot create non-po purchase items".

    To enable the Quick PO functionality, go to Administration > Application Settings > Purchases > Other Settings. Scroll down and check the Enable the ability to create quick POs. These are purchase items for purchases made without an OpenAir PO box.

  • non_po must be set to 1. Otherwise, the API returns the following error: "Error code 848: Only non_po purchase items can be added/modified".

  • purchaseorderid must be empty. Otherwise, the API returns the following error: "Error code 847: purchaseorderid must be blank".

• An optional feature lets you update the project association (Customer: Project) for existing purchase item records associated with a PO using the API. This is the only information you can modify using the API. To enable project association update for purchase items associated with a PO, contact OpenAir Customer Support.