Purchaseorder

A purchase order (PO) [Purchaseorder] is a document used to purchase goods or services from an external source. It is a collection of purchase items.

Review the Usage Guidelines for the Purchaseorder object.

—	XML	SOAP	REST	Database table
Object	`Purchaseorder`	`oaPurchaseorder`	—	`purchaseorder`
Supported Commands	`Add`, `Read`, `Modify`, `Delete`	`add()`, `read()`, `modify()`, `upsert()`, `delete()`	—	—

—

XML

SOAP

REST

Database table

Object

Purchaseorder

oaPurchaseorder

—

purchaseorder

Supported Commands

Add, Read, Modify, Delete

add(), read(), modify(), upsert(), delete()

—

The Purchaseorder object has the following standard properties:

Note:

Purchaseorder 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
`accounts_payableid`	`accounts_payable_id`	The accounts payable location for this purchase order.
`approval_status`	`approval_status`	A one-character string indicating the approval status of the purchase request. Possible values: O -Open P-Pending approval A -Approved R -Rejected
`attachmentid`	`attachment_id`	If non-zero, the attachment record associated with this purchase order.
`auto_track_payable_with_fulfilled`	`auto_track_payable_with_fulfilled`	A 1/0 field indicating that payability of quantities of items on this purchase order track automatically and directly with the fulfillment of those items.
`carrierid`	`carrier_id`	The carrier to be used for shipping. Ship Via.
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`currency`	`currency`	The currency this purchase order is in.
`date`	`date`	The date of the purchase order. See Date Fields.
`date_approved`	`date_approved`	The date the purchase order was approved. See Date Fields.
`date_expected`	`date_expected`	The date the materials are expected if known. See Date Fields.
`date_fulfilled`	`date_fulfilled`	The date on which all of the total quantity was fulfilled. See Date Fields.
`date_order_placed`	`date_order_placed`	The date the purchase order was placed with the vendor. See Date Fields.
`date_required`	`date_required`	The date the purchase items on this purchase order are required. See Date Fields.
`date_shipped`	`date_shipped`	The date the materials were shipped if known. See Date Fields.
`date_submitted`	`date_submitted`	The date the purchase order was submitted. See Date Fields.
`description`	`description`	The description or purpose for the purchase order.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.
`locationid`	`fob_location_id`	The F.O.B. location_id (DEPRECATED).
`name`	`name`	The name of the purchase order (Prefix +number).
`notes`	`notes`	Notes to print on the purchase order.
`number`	`number`	The purchase order number. Automatically assigned with an increment of 1, if not set when adding a purchase order. Must be unique.
`prefix`	`prefix`	A static alphanumeric purchase order number prefix.
`purchase_items_fulfilled`	`purchase_items_fulfilled`	The total number of fulfilled purchase items in the purchase order.
`quantity_fulfilled`	`quantity_fulfilled`	The quantity fulfilled on all the purchase items in this purchase order.
`receivingid`	`receiving_id`	The receiving location for this purchase order.
`ship_complete_only`	`ship_complete_only`	A 1/0 field indicating that full order must ship together.
`shipping_cost`	`shipping_cost`	The cost of shipping, if known. Dated by the date field.
`shipping_termsid`	`shipping_terms_id`	The ID of the associated shipping payment terms, indicating how the shipping costs will be charged.
`terms`	`terms`	Payment terms for this purchase order.
`total`	`total`	The purchase order total cost. Dated by the date field.
`total_purchase_items`	`total_purchase_items`	The total number of purchase items in the purchase order.
`total_quantity`	`total_quantity`	The total quantity of all the purchase items in this purchase order.
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`userid`	`user_id`	[Read-only] The ID of the user creating the purchase order. The purchasing agent.
`vendorid`	`vendor_id`	The ID of the associated vendor that the purchase order is for.

XML / SOAP

Database

Description

accounts_payableid

accounts_payable_id

The accounts payable location for this purchase order.

approval_status

A one-character string indicating the approval status of the purchase request. Possible values:

O -Open
P-Pending approval
A -Approved
R -Rejected

attachmentid

attachment_id

If non-zero, the attachment record associated with this purchase order.

auto_track_payable_with_fulfilled

A 1/0 field indicating that payability of quantities of items on this purchase order track automatically and directly with the fulfillment of those items.

carrierid

carrier_id

The carrier to be used for shipping. Ship Via.

created

[Read-only] Time the record was created. See Date Fields.

currency

The currency this purchase order is in.

date

The date of the purchase order. See Date Fields.

date_approved

The date the purchase order was approved. See Date Fields.

date_expected

The date the materials are expected if known. See Date Fields.

date_fulfilled

The date on which all of the total quantity was fulfilled. See Date Fields.

date_order_placed

The date the purchase order was placed with the vendor. See Date Fields.

date_required

The date the purchase items on this purchase order are required. See Date Fields.

date_shipped

The date the materials were shipped if known. See Date Fields.

date_submitted

The date the purchase order was submitted. See Date Fields.

description

The description or purpose for the purchase order.

id

[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.

locationid

fob_location_id

The F.O.B. location_id (DEPRECATED).

name

The name of the purchase order (Prefix +number).

notes

Notes to print on the purchase order.

number

The purchase order number. Automatically assigned with an increment of 1, if not set when adding a purchase order. Must be unique.

prefix

A static alphanumeric purchase order number prefix.

purchase_items_fulfilled

The total number of fulfilled purchase items in the purchase order.

quantity_fulfilled

The quantity fulfilled on all the purchase items in this purchase order.

receivingid

receiving_id

The receiving location for this purchase order.

ship_complete_only

A 1/0 field indicating that full order must ship together.

shipping_cost

The cost of shipping, if known. Dated by the date field.

shipping_termsid

shipping_terms_id

The ID of the associated shipping payment terms, indicating how the shipping costs will be charged.

terms

Payment terms for this purchase order.

total

The purchase order total cost. Dated by the date field.

total_purchase_items

The total number of purchase items in the purchase order.

total_quantity

The total quantity of all the purchase items in this purchase order.

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

userid

user_id

[Read-only] The ID of the user creating the purchase order. The purchasing agent.

vendorid

vendor_id

The ID of the associated vendor that the purchase order is for.

Usage Guidelines

You cannot delete a Purchaseorder object if this object is referenced by a Purchase_item object. Delete any dependent objects first before you delete a Purchaseorder object.