RecurringDepositTransactions
Stores recurring templates for deposit transactions, enabling businesses to automate repetitive deposits into bank accounts.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| Deposit_Id [KEY] | String | True | True | True |
The unique identifier (Id) of the deposit that is part of the recurring deposit transaction. | |
| Deposit_SyncToken | String | True | False | False |
The version number of the object that is used to lock the deposit 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. | |
| Deposit_MetaData_CreateTime | Datetime | True | True | True |
The date and time when the recurring deposit record was created in QuickBooks Online. | |
| Deposit_MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time when the recurring deposit record was last updated in QuickBooks Online. | |
| Deposit_TxnDate | Date | False | True | True |
The date that is entered by the user when this recurring deposit transaction occurred. | |
| Deposit_PrivateNote | String | False | False | False |
A private note for the recurring deposit transaction that does not appear on the transaction records by default. | |
| Deposit_RecurDataRef | String | False | False | False |
The unique Id of the recurrence data reference that identifies the recurring deposit template or schedule. | |
| Deposit_RecurDataRef_Name | String | True | False | False |
The name of the recurrence data reference that identifies the recurring deposit template or schedule. | |
| Deposit_RecurringInfo_Name | String | False | False | False |
The descriptive name of the recurring deposit schedule or template. | |
| Deposit_RecurringInfo_RecurType | String | False | False | False |
The recurring type of the deposit schedule, such as scheduled, reminder, or unscheduled. The allowed values are Automated, Reminded, UnScheduled. | |
| Deposit_RecurringInfo_Active | Boolean | False | False | False |
Indicates whether the recurring deposit schedule is active or inactive. | |
| Deposit_RecurringInfo_ScheduleInfo_IntervalType | String | False | False | False |
The interval type of the recurring deposit schedule that defines how often the deposit recurs (for example, weekly, monthly, or yearly). The allowed values are Yearly, Monthly, Weekly, Daily. | |
| Deposit_RecurringInfo_ScheduleInfo_NumInterval | Integer | False | False | False |
The number of intervals for the recurring deposit schedule. This value determines how frequently the deposit recurs based on the interval type. | |
| Deposit_RecurringInfo_ScheduleInfo_DayOfWeek | String | False | False | False |
The day of the week on which the recurring deposit is scheduled to occur when the interval type is weekly. | |
| Deposit_RecurringInfo_ScheduleInfo_WeekOfMonth | String | False | False | False |
The week of the month on which the recurring deposit is scheduled to occur when the interval type is monthly. | |
| Deposit_RecurringInfo_ScheduleInfo_MaxOccurrences | String | False | False | False |
The maximum number of occurrences that are allowed for the recurring deposit schedule. | |
| Deposit_RecurringInfo_ScheduleInfo_RemindDays | String | False | False | False |
The number of days before the start date on which a reminder for the recurring deposit should be sent. | |
| Deposit_RecurringInfo_ScheduleInfo_MonthOfYear | String | False | False | False |
The month of the year on which the recurring deposit is scheduled to occur when the interval type is yearly. | |
| Deposit_RecurringInfo_ScheduleInfo_DaysBefore | String | False | False | False |
The number of days before the scheduled date on which the recurring deposit is processed or triggered. | |
| Deposit_RecurringInfo_ScheduleInfo_DayOfMonth | String | False | False | False |
The day of the month on which the recurring deposit is scheduled to occur. | |
| Deposit_RecurringInfo_ScheduleInfo_StartDate | Datetime | False | False | False |
The start date of the recurring deposit schedule that is associated with the recurrence template. | |
| Deposit_RecurringInfo_ScheduleInfo_NextDate | Datetime | False | False | False |
The next scheduled date for the recurring deposit to occur. | |
| Deposit_RecurringInfo_ScheduleInfo_EndDate | Datetime | False | False | False |
The end date of the recurring deposit schedule when no further occurrences are generated. | |
| Deposit_RecurringInfo_ScheduleInfo_PreviousDate | Datetime | False | False | False |
The previous scheduled date on which the recurring deposit occurred. | |
| Deposit_LineAggregate | String | False | False | False |
An XML aggregate that contains the complete set of line items included in the recurring deposit transaction. This field groups together every individual line detail—such as amounts, account references, and memo information—into one structured XML block so that all the components of the deposit can be transmitted, stored, or retrieved as a single unit. | |
| Deposit_TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
The unique Id of the tax code that is applied to the recurring deposit transaction. This field is valid in the UK, AU, and CA editions. |
| Deposit_TxnTaxDetail_TotalTax | String | False | False | False |
The total tax amount that is calculated for the recurring deposit transaction, excluding any tax lines that are manually inserted into the transaction line list. This field is valid in the UK, AU, and CA editions. | |
| Deposit_TxnTaxDetail_TaxLineAggregate | String | False | False | False |
An XML aggregate of all tax line items that are associated with the recurring deposit transaction. This field is valid in the UK, AU, and CA editions. | |
| Deposit_DepositToAccountRef | String | False |
Accounts.Id | False | False |
The Id of the asset account to which the funds from the deposit are recorded. |
| Deposit_DepositToAccountRef_Name | String | False |
Accounts.Name | False | False |
The name of the asset account to which the funds from the deposit are recorded. |
| Deposit_ClassRef | String | False |
Class.Id | False | False |
The Id of the class that is associated with the recurring deposit transaction. |
| Deposit_ClassRef_Name | String | True |
Class.FullyQualifiedName | False | False |
The name of the class that is associated with the recurring deposit transaction. |
| Deposit_TotalAmt | Decimal | True | True | True |
The total monetary amount of the recurring deposit transaction. This amount includes the total of all the charges, allowances, and taxes. | |
| Deposit_CashBack_AccountRef | String | True |
Accounts.Id | True | False |
The Id of the asset account (typically a bank account) to be used for the cash-back portion of the recurring deposit transaction. |
| Deposit_CashBack_AccountRef_Name | String | False |
Accounts.Name | False | False |
The name of the asset account (typically a bank account) that is used for the cash-back portion of the recurring deposit transaction. |
| Deposit_CashBack_Amount | Decimal | False | False | False |
The monetary amount of the cash-back portion of the recurring deposit transaction. | |
| Deposit_CashBack_Memo | String | True | True | False |
The memo or note that is associated with the cash back portion of the recurring deposit transaction. This field can be used for internal reference or reporting purposes. | |
| Deposit_DepartmentRef | String | False |
Departments.Id | False | False |
The unique Id of the department or location that is associated with the recurring deposit transaction as defined using location tracking in QuickBooks Online. |
| Deposit_DepartmentRef_Name | String | True |
Departments.Name | False | False |
The name of the department or location that is associated with the recurring deposit transaction as defined by using location tracking in QuickBooks Online. |
| Deposit_ApplyTaxAfterDiscount | Boolean | False | False | False |
Sets whether discounts are applied before or after taxes are calculated for the recurring deposit transaction. | |
| Deposit_ExchangeRate | Decimal | False | False | False |
The currency exchange rate that is recorded for the recurring deposit transaction. 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 applicable only when multicurrency is enabled for the company. | |
| Deposit_CurrencyRef | String | False | False | False |
The unique Id of the currency that is used for all amounts of the recurring deposit transaction. | |
| Deposit_CurrencyRef_Name | String | True | False | False |
The name of the currency that is used for all amounts of the recurring deposit transaction. | |
| Deposit_GlobalTaxCalculation | String | False | False | False |
The method in which tax is applied to the recurring deposit transaction. This field is valid in only the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable. |