PurchaseOrders

Columns

Name

Type

ReadOnly

References

Filterable

Sortable

Description

Id [KEY]

String

True

true

true

The Id of the purchase order.

SyncToken

String

True

false

false

Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.

MetaData_CreateTime

Datetime

True

true

true

The time the record was created.

MetaData_LastUpdatedTime

Datetime

True

true

true

The time the record was last updated.

DocNumber

String

False

true

true

The reference number for the transaction.

TxnDate

Date

False

true

true

The date entered by the user when this transaction occurred.

PrivateNote

String

False

false

false

A private note about the transaction. This note will not appear on the transaction records by default.

LinkedTxnAggregate

String

False

false

false

An XML aggregate of transactions linked to the estimate.

LineAggregate

String

False

false

false

An XML aggregate of line items in the transaction.

CustomFieldAggregate

String

False

false

false

An XML aggregate of custom field information.

VendorRef

String

False

Vendors.Id

false

false

The Id of the vendor.

VendorRef_Name

String

True

Vendors.DisplayName

false

false

The name of the vendor.

APAccountRef

String

False

Accounts.Id

true

true

The Id of the accounts-payable account to which the bill is credited. This account is implied when a company has a single accounts-payable account. When specified, the account must be a Liability account and the subtype must be of type Payables.

APAccountRef_Name

String

True

Accounts.Name

false

false

The name of the accounts-payable account to which the bill is credited. This account is implied when a company has a single accounts-payable account. When specified, the account must be a Liability account and the subtype must be of type Payables.

TotalAmt

Decimal

True

true

true

The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, and discounts.

VendorAddr_Id

String

True

false

false

Id of the Intuit entity for the vendor address, mainly used for modifying the address. This field is assigned by the data service.

VendorAddr_Line1

String

True

false

false

First line of the address.

VendorAddr_Line2

String

True

false

false

Second line of the address.

VendorAddr_Line3

String

True

false

false

Third line of the address.

VendorAddr_Line4

String

True

false

false

Fourth line of the address.

VendorAddr_Line5

String

True

false

false

Fifth line of the address.

VendorAddr_City

String

True

false

false

City name.

VendorAddr_Country

String

True

false

false

Country name.

VendorAddr_CountrySubDivisionCode

String

True

false

false

Region within a country. For example, the state name for the USA and the province name for Canada.

VendorAddr_PostalCode

String

True

false

false

Postal code. For example, the zip code for the USA and Canada.

VendorAddr_Note

String

True

false

false

Note for the customer.

VendorAddr_Lat

String

True

false

false

Latitude coordinate of the geocoded vendor address.

VendorAddr_Long

String

True

false

false

Longitude coordinate of the geocoded vendor address.

ShipAddr_Id

String

False

false

false

Id of the Intuit entity for the shipping address, mainly used for modifying the address. Read-only; assigned by the data service.

ShipAddr_Line1

String

False

false

false

First line of the address.

ShipAddr_Line2

String

False

false

false

Second line of the address.

ShipAddr_Line3

String

False

false

false

Third line of the address.

ShipAddr_Line4

String

False

false

false

Fourth line of the address.

ShipAddr_Line5

String

False

false

false

Fifth line of the address.

ShipAddr_City

String

False

false

false

City name.

ShipAddr_Country

String

False

false

false

Country name.

ShipAddr_CountrySubDivisionCode

String

False

false

false

Region within a country. For example, state name for USA, province name for Canada.

ShipAddr_PostalCode

String

False

false

false

Postal code. For example, zip code for USA and Canada.

ShipAddr_Note

String

False

false

false

Note for the customer.

ShipAddr_Lat

String

False

false

false

Latitude coordinate of the Geocode (Geospacial Entity Object Code).

ShipAddr_Long

String

False

false

false

Longitude coordinate of the Geocode (Geospacial Entity Object Code).

ShipMethodRef

String

False

false

false

Reference type of all Ids that are taken as input or output.

ShipMethodRef_Name

String

True

false

false

Reference type of all Ids that are taken as input or output.

POStatus

String

False

false

false

Enumeration of the purchase order status.

The allowed values are Open, Closed.

POEmail_Address

String

False

false

false

Enumeration of the purchase order status.

The allowed values are Open, Closed.

TxnTaxDetail_TxnTaxCodeRef

String

False

TaxCodes.Id

false

false

The tax code of the transaction.

TxnTaxDetail_TotalTax

String

False

false

false

Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.

TxnTaxDetail_TaxLineAggregate

String

False

false

false

An XML aggregate of tax line items.

TaxCodeRef

String

False

TaxCodes.Id

false

false

The tax code for the purchase. This field is valid in the UK, AU, IN, and CA editions.

CurrencyRef

String

False

false

false

The Id of the currency used in the transaction.

CurrencyRef_Name

String

True

false

false

The name of the currency used in the transaction.

ExchangeRate

Decimal

False

false

false

Currency exchange rate. This field is valid only if the company file is set up to use the multicurrency feature. In QuickBooks, exchange rates are always recorded as the number of home currency units it takes to equal one foreign currency unit. This field is available for the UK, AU, IN, and CA editions.

GlobalTaxCalculation

String

False

false

false

The method used to apply the tax. This field is valid in the UK, AU, IN, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

Last updated