MCP Server for QuickBooks Online

Build 25.0.9440

PurchaseOrderLineItems

Contains detailed line items for purchase orders, specifying products or services requested, quantities, expected costs, and vendor references.

Table Specific Information

PurchaseOrders may be inserted, queried, or updated via the PurchaseOrders or PurchaseOrderLineItems tables. PurchaseOrders may be deleted by using the PurchaseOrders table.

Select

All filterable columns support the following operators:

  • =
  • !=
  • >=
  • <=
  • >
  • <
  • IN
  • LIKE
  • CONTAINS

The driver processes other filters client-side within the driver.

Insert

To add a PurchaseOrder, specify the Vendor, TotalAmt, and at least one Line Item. The following shows an example of inserting multiple PurchaseOrders, each with a single line. To insert a PurchaseOrder with multiple lines, see the example on the PurchaseOrders table. 

INSERT INTO PurchaseOrderLineItems#TEMP (VendorRef, Line_Amount, Line_DetailType, Line_ItemBasedExpenseLineDetail_ItemRef, TotalAmt) VALUES ('21', 0.01, 'ItemBasedExpenseLineDetail', '2',  0.03)
INSERT INTO PurchaseOrderLineItems#TEMP (VendorRef, Line_Amount, Line_DetailType, Line_ItemBasedExpenseLineDetail_ItemRef, TotalAmt) VALUES ('21', 0.02, 'ItemBasedExpenseLineDetail', '3', 0.03)
INSERT INTO PurchaseOrderLineItems (VendorRef, Line_Amount, Line_DetailType, Line_ItemBasedExpenseLineDetail_ItemRef, TotalAmt) SELECT VendorRef, Line_Amount, Line_DetailType, Line_ItemBasedExpenseLineDetail_ItemRef, TotalAmt FROM PurchaseOrderLineItems#TEMP

Columns

Name Type ReadOnly References Filterable Sortable Description
LineId [KEY] String True False False

The unique Id (Id) of the line item of the purchase order.

PurchaseOrderId [KEY] String False

PurchaseOrders.Id

True False

The unique Id of the purchase order that is linked to this line item.

SyncToken String True False False

The version number of the purchase-order object. This number 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 fail. Only the latest version of the object is maintained by QuickBooks Online.

MetaData_CreateTime Datetime True True True

The date and time when the record was created in QuickBooks Online.

MetaData_LastUpdatedTime Datetime True True True

The date and time when the record was last updated in QuickBooks Online.

DocNumber String False True True

The reference number for the purchase-order transaction as entered by the user or generated by QuickBooks Online.

TxnDate Date False True True

The date when this purchase-order transaction occurred as entered by the user.

PrivateNote String False False False

A private note about the purchase-order transaction that does not appear on the transaction records by default. This field maps to the Memo field on the Check and CreditCard forms.

LinkedTxnAggregate String False False False

An XML aggregate of transactions that are linked to the purchase order, such as bills or vendor credits applied to it.

Line_Id String False False False

The unique Id of the individual line item within the purchase order.

Line_Description String False False False

A description of the line item that appears in the printed or displayed record for the purchase order.

Line_Amount Decimal False False False

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

Line_DetailType String False False False

The type of line in the transaction that is used to classify whether the line represents an item, an expense, a group, or other details.

Line_ItemBasedExpenseLineDetail_ItemRef String False

Items.Id

False False

The unique Id of the item of the line item that is referenced. When a line lacks an item reference, 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 that is referenced. When a line lacks an item reference, it is treated as documentation and the Line_Amount field is ignored.

Line_ItemBasedExpenseLineDetail_ClassRef String False

Class.Id

False False

The unique Id of the class for the line item that is used for tracking and reporting.

Line_ItemBasedExpenseLineDetail_ClassRef_Name String True

Class.FullyQualifiedName

False False

The name of the class for the line item that is used for tracking and reporting.

Line_ItemBasedExpenseLineDetail_UnitPrice Decimal False False False

The unit price of the referenced item as specified on the purchase order.

Line_ItemBasedExpenseLineDetail_Qty Double False False False

The number of items for the line that is being purchased.

Line_ItemBasedExpenseLineDetail_TaxCodeRef String False

TaxCodes.Id

False False

The sales tax code for this item that is used to calculate the tax amount for the purchase order.

Line_ItemBasedExpenseLineDetail_CustomerRef String False

Customers.Id

False False

The unique Id of the customer that is associated with the expense for job costing or billable tracking purposes.

Line_ItemBasedExpenseLineDetail_CustomerRef_Name String True

Customers.DisplayName

False False

The name of the customer that is associated with the expense for job costing or billable tracking purposes.

Line_ItemBasedExpenseLineDetail_BillableStatus String False False False

The billable status of the expense that indicates whether the amount can be billed to a customer.

The allowed values are Billable, NotBillable, HasBeenBilled.

Line_AccountBasedExpenseLineDetail_ClassRef String False

Class.Id

False False

The unique Id of the class entity of the expense line that is used for tracking and reporting.

Line_AccountBasedExpenseLineDetail_ClassRef_Name String True

Class.FullyQualifiedName

False False

The name of the class entity of the expense line that is used for tracking and reporting.

Line_AccountBasedExpenseLineDetail_CustomerRef String False

Customers.Id

