PurchaseOrderLineItems

Columns

Name

Type

ReadOnly

References

Filterable

Sortable

Description

LineId [KEY]

String

True

false

true

The Id of the line item of the purchase order.

PurchaseOrderId [KEY]

String

False

PurchaseOrders.Id

true

false

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 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.

Line_Id

String

False

false

false

The Id of the line item.

Line_Description

String

False

false

false

A description of the line item that appears in the printed record.

Line_Amount

Decimal

False

false

false

The amount of the line item. It represents the discount amount, charge amount, tax amount, or subtotal amount based on the value of the DetailType field.

Line_DetailType

String

False

false

false

The type of line in the transaction.

Line_ItemBasedExpenseLineDetail_ItemRef

String

False

Items.Id

false

false

The Id of the item of the line item. When a line lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored.

Line_ItemBasedExpenseLineDetail_ItemRef_Name

String

True

Items.Name

false

false

The name of the item of the line item. When a line lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored.

Line_ItemBasedExpenseLineDetail_ClassRef

String

False

Class.Id

false

false

The Id of the class for the line item.

Line_ItemBasedExpenseLineDetail_ClassRef_Name

String

True

Class.FullyQualifiedName

false

false

The name of the class for the line item.

Line_ItemBasedExpenseLineDetail_UnitPrice

Decimal

False

false

false

The price of the referenced item.

Line_ItemBasedExpenseLineDetail_Qty

Double

False

false

false

The number of items for the line.

Line_ItemBasedExpenseLineDetail_TaxCodeRef

String

False

TaxCodes.Id

false

false

The sales tax code for this item.

Line_ItemBasedExpenseLineDetail_CustomerRef

String

False

Customers.Id

false

false

The Id of the customer associated with the expense.

Line_ItemBasedExpenseLineDetail_CustomerRef_Name

String

True

Customers.DisplayName

false

false

The name of the customer associated with the expense.

Line_ItemBasedExpenseLineDetail_BillableStatus

String

False

false

false

The billable status of the expense.

The allowed values are Billable, NotBillable, HasBeenBilled.

Line_AccountBasedExpenseLineDetail_ClassRef

String

False

Class.Id

false

false

The Id of the class entity of the expense.

Line_AccountBasedExpenseLineDetail_ClassRef_Name

String

True

Class.FullyQualifiedName

false

false

The name of the class entity of the expense.

Line_AccountBasedExpenseLineDetail_CustomerRef

String

False

Customers.Id

false

false

The customer Id for the expense.

Line_AccountBasedExpenseLineDetail_CustomerRef_Name

String

True

Customers.DisplayName

false

false

The customer name for the expense.

Line_AccountBasedExpenseLineDetail_AccountRef

String

False

Accounts.Id

false

false

The Id of the expense account of the expense.

Line_AccountBasedExpenseLineDetail_AccountRef_Name

String

True

Accounts.Name

false

false

The name of the expense account of the expense.

Line_AccountBasedExpenseLineDetail_TaxCodeRef

String

False

TaxCodes.Id

false

false

The sales tax code for the expense.

Line_AccountBasedExpenseLineDetail_BillableStatus

String

False

false

false

The billable status of the expense.

The allowed values are Billable, NotBillable, HasBeenBilled.

Line_AccountBasedExpenseLineDetail_MarkupInfo_Value

Double

False

false

false

Markup value.

Line_AccountBasedExpenseLineDetail_MarkupInfo_Percent

Double

False

false

false

Markup amount expressed as a percent of charges already entered in the current transaction. To enter a rate of 10% use 10.0, not 0.01.

VendorRef

String

False

Vendors.Id

false

false

The Id of the vendor for this transaction.

VendorRef_Name

String

True

Vendors.DisplayName

false

false

The name of the vendor for this transaction.

APAccountRef

String

False

Accounts.Id

true

true

The accounts-payable account the bill is credited to. Many/most small businesses have a single accounts-payable account, so the account can be implied. When specified, the account must be a Liability account, and further, the subtype must be of type Payables.

APAccountRef_Name

String

True

Accounts.Name

false

false

The accounts-payable account to which the bill is credited. Many/most small businesses have a single accounts-payable account, so the account can be implied. When specified, the account must be a Liability account, and further, 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

The Id of the 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 vendor address.

VendorAddr_Line2

String

True

false

false

Second line of the vendor address.

VendorAddr_Line3

String

True

false

false

Third line of the vendor address.

VendorAddr_Line4

String

True

false

false

Fourth line of the vendor address.

VendorAddr_Line5

String

True

false

false

Fifth line of the vendor 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

The latitude coordinate of the geocoded vendor address.

VendorAddr_Long

String

True

false

false

The longitude coordinate of the geocoded vendor address.

ShipAddr_Id

String

False

false

false

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

ShipAddr_Line1

String

False

false

false

First line of the shipping address.

ShipAddr_Line2

String

False

false

false

Second line of the shipping address.

ShipAddr_Line3

String

False

false

false

Third line of the shipping address.

ShipAddr_Line4

String

False

false

false

Fourth line of the shipping address.

ShipAddr_Line5

String

False

false

false

Fifth line of the shipping 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 the USA, province name for Canada.

ShipAddr_PostalCode

String

False

false

false

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

ShipAddr_Note

String

False

false

false

Note for the customer.

ShipAddr_Lat

String

False

false

false

The latitude coordinate of the geocoded shipping address.

ShipAddr_Long

String

False

false

false

The longitude coordinate of the geocoded shipping address.

ShipMethodRef

String

False

false

false

The Id of the entity for the shipping method. This entity is a reference type of all Ids that are taken as input or output.

ShipMethodRef_Name

String

True

false

false

The name of the entity for the shipping method. This entity is a reference type of all Ids that are taken as input or output.

POStatus

String

False

false

false

Enumeration of status for purchase order.

The allowed values are Open, Closed.

TxnTaxDetail_TxnTaxCodeRef

String

False

TaxCodes.Id

false

false

The transaction tax code.

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 only 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

The currency exchange rate. This field is valid only if the company file is set up to use 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

Method in which tax is applied. This field is valid in the UK, AU, IN, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

Last updated