RecurringVendorCreditTransactions
Stores recurring templates for vendor credits, allowing automated application of credits or refunds from vendors on a scheduled basis.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| VendorCredit_Id [KEY] | String | True | True | True |
The unique identifier (Id) assigned by QuickBooks Online to this vendor-credit transaction. It is used to retrieve or reference the vendor credit programmatically and is required for updates or deletions. | |
| VendorCredit_SyncToken | String | True | False | False |
The version control token for this vendor-credit transaction that is used to prevent simultaneous conflicting updates. Each time the transaction is modified, QuickBooks Online increments this token to ensure only the latest version can be edited successfully. | |
| VendorCredit_MetaData_CreateTime | Datetime | True | True | True |
The date and time stamp (in Coordinated Universal Time) when QuickBooks Online created this vendor-credit transaction record. This timestamp provides an immutable audit trail for the transaction's creation. | |
| VendorCredit_MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time stamp (in Coordinated Universal Time) when this vendor-credit transaction was last modified in QuickBooks Online. This timestamp is important for detecting recent changes or synchronizing updates. | |
| VendorCredit_DocNumber | String | False | True | True |
The external or system-generated reference number assigned to this vendor credit. If no number is provided, QuickBooks Online automatically assigns the next sequential document number based on the company's numbering preferences. | |
| VendorCredit_TxnDate | Date | False | True | True |
The transaction date that determines when this vendor credit is posted to the books. For example, a vendor credit can be created on one date but backdated to affect a prior period's financial statements. | |
| VendorCredit_PrivateNote | String | False | False | False |
An internal memo or private note recorded on this vendor credit. These notes are not printed on customer-facing or vendor-facing forms by default and are intended for internal reference. | |
| VendorCredit_DepartmentRef | String | False |
Departments.Id | False | False |
The unique Id of the department or location that is linked to this vendor-credit transaction when location tracking is enabled in QuickBooks Online. This Id helps classify expenses or credits by department. |
| VendorCredit_DepartmentRef_Name | String | True |
Departments.Name | False | False |
The display name of the department or location that is linked to this vendor-credit transaction when location tracking is enabled in QuickBooks Online. |
| VendorCredit_TxnStatus | String | False | False | False |
The current workflow or posting status of the vendor-credit transaction. Depending on the transaction type, this field can display different enumerated values such as Paid, Partially Paid, or Pending. For sales transactions, the acceptable values are defined by the PaymentStatusEnum data type. For estimates, the acceptable values are defined by the QboEstimateStatusEnum data type. | |
| VendorCredit_LinkedTxnAggregate | String | False | False | False |
An XML aggregate that is serialized into a single string representing all transaction links that are associated with this vendor credit. Each LinkedTxn element typically includes the Id, Type, and an optional sequence number of the related transaction such as a Bill, PurchaseOrder, or CreditMemo. This collection enables you to view or maintain the cross-references that are used by QuickBooks Online to apply the vendor credit to one or more other transactions. | |
| VendorCredit_RecurDataRef | String | False | False | False |
The reference Id for the recurrence data record that governs how this vendor credit repeats automatically. | |
| VendorCredit_RecurDataRef_Name | String | True | False | False |
The descriptive name for the recurrence data record that governs how this vendor credit repeats automatically. | |
| VendorCredit_RecurringInfo_Name | String | False | False | False |
The name that is assigned to the recurring template or schedule that generates this vendor-credit transaction. | |
| VendorCredit_RecurringInfo_RecurType | String | False | False | False |
The recurrence pattern type (such as Scheduled, Unscheduled, or Reminder) that is associated with this vendor-credit transaction template. The allowed values are Automated, Reminded, UnScheduled. | |
| VendorCredit_RecurringInfo_Active | Boolean | False | False | False |
Indicates whether the recurring vendor-credit schedule is currently active (true) or inactive (false). Inactive schedules do not generate new transactions. | |
| VendorCredit_RecurringInfo_ScheduleInfo_IntervalType | String | False | False | False |
Specifies the unit of time for the recurrence interval such as Daily, Weekly, Monthly, or Yearly for this vendor-credit schedule. The allowed values are Yearly, Monthly, Weekly, Daily. | |
| VendorCredit_RecurringInfo_ScheduleInfo_NumInterval | Integer | False | False | False |
The numeric interval count (for example, every 2 weeks) that determines how often the vendor-credit recurs according to the specified interval type. | |
| VendorCredit_RecurringInfo_ScheduleInfo_DayOfWeek | String | False | False | False |
The day of the week (for example, Monday, Tuesday) on which the recurring vendor credit is scheduled to occur. | |
| VendorCredit_RecurringInfo_ScheduleInfo_WeekOfMonth | String | False | False | False |
The week of the month (for example, First, Second, Last) on which the recurring vendor credit is scheduled to occur. | |
| VendorCredit_RecurringInfo_ScheduleInfo_MaxOccurrences | String | False | False | False |
The maximum number of vendor-credit transactions to generate under this recurrence schedule before it stops automatically. | |
| VendorCredit_RecurringInfo_ScheduleInfo_RemindDays | String | False | False | False |
The number of days prior to the scheduled start date when QuickBooks Online should send a reminder for a recurring vendor credit of type Reminder. | |
| VendorCredit_RecurringInfo_ScheduleInfo_MonthOfYear | String | False | False | False |
The month of the year (for example, January, February) when the recurring vendor credit is scheduled if using an annual recurrence. | |
| VendorCredit_RecurringInfo_ScheduleInfo_DaysBefore | String | False | False | False |
The number of days in advance of the scheduled date to create or notify about the vendor-credit transaction. | |
| VendorCredit_RecurringInfo_ScheduleInfo_DayOfMonth | String | False | False | False |
The calendar day of the month (for example, 1, 15, 30) when the recurring vendor credit is scheduled to occur. | |
| VendorCredit_RecurringInfo_ScheduleInfo_StartDate | Datetime | False | False | False |
The start date and time stamp when the recurring vendor-credit schedule becomes effective in QuickBooks Online. | |
| VendorCredit_RecurringInfo_ScheduleInfo_NextDate | Datetime | False | False | False |
The next scheduled date and time stamp on which QuickBooks Online will create or prompt for this vendor-credit transaction. | |
| VendorCredit_RecurringInfo_ScheduleInfo_EndDate | Datetime | False | False | False |
The end date and time stamp on which the recurring vendor-credit schedule ceases to create new transactions automatically. | |
| VendorCredit_RecurringInfo_ScheduleInfo_PreviousDate | Datetime | False | False | False |
The most recent date and time stamp when QuickBooks Online generated or prompted for this vendor-credit transaction under the recurrence schedule. | |
| VendorCredit_LineAggregate | String | False | False | False |
An XML aggregate that is serialized into a single string representing the collection of line entries on the vendor credit. Each line typically includes elements such as Line/Id, Line/LineNum, Line/Amount, Line/DetailType, Line/Description, and either Line/AccountBasedExpenseLineDetail (with AccountRef, ClassRef, CustomerRef, TaxCodeRef, BillableStatus) or Line/ItemBasedExpenseLineDetail (with ItemRef, Qty, UnitPrice, TaxCodeRef). | |
| VendorCredit_VendorRef | String | False |
Vendors.Id | True | False |
The unique Id of the vendor to whom this credit is issued. |
| VendorCredit_VendorRef_Name | String | True |
Vendors.DisplayName | False | False |
The display name of the vendor to whom this credit is issued. |
| VendorCredit_APAccountRef | String | False |
Accounts.Id | True | True |
The unique Id of the accounts-payable liability account to which this vendor credit is posted. If only one accounts-payable account exists, QuickBooks Online implies it automatically. When specified, the account must be a Liability account with a subtype of Payables. |
| VendorCredit_APAccountRef_Name | String | True |
Accounts.Name | False | False |
The display name of the accounts-payable liability account to which this vendor credit is posted. If only one accounts-payable account exists, QuickBooks Online implies it automatically. When specified, the account must be a Liability account with a subtype of Payables. |
| VendorCredit_TotalAmt | Decimal | False | True | True |
The total amount of the vendor credit as calculated from all included line items. This includes charges, allowances, taxes, and discounts applied within the transaction. | |
| VendorCredit_CurrencyRef | String | False | False | False |
The unique Id of the currency in which this vendor-credit transaction is recorded when multicurrency is enabled. | |
| VendorCredit_CurrencyRef_Name | String | True | False | False |
The display name of the currency in which this vendor-credit transaction is recorded when multicurrency is enabled. | |
| VendorCredit_ExchangeRate | Decimal | False | False | False |
The currency exchange rate that QuickBooks Online applies to convert this vendor-credit amount to the home currency. This field is valid only when multicurrency is enabled. In QuickBooks Online, 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. | |
| VendorCredit_GlobalTaxCalculation | String | False | False | False |
The method by which QuickBooks Online applies sales tax to this vendor-credit transaction. This field is valid in the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable. |