False False

The unique Id of the customer that is associated with the expense line for job costing or billable tracking purposes.

Line_AccountBasedExpenseLineDetail_CustomerRef_Name String True

Customers.DisplayName

False False

The name of the customer that is associated with the expense line for job costing or billable tracking purposes.

Line_AccountBasedExpenseLineDetail_AccountRef String False

Accounts.Id

False False

The unique Id of the expense account of the expense line that records the purchase-order amount.

Line_AccountBasedExpenseLineDetail_AccountRef_Name String True

Accounts.Name

False False

The name of the expense account of the expense line that records the purchase-order amount.

Line_AccountBasedExpenseLineDetail_TaxCodeRef String False

TaxCodes.Id

False False

The sales tax code for the expense line that is used to calculate the tax amount.

Line_AccountBasedExpenseLineDetail_BillableStatus String False False False

The billable status of the expense line that indicates whether the amount can be billed to a customer.

The allowed values are Billable, NotBillable, HasBeenBilled.

Line_AccountBasedExpenseLineDetail_MarkupInfo_Value Double False False False

The markup value applied to the expense line item to increase the price over the base cost.

Line_AccountBasedExpenseLineDetail_MarkupInfo_Percent Double False False False

The markup amount expressed as a percent of charges already entered in the current transaction. For example, to enter a rate of 10%, use 10.0, not 0.01.

VendorRef String False

Vendors.Id

False False

The unique Id of the vendor for this purchase-order transaction.

VendorRef_Name String True

Vendors.DisplayName

False False

The name of the vendor that is associated with this purchase-order transaction.

APAccountRef String False

Accounts.Id

False False

The unique Id of the accounts-payable account that is credited for the bill. Many or 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 the subtype must be of type Payables.

APAccountRef_Name String True

Accounts.Name

False False

The name of the accounts-payable account that is credited for the bill. Many or 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 the subtype must be of type Payables.

TotalAmt Decimal True True True

The total monetary amount due for the purchase order that is determined by the sum of the line item amounts. This total includes all charges, allowances, taxes, and discounts.

VendorAddr_Id String True False False

The unique Id of the entity for the vendor address that is mainly used for modifying the address. This field is assigned by the data service.

VendorAddr_Line1 String True False False

The first line of the vendor address.

VendorAddr_Line2 String True False False

The second line of the vendor address.

VendorAddr_Line3 String True False False

The third line of the vendor address.

VendorAddr_Line4 String True False False

The fourth line of the vendor address.

VendorAddr_Line5 String True False False

The fifth line of the vendor address.

VendorAddr_City String True False False

The name of the city in the vendor address.

VendorAddr_Country String True False False

The name of the country in the vendor address.

VendorAddr_CountrySubDivisionCode String True False False

The region within a country in the vendor address. For example, this value is the state name for the USA or the province name for Canada.

VendorAddr_PostalCode String True False False

The postal code in the vendor address. For example, this value is the ZIP code for the USA or the postal code for Canada.

VendorAddr_Lat String True False False

The latitude coordinate of the geocoded vendor address that is stored in QuickBooks Online.

VendorAddr_Long String True False False

The longitude coordinate of the geocoded vendor address that is stored in QuickBooks Online.

ShipAddr_Id String False False False

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

ShipAddr_Line1 String False False False

The first line of the shipping address.

ShipAddr_Line2 String False False False

The second line of the shipping address.

ShipAddr_Line3 String False False False

The third line of the shipping address.

ShipAddr_Line4 String False False False

The fourth line of the shipping address.

ShipAddr_Line5 String False False False

The fifth line of the shipping address.

ShipAddr_City String False False False

The name of the city in the shipping address.

ShipAddr_Country String False False False

The name of the country in the shipping address.

ShipAddr_CountrySubDivisionCode String False False False

The region within a country in the shipping address. For example, this value is the state name for the USA or the province name for Canada.

ShipAddr_PostalCode String False False False

The postal code in the shipping address. For example, this value is the ZIP code for the USA or the postal code for Canada.

ShipAddr_Lat String False False False

The latitude coordinate of the geocoded shipping address that is stored in QuickBooks Online.

ShipAddr_Long String False False False

The longitude coordinate of the geocoded shipping address that is stored in QuickBooks Online.

ShipMethodRef String False False False

The unique Id of the entity for the shipping method that is used for this purchase order. 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 that is used for this purchase order. This entity is a reference type of all Ids that are taken as input or output.

POStatus String False False False

An enumeration that represents the current status of the purchase order, such as Open, Closed, or Void.

The allowed values are Open, Closed.

TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

False False

The transaction tax code that is applied to the purchase order.

TxnTaxDetail_TotalTax String False False False

The total tax that is calculated for the purchase order transaction, excluding any tax lines that are manually inserted into the transaction line list.

TxnTaxDetail_TaxLineAggregate String False False False

An XML aggregate of all tax line items that are associated with the purchase order.

CurrencyRef String False False False

The unique Id of the currency that is used in the purchase order transaction.

CurrencyRef_Name String True False False

The name of the currency that is used in the purchase-order transaction.

ExchangeRate Decimal False False False

The 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, and CA editions.

GlobalTaxCalculation String False False False

The method in which tax is applied to the purchase order. This field is valid in the UK, AU, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9440