Purchases
Represents general purchase transactions, including credit-card charges, checks, or cash purchases, capturing spending outside of standard vendor bills.
Table Specific Information
Note: A Purchase object represents an expense, such as a purchase made from a vendor.
Select
All filterable columns support the following operators:
- =
- !=
- >=
- <=
- >
- <
- IN
- LIKE
- CONTAINS
The driver processes other filters client-side within the driver.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| Id [KEY] | String | True | True | True |
The unique identifier (Id) of the purchase transaction that is recorded in QuickBooks Online. | |
| SyncToken | String | True | False | False |
The version number of the object that is used to lock the object for use by one application at a time. As soon as an application modifies an object, its sync token is incremented. Attempts to modify an object specifying an older sync token 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 purchase record was created in QuickBooks Online. | |
| MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time when the purchase record was last updated in QuickBooks Online. | |
| DocNumber | String | False | True | True |
The reference number for the purchase transaction that is used to identify it in reports and on printed documents. | |
| TxnDate | Date | False | True | True |
The date of the purchase transaction that is entered by the user. This date determines when the transaction posts to accounts. | |
| PrivateNote | String | False | False | False |
A private note about the purchase transaction that does not appear on printed or shared transaction records. This field maps to the Memo field on the Check and CreditCard forms. | |
| LineAggregate | String | False | False | False |
An XML aggregate of all line items that are associated with the purchase transaction. This collection provides a structured breakdown of charges, items, or expense lines. | |
| AccountRef | String | False |
Accounts.Id | False | False |
The unique Id of the account that is associated with the purchase transaction. Check payments must reference a bank account, and credit-card purchases must reference a credit card account. |
| AccountRef_Name | String | True |
Accounts.Name | False | False |
The name of the account that is associated with the purchase transaction. Checks must reference a bank account, and credit-card purchases must reference a credit card account. |
| PaymentType | String | False | True | True |
The payment type for the purchase transaction (for example, Cash, Check, CreditCard). This determines how QuickBooks processes and categorizes the payment. The allowed values are Cash, Check, CreditCard. | |
| EntityRef | String | False | False | False |
The unique Id of the entity for the party that the purchase expense is associated with. This could be a vendor or another payee. | |
| EntityRef_Name | String | True | False | False |
The name of the party that the purchase expense is associated with. This provides a human-readable label for EntityRef. | |
| Credit | Boolean | False | False | False |
Indicates whether the transaction represents a credit-card credit. This field is valid only for the credit-card payment type. | |
| TotalAmt | Decimal | True | True | True |
The total monetary amount of the purchase transaction. This amount is determined by the sum of the line item amounts and includes all charges, allowances, taxes, and discounts. | |
| PrintStatus | String | False | False | False |
Indicates the print status of the purchase transaction. This field is applicable only for check transactions and is ignored for credit-card charges or refunds. | |
| DepartmentRef | String | False |
Departments.Id | False | False |
The unique Id of the department that is associated with the purchase transaction. This field stores the location of the transaction as defined using location tracking in QuickBooks Online. |
| DepartmentRef_Name | String | True |
Departments.Name | False | False |
The name of the department that is associated with the purchase transaction. This field stores the location of the transaction as defined using location tracking in QuickBooks Online. |
| TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
Specifies the tax code that is applied to the purchase transaction. This code determines which tax rates are used when calculating the total tax. |
| TxnTaxDetail_TotalTax | String | False | False | False |
The total tax calculated for the purchase transaction. This amount excludes any tax lines that are manually inserted into the transaction line list. | |
| TxnTaxDetail_TaxLineAggregate | String | False | False | False |
An XML aggregate containing all individual tax line items associated with the purchase transaction. This collection provides a structured breakdown of applied taxes. | |
| CurrencyRef | String | False | False | False |
The unique Id of the currency that is used in the purchase transaction. This field supports multicurrency operations in QuickBooks Online. | |
| CurrencyRef_Name | String | True | False | False |
The name of the currency that is used in the purchase transaction. This is a human-readable reference to the CurrencyRef field. | |
| ExchangeRate | Decimal | False | False | False |
The currency exchange rate that is applied to the purchase transaction. This field is valid only when 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 |
Specifies the method in which tax is applied to the purchase transaction (for example, TaxInclusive, TaxExclusive). This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable. | |
| TransactionLocationType | String | False | False | False |
Specifies the account location that is used for reporting and tax purposes. This field is valid only in the FR editions of QuickBooks Online. The allowed values are WithinFrance, FranceOverseas, OutsideFranceWithEU, OutsideEU. | |
| PaymentMethodRef | String | True | False | False |
The unique Id of the payment method that is associated with the purchase transaction. This Id links to the PaymentMethod entity in QuickBooks Online. | |
| PaymentMethodRef_Name | String | True |
PaymentMethods.Name | False | False |
The name of the payment method that is associated with the purchase transaction. This name provides a human-readable reference to the PaymentMethodRef field. |
| RecurDataRef | String | True | False | False |
The unique Id of the reference to the Recurring Transaction that is associated with this purchase. It captures what recurring-transaction template the purchase was created from. | |
| LinkedTxnAggregate | String | False | False | False |
An XML aggregate of transactions that are linked to the purchase transaction. This collection provides a structured list of related transactions for tracking and reconciliation. | |
| TxnSource | String | True | False | False |
An internal QuickBooks Online field that is used to specify the originating source of a credit card transaction. | |
| IncludeInAnnualTPAR | Boolean | True | False | False |
Indicates whether the supplier for this purchase is to be included in the annual Taxable Payments Annual Report (TPAR). This flag is required for compliance with Australian reporting rules. |