RecurringPurchaseTransactions
Create and query QuickBooks Recurring Transaction for Purchases.
Columns
Name | Type | ReadOnly | References | Filterable | Sortable | Description |
Purchase_Id [KEY] | String | True | True | True |
The Id of the purchase. | |
Purchase_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. | |
Purchase_MetaData_CreateTime | Datetime | True | True | True |
The time the record was created. | |
Purchase_MetaData_LastUpdatedTime | Datetime | True | True | True |
The time the record was last updated. | |
Purchase_DocNumber | String | False | True | True |
Reference number for the transaction. | |
Purchase_TxnDate | Date | False | True | True |
The date when this transaction occurred. | |
Purchase_PrivateNote | String | False | False | False |
A private note about the transaction. This note will not appear on the transaction records by default. This field maps to the Memo field on the Check and CreditCard form. | |
Purchase_DepartmentRef | String | False |
Departments.Id | False | False |
The Id of the department, which stores the location of the transaction as defined using location tracking in QuickBooks Online. |
Purchase_DepartmentRef_Name | String | True |
Departments.Name | False | False |
The name of the department, which stores the location of the transaction as defined using location tracking in QuickBooks Online. |
Purchase_TxnStatus | String | False | False | False |
The status of the transaction. Depending on the transaction type it may have different values. For sales transactions, the acceptable values are defined in PaymentStatusEnum. For estimates, the values accepted are defined in QboEstimateStatusEnum. | |
Purchase_LinkedTxnAggregate | String | False | False | False |
Zero or more linked transactions. | |
Purchase_RecurDataRef | String | False | False | False |
The Recurrence Data reference. | |
Purchase_RecurDataRef_Name | String | True | False | False |
An identifying name for the object. | |
Purchase_RecurringInfo_Name | String | False | False | False |
The Recurring Info name. | |
Purchase_RecurringInfo_RecurType | String | False | False | False |
The Recurring Info recurring type. The allowed values are Automated, Reminded, UnScheduled. | |
Purchase_RecurringInfo_Active | Boolean | False | False | False |
The Recurring Info is active or not. | |
Purchase_RecurringInfo_ScheduleInfo_IntervalType | String | False | False | False |
The Recurring Info interval type. The allowed values are Yearly, Monthly, Weekly, Daily. | |
Purchase_RecurringInfo_ScheduleInfo_NumInterval | Integer | False | False | False |
The Recurring Info num interval. | |
Purchase_RecurringInfo_ScheduleInfo_DayOfWeek | String | False | False | False |
The Recurring Info day of week. | |
Purchase_RecurringInfo_ScheduleInfo_WeekOfMonth | String | False | False | False |
The Recurring Info week of month. | |
Purchase_RecurringInfo_ScheduleInfo_MaxOccurrences | String | False | False | False |
The max number of recurring occurrences. | |
Purchase_RecurringInfo_ScheduleInfo_RemindDays | String | False | False | False |
The days before start date for a reminded RecurType. | |
Purchase_RecurringInfo_ScheduleInfo_MonthOfYear | String | False | False | False |
The month of the year. | |
Purchase_RecurringInfo_ScheduleInfo_DaysBefore | String | False | False | False |
The days before the scheduled date. | |
Purchase_RecurringInfo_ScheduleInfo_DayOfMonth | String | False | False | False |
The day of the month. | |
Purchase_RecurringInfo_ScheduleInfo_StartDate | Datetime | False | False | False |
The Recurring Info start date. | |
Purchase_RecurringInfo_ScheduleInfo_NextDate | Datetime | False | False | False |
The Recurring Info next date. | |
Purchase_RecurringInfo_ScheduleInfo_EndDate | Datetime | False | False | False |
The end date for the recurring schedule. | |
Purchase_RecurringInfo_ScheduleInfo_PreviousDate | Datetime | False | False | False |
The Recurring Info previous date. | |
Purchase_LineAggregate | String | False | False | False |
A line item of a transaction. | |
Purchase_AccountRef | String | False |
Accounts.Id | False | False |
The Id of the account associated with the purchase. Check payments should reference a bank account and credit card purchases should refer to a credit card account. |
Purchase_AccountRef_Name | String | True |
Accounts.Name | False | False |
A name that identifies the account associated with the purchase. Checks should reference a bank account and credit card purchases should refer to a credit card account. |
Purchase_PaymentType | String | False | True | True |
The payment type. The allowed values are Cash, Check, CreditCard. | |
Purchase_EntityRef | String | False | False | False |
The Id of the entity for the party the expense is associated with. | |
Purchase_EntityRef_Name | String | True | False | False |
A name that identifies the party the expense is associated with. | |
Purchase_Credit | Boolean | False | False | False |
This field is valid only for the credit card payment type. | |
Purchase_TotalAmt | Decimal | True | True | True |
The total amount due, determined by the sum of the line item amounts. This includes all charges, allowances, taxes, discounts, etc. | |
Purchase_PrintStatus | String | False | False | False |
The print status of the purchase. This field is applicable only for checks and ignored for credit card charges or refunds. | |
Purchase_Status | String | True | False | False |
The status of the purchase. | |
Purchase_TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
The transaction tax code. |
Purchase_TxnTaxDetail_TotalTax | String | False | False | False |
Total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list. | |
Purchase_TxnTaxDetail_TaxLineAggregate | String | False | False | False |
An XML aggregate of tax line items. | |
Purchase_CurrencyRef | String | False | False | False |
The Id of the currency used in the transaction. | |
Purchase_CurrencyRef_Name | String | True | False | False |
The name of the currency used in the transaction. | |
Purchase_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, IN, and CA editions. | |
Purchase_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. |