class
object | null
required

The purchase order's class. Classes can be used to categorize objects into meaningful segments, such as department, location, or type of work. In QuickBooks, class tracking is off by default. A class defined here is automatically used in this purchase order's line items unless overridden at the line item level.

createdAt
string
required

The date and time when this purchase order was created, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

currency
object | null
required

The purchase order's currency. For built-in currencies, the name and code are standard international values. For user-defined currencies, all values are editable.

customFields
object[]
required

The custom fields for the purchase order object, added as user-defined data extensions, not included in the standard QuickBooks object.

documentTemplate
object | null
required

The predefined template in QuickBooks that determines the layout and formatting for this purchase order when printed or displayed.

dueDate
string | null
required

The date by which this purchase order must be paid, in ISO 8601 format (YYYY-MM-DD).

exchangeRate
number | null
required

The market exchange rate between this purchase order's currency and the home currency in QuickBooks at the time of this transaction. Represented as a decimal value (e.g., 1.2345 for 1 EUR = 1.2345 USD if USD is the home currency).

expectedDate
string | null
required

The date on which shipment of this purchase order is expected to be completed, in ISO 8601 format (YYYY-MM-DD).

externalId
string | null
required

A globally unique identifier (GUID) you, the developer, can provide for tracking this object in your external system.

id
string
required

The unique identifier assigned by QuickBooks to this purchase order. This ID is unique across all transaction types.

inventorySite
object | null
required

The site location where inventory for the item associated with this purchase order is stored.

isFullyReceived
boolean | null
required

Indicates whether all items in this purchase order have been received and none of them were closed manually.

isManuallyClosed
boolean
required

Indicates whether this purchase order has been manually marked as closed, even if all items have not been received or the sale has not been cancelled. Once the purchase order is marked as closed, all of its line items become closed as well. You cannot change isManuallyClosed to false after the purchase order has been fully received.

isQueuedForEmail
boolean | null
required

Indicates whether this purchase order is included in the queue of documents for QuickBooks to email to the customer.

isQueuedForPrint
boolean | null
required

Indicates whether this purchase order is included in the queue of documents for QuickBooks to print.

lineGroups
object[]
required

The purchase order's line item groups, each representing a predefined set of related items.

lines
object[]
required

The purchase order's line items, each representing a single product or service ordered.

linkedTransactions
object[]
required

The purchase order's linked transactions, such as payments applied, credits used, or associated purchase orders.

IMPORTANT: You must specify the parameter includeLinkedTransactions when fetching a list of purchase orders to receive this field because it is not returned by default.

memo
string | null
required

A memo or note for this purchase order that appears in reports, but not on the purchase order.

objectType
string
required

The type of object. This value is always "qbd_purchase_order".

Allowed value: "qbd_purchase_order"
otherCustomField1
string | null
required

A built-in custom field for additional information specific to this purchase order. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all purchase orders for convenience. Developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.

otherCustomField2
string | null
required

A second built-in custom field for additional information specific to this purchase order. Unlike the user-defined fields in the customFields array, this is a standard QuickBooks field that exists for all purchase orders for convenience. Like otherCustomField1, developers often use this field for tracking information that doesn't fit into other standard QuickBooks fields. Hidden by default in the QuickBooks UI.

refNumber
string | null
required

The case-sensitive user-defined reference number for this purchase order, which can be used to identify the transaction in QuickBooks. This value is not required to be unique and can be arbitrarily changed by the QuickBooks user.

revisionNumber
string
required

The current revision number of this purchase order object, which changes each time the object is modified. When updating this object, you must provide the most recent revisionNumber to ensure you're working with the latest data; otherwise, the update will return an error.

salesTaxCode
object | null
required

The sales-tax code for this purchase order, determining whether it is taxable or non-taxable. If set, this overrides any sales-tax codes defined on the vendor. This can be overridden on the purchase order's individual lines.

Default codes include "Non" (non-taxable) and "Tax" (taxable), but custom codes can also be created in QuickBooks. If QuickBooks is not set up to charge sales tax (via the "Do You Charge Sales Tax?" preference), it will assign the default non-taxable code to all sales.

shipmentOrigin
string | null
required

The origin location from where the product associated with this purchase order is shipped. This is the point at which ownership and liability for goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB" for this field, which stands for "freight on board". This field is informational and has no accounting implications.

shippingAddress
object | null
required

The purchase order's shipping address.

shippingMethod
object | null
required

The shipping method used for this purchase order, such as standard mail or overnight delivery.

shipToEntity
object | null
required

The customer, vendor, employee, or other entity to whom this purchase order is to be shipped.

terms
object | null
required

The purchase order's payment terms, defining when payment is due and any applicable discounts.

totalAmount
string
required

The total monetary amount of this purchase order, equivalent to the sum of the amounts in lines and lineGroups, represented as a decimal string.

totalAmountInHomeCurrency
string | null
required

The total monetary amount of this purchase order converted to the home currency of the QuickBooks company file. Represented as a decimal string.

transactionDate
string
required

The date of this purchase order, in ISO 8601 format (YYYY-MM-DD).

updatedAt
string
required

The date and time when this purchase order was last updated, in ISO 8601 format (YYYY-MM-DDThh:mm:ss±hh:mm). The time zone is the same as the user's time zone in QuickBooks.

vendor
object
required

The vendor who sent this purchase order for goods or services purchased.

vendorAddress
object | null
required

The address of the vendor who sent this purchase order.

vendorMessage
string | null
required

A message to be printed on this purchase order for the vendor to read.