RecurringPurchaseTransactions
Represents recurring purchase templates for expenses, allowing businesses to schedule automatic entry of regular vendor purchases.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| Purchase_Id [KEY] | String | True | True | True |
The unique identifier (Id) of the recurring purchase transaction in QuickBooks Online. | |
| Purchase_SyncToken | String | True | False | False |
The version number of the object that is used to lock the purchase transaction for use by one application at a time. As soon as an application modifies the 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. | |
| Purchase_MetaData_CreateTime | Datetime | True | True | True |
The date and time when the recurring purchase transaction record was created in QuickBooks Online. | |
| Purchase_MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time when the recurring purchase transaction record was last updated in QuickBooks Online. | |
| Purchase_DocNumber | String | False | True | True |
The reference number assigned to the recurring purchase transaction. | |
| Purchase_TxnDate | Date | False | True | True |
The date entered by the user when this recurring purchase transaction occurred. | |
| Purchase_PrivateNote | String | False | False | False |
A private note about the recurring purchase transaction that does 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 unique Id of the department or location that is associated with the recurring purchase transaction as defined using location tracking in QuickBooks Online. |
| Purchase_DepartmentRef_Name | String | True |
Departments.Name | False | False |
The name of the department or location that is associated with the recurring purchase transaction as defined using location tracking in QuickBooks Online. |
| Purchase_TxnStatus | String | False | False | False |
The status of the recurring purchase transaction. Depending on the transaction type, this field may have different values. For sales transactions, the acceptable values are defined in PaymentStatusEnum. For estimates, the accepted values are defined in QboEstimateStatusEnum. | |
| Purchase_LinkedTxnAggregate | String | False | False | False |
An XML aggregate containing zero or more linked transactions that are associated with the recurring purchase transaction. | |
| Purchase_RecurDataRef | String | False | False | False |
The unique Id of the recurrence data reference that identifies the recurring purchase transaction template or schedule. | |
| Purchase_RecurDataRef_Name | String | True | False | False |
The name of the recurrence data reference that identifies the recurring purchase transaction template or schedule. | |
| Purchase_RecurringInfo_Name | String | False | False | False |
The descriptive name of the recurring purchase transaction schedule or template. | |
| Purchase_RecurringInfo_RecurType | String | False | False | False |
The recurring type of the purchase transaction schedule, such as scheduled, reminder, or unscheduled. The allowed values are Automated, Reminded, UnScheduled. | |
| Purchase_RecurringInfo_Active | Boolean | False | False | False |
Indicates whether the recurring purchase transaction schedule is active or inactive. | |
| Purchase_RecurringInfo_ScheduleInfo_IntervalType | String | False | False | False |
The interval type of the recurring purchase transaction schedule that defines how often the purchase recurs (for example, weekly, monthly, or yearly). The allowed values are Yearly, Monthly, Weekly, Daily. | |
| Purchase_RecurringInfo_ScheduleInfo_NumInterval | Integer | False | False | False |
The number of intervals for the recurring purchase transaction schedule. This value determines how frequently the purchase recurs based on the interval type. | |
| Purchase_RecurringInfo_ScheduleInfo_DayOfWeek | String | False | False | False |
The day of the week on which the recurring purchase transaction is scheduled to occur when the interval type is weekly. | |
| Purchase_RecurringInfo_ScheduleInfo_WeekOfMonth | String | False | False | False |
The week of the month on which the recurring purchase transaction is scheduled to occur when the interval type is monthly. | |
| Purchase_RecurringInfo_ScheduleInfo_MaxOccurrences | String | False | False | False |
The maximum number of occurrences allowed for the recurring purchase transaction schedule. | |
| Purchase_RecurringInfo_ScheduleInfo_RemindDays | String | False | False | False |
The number of days before the start date on which a reminder for the recurring purchase transaction should be sent. | |
| Purchase_RecurringInfo_ScheduleInfo_MonthOfYear | String | False | False | False |
The month of the year on which the recurring purchase transaction is scheduled to occur when the interval type is yearly. | |
| Purchase_RecurringInfo_ScheduleInfo_DaysBefore | String | False | False | False |
The number of days before the scheduled date on which the recurring purchase transaction is processed or triggered. | |
| Purchase_RecurringInfo_ScheduleInfo_DayOfMonth | String | False | False | False |
The day of the month on which the recurring purchase transaction is scheduled to occur. | |
| Purchase_RecurringInfo_ScheduleInfo_StartDate | Datetime | False | False | False |
The start date of the recurring purchase transaction schedule that is associated with the recurrence template. | |
| Purchase_RecurringInfo_ScheduleInfo_NextDate | Datetime | False | False | False |
The next scheduled date for the recurring purchase transaction to occur. | |
| Purchase_RecurringInfo_ScheduleInfo_EndDate | Datetime | False | False | False |
The end date of the recurring purchase transaction schedule when no further occurrences are generated. | |
| Purchase_RecurringInfo_ScheduleInfo_PreviousDate | Datetime | False | False | False |
The previous scheduled date on which the recurring purchase transaction occurred. | |
| Purchase_LineAggregate | String | False | False | False |
An XML aggregate containing all individual line items that make up the recurring purchase transaction, including details such as products, services, quantities, and amounts for each line. | |
| Purchase_AccountRef | String | False |
Accounts.Id | False | False |
The Id of the account associated with the recurring purchase transaction. Check payments should reference a bank account and credit card purchases should reference a credit card account. |
| Purchase_AccountRef_Name | String | True |
Accounts.Name | False | False |
The name of the account associated with the recurring purchase transaction. Check payments should reference a bank account and credit card purchases should reference a credit card account. |
| Purchase_PaymentType | String | False | True | True |
The payment type used for the recurring purchase transaction. The allowed values are Cash, Check, CreditCard. | |
| Purchase_EntityRef | String | False | False | False |
The Id of the entity for the party the expense in the recurring purchase transaction is associated with. | |
| Purchase_EntityRef_Name | String | True | False | False |
The name of the party the expense in the recurring purchase transaction is associated with. | |
| Purchase_Credit | Boolean | False | False | False |
Indicates whether the recurring purchase transaction is a credit card payment. This field is valid only for the credit card payment type. | |
| Purchase_TotalAmt | Decimal | True | True | True |
The total monetary amount of the recurring purchase transaction determined by the sum of the line item amounts. This includes all charges, allowances, taxes, and discounts. | |
| Purchase_PrintStatus | String | False | False | False |
The print status of the recurring purchase transaction. This field is applicable only for checks and is ignored for credit card charges or refunds. | |
| Purchase_Status | String | True | False | False |
The status of the recurring purchase transaction. | |
| Purchase_TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
The unique Id of the tax code that is applied to the recurring purchase transaction. |
| Purchase_TxnTaxDetail_TotalTax | String | False | False | False |
The total tax amount calculated for the recurring purchase transaction, excluding any tax lines manually inserted into the transaction line list. | |
| Purchase_TxnTaxDetail_TaxLineAggregate | String | False | False | False |
An XML aggregate containing all tax line items associated with the recurring purchase transaction, providing detailed information about each tax charge or credit applied so QuickBooks can calculate and report taxes accurately for the transaction. | |
| Purchase_CurrencyRef | String | False | False | False |
The Id of the currency used in the recurring purchase transaction. | |
| Purchase_CurrencyRef_Name | String | True | False | False |
The name of the currency used in the recurring purchase transaction. | |
| Purchase_ExchangeRate | Decimal | False | False | False |
The currency exchange rate for the recurring purchase transaction. 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. | |
| Purchase_GlobalTaxCalculation | String | False | False | False |
The method used to apply tax to the recurring purchase transaction. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable. |