RecurringCreditMemoTransactions
Contains recurring transaction templates for customer credit memos, allowing automated issuance of credits to customers on a predefined schedule.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| CreditMemo_Id [KEY] | String | True | False | False |
The unique identifier (Id) that is assigned to the recurring credit-memo transaction. This Id is system-generated and used to reference the transaction across QuickBooks Online processes. | |
| CreditMemo_SyncToken | String | True | False | False |
The version number of the object. It is used to lock the object so only one application can modify it at a time. Each time the credit memo is updated, the sync token increments. Any update request that specifies an outdated sync is rejected, ensuring that only the latest version is maintained in QuickBooks Online. | |
| CreditMemo_MetaData_CreateTime | Datetime | True | True | True |
The date and time when the recurring credit-memo record was initially created in QuickBooks Online. | |
| CreditMemo_MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time when the recurring credit-memo record was most recently updated. | |
| CreditMemo_CustomFieldAggregate | String | False | False | False |
An XML aggregate containing all custom fields that are applied to the credit memo. These fields can include business-specific Ids, notes, or tracking values that extend beyond the default schema. | |
| CreditMemo_DocNumber | String | False | True | True |
The reference number for the credit memo, typically used by accountants or business users to cross-reference internal documents. | |
| CreditMemo_TxnDate | Date | False | True | True |
The calendar date of the credit-memo transaction. This date represents the official date on which the transaction occurred in QuickBooks Online. | |
| CreditMemo_PrivateNote | String | False | False | False |
An internal note about the credit-memo transaction. This note is visible only to QuickBooks Online users within the company and does not appear on customer-facing records unless explicitly configured. | |
| CreditMemo_DepartmentRef | String | False |
Departments.Id | False | False |
The unique Id of the department that is linked to the transaction. In QuickBooks Online, departments are used to store the location of the transaction as defined through location tracking. |
| CreditMemo_DepartmentRef_Name | String | True |
Departments.Name | False | False |
The name of the department that is associated with the credit-memo transaction, which reflects the location tracking configuration in QuickBooks Online. |
| CreditMemo_TxnStatus | String | False | False | False |
The current status of the credit-memo transaction. Acceptable values vary depending on transaction type. For sales transactions, the values are defined in the PaymentStatusEnum data type. For estimates, the values are defined in the QboEstimateStatusEnum data type. | |
| CreditMemo_LinkedTxnAggregate | String | False | False | False |
An XML aggregate of zero or more linked transactions. Linked transactions can include invoices, payments, or other records tied to the credit memo. | |
| CreditMemo_RecurDataRef | String | False | False | False |
The unique Id of the recurrence data object that is associated with the credit-memo schedule. | |
| CreditMemo_RecurDataRef_Name | String | True | False | False |
The human-readable name that is associated with the recurrence data object linked to the credit memo. | |
| CreditMemo_RecurringInfo_Name | String | False | False | False |
The name that is assigned to the recurring credit-memo schedule, which helps users distinguish between different recurring templates. | |
| CreditMemo_RecurringInfo_RecurType | String | False | False | False |
The type of recurrence that is applied to the credit-memo schedule. Examples include Daily, Weekly, Monthly, or Yearly recurrence patterns. The allowed values are Automated, Reminded, UnScheduled. | |
| CreditMemo_RecurringInfo_Active | Boolean | False | False | False |
Indicates whether the recurring credit-memo schedule is currently active. If this flag is set to false, the schedule does not generate new transactions. | |
| CreditMemo_RecurringInfo_ScheduleInfo_IntervalType | String | False | False | False |
The unit of time that is used for the recurrence schedule, such as Day, Week, or Month. The allowed values are Yearly, Monthly, Weekly, Daily. | |
| CreditMemo_RecurringInfo_ScheduleInfo_NumInterval | Integer | False | False | False |
The numeric interval for the recurrence schedule. For example, a value of 2 with an interval type of Week generates a transaction every two weeks. | |
| CreditMemo_RecurringInfo_ScheduleInfo_DayOfWeek | String | False | False | False |
The day of the week when the recurring transaction occurs (for example, Monday or Friday). | |
| CreditMemo_RecurringInfo_ScheduleInfo_WeekOfMonth | String | False | False | False |
The week of the month when the recurring transaction is scheduled (for example, First, Second, or Last). | |
| CreditMemo_RecurringInfo_ScheduleInfo_MaxOccurrences | String | False | False | False |
The maximum number of recurring credit-memo transactions that can be generated before the schedule ends. | |
| CreditMemo_RecurringInfo_ScheduleInfo_RemindDays | String | False | False | False |
The number of days before the scheduled recurrence date when a reminder notification should be generated. | |
| CreditMemo_RecurringInfo_ScheduleInfo_MonthOfYear | String | False | False | False |
The month of the year when the recurring credit memo is generated, applicable to yearly recurrence schedules. | |
| CreditMemo_RecurringInfo_ScheduleInfo_DaysBefore | String | False | False | False |
The number of days before the scheduled recurrence date when the transaction should be created. | |
| CreditMemo_RecurringInfo_ScheduleInfo_DayOfMonth | String | False | False | False |
The specific day of the month when the recurring credit memo is scheduled to occur. | |
| CreditMemo_RecurringInfo_ScheduleInfo_StartDate | Datetime | False | False | False |
The date when the recurring credit-memo schedule becomes active and begins generating transactions. | |
| CreditMemo_RecurringInfo_ScheduleInfo_NextDate | Datetime | False | False | False |
The next date when a credit memo is scheduled to be generated by the recurrence schedule. | |
| CreditMemo_RecurringInfo_ScheduleInfo_EndDate | Datetime | False | False | False |
The date when the recurrence schedule will end, after which no new credit memos are generated. | |
| CreditMemo_RecurringInfo_ScheduleInfo_PreviousDate | Datetime | False | False | False |
The most recent date when a credit memo was generated by the recurrence schedule. | |
| CreditMemo_LineAggregate | String | False | False | False |
An XML aggregate that stores detailed line items for the credit memo, including products, services, quantities, and amounts. | |
| CreditMemo_TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
The unique Id of the tax code that is applied to the credit-memo transaction. |
| CreditMemo_TxnTaxDetail_TotalTax | String | False | False | False |
The total amount of tax that is calculated for the credit memo, excluding any tax line items that are manually inserted into the line list. | |
| CreditMemo_TxnTaxDetail_TaxLineAggregate | String | False | False | False |
An XML aggregate containing individual tax line items that are associated with the credit memo. | |
| CreditMemo_CustomerRef | String | False |
Customers.Id | True | True |
The unique Id of the customer that is linked to the credit memo. |
| CreditMemo_CustomerRef_Name | String | True |
Customers.DisplayName | False | False |
The display name of the customer or job that is associated with the credit memo. |
| CreditMemo_CustomerMemo | String | False | False | False |
The customer-facing message that is displayed on the credit memo. This message is visible to customers when they receive the transaction. | |
| CreditMemo_BillAddr_Id | String | False | False | False |
The unique Id for the billing address entity. This Id is primarily used when modifying or updating the address record in QuickBooks Online. | |
| CreditMemo_BillAddr_Line1 | String | False | False | False |
The first line of the billing address, typically used for street address or company name. | |
| CreditMemo_BillAddr_Line2 | String | False | False | False |
The second line of the billing address, often used for suite numbers, apartment numbers, or additional address details. | |
| CreditMemo_BillAddr_Line3 | String | False | False | False |
The third line of the billing address, if provided by the customer or company. | |
| CreditMemo_BillAddr_Line4 | String | False | False | False |
The fourth line of the billing address, for extended address information. | |
| CreditMemo_BillAddr_Line5 | String | False | False | False |
The fifth line of the billing address, used only if additional address information is required. | |
| CreditMemo_BillAddr_City | String | False | False | False |
The city portion of the billing address. | |
| CreditMemo_BillAddr_Country | String | False | False | False |
The country specified in the billing address. | |
| CreditMemo_BillAddr_CountrySubDivisionCode | String | False | False | False |
The regional subdivision of the country for the billing address. For example, the value is the state name in the USA or the province name in Canada. | |
| CreditMemo_BillAddr_PostalCode | String | False | False | False |
The postal code of the billing address. For example, this value represents the ZIP code in the USA and the postal code in Canada. | |
| CreditMemo_BillAddr_Note | String | False | False | False |
An optional note that is included as part of the billing address record. | |
| CreditMemo_BillAddr_Lat | String | False | False | False |
The latitude coordinate of the geocoded billing address, used for mapping and validation purposes. | |
| CreditMemo_BillAddr_Long | String | False | False | False |
The longitude coordinate of the geocoded billing address, used for mapping and validation purposes. | |
| CreditMemo_ShipAddr_Id | String | False | False | False |
The unique Id of the shipping address entity that is associated with the credit memo. | |
| CreditMemo_ShipAddr_Line1 | String | False | False | False |
The first line of the shipping address, typically used for street address or recipient name. | |
| CreditMemo_ShipAddr_Line2 | String | False | False | False |
The second line of the shipping address, often used for suite or unit information. | |
| CreditMemo_ShipAddr_Line3 | String | False | False | False |
The third line of the shipping address, if applicable. | |
| CreditMemo_ShipAddr_Line4 | String | False | False | False |
The fourth line of the shipping address, if additional address details are required. | |
| CreditMemo_ShipAddr_Line5 | String | False | False | False |
The fifth line of the shipping address, used rarely for extended information. | |
| CreditMemo_ShipAddr_City | String | False | False | False |
The city portion of the shipping address. | |
| CreditMemo_ShipAddr_Country | String | False | False | False |
The country specified in the shipping address. | |
| CreditMemo_ShipAddr_CountrySubDivisionCode | String | False | False | False |
The regional subdivision of the country for the shipping address. For example, this value is the state name in the USA or the province name in Canada. | |
| CreditMemo_ShipAddr_PostalCode | String | False | False | False |
The postal code of the shipping address. For example, this value represents a ZIP code in the USA and the postal code in Canada. | |
| CreditMemo_ShipAddr_Lat | String | False | False | False |
The latitude coordinate of the geocoded shipping address, used for mapping and validation purposes. | |
| CreditMemo_ShipAddr_Long | String | False | False | False |
The longitude coordinate of the geocoded shipping address, used for mapping and validation purposes. | |
| CreditMemo_ClassRef | String | False |
Class.Id | True | False |
The unique Id of the class associated with the credit-memo transaction. Classes are used for tracking different segments of a business, such as departments or product lines. |
| CreditMemo_ClassRef_Name | String | True |
Class.FullyQualifiedName | False | False |
The name of the class that is associated with the credit-memo transaction. |
| CreditMemo_SalesTermRef | String | False |
Terms.Id | True | False |
The unique Id of the sales term that is linked to the credit-memo transaction. |
| CreditMemo_SalesTermRef_Name | String | True |
Terms.Name | False | False |
The name of the sales term that is applied to the credit-memo transaction, such as Net 30 or Due on Receipt. |
| CreditMemo_TotalAmt | Decimal | False | True | True |
The total monetary amount of the credit memo. This amount includes charges, allowances, and taxes that are applied to the transaction. | |
| CreditMemo_PrintStatus | String | False | False | False |
The current print status of the credit memo, such as NotSet, NeedToPrint, or PrintComplete. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet. | |
| CreditMemo_EmailStatus | String | False | False | False |
The current email delivery status of the credit memo, such as NotSet, NeedToSend, or EmailSent. The allowed values are NotSent, NeedToSend, EmailSent. The default value is NotSet. | |
| CreditMemo_DepositToAccountRef | String | False |
Accounts.Id | False | False |
The unique Id of the asset account where the refunded payment or credit is deposited. If this Id is not specified, QuickBooks Online defaults to the Undeposited Funds account. |
| CreditMemo_DepositToAccountRef_Name | String | True |
Accounts.Name | False | False |
The name of the asset account where the refunded payment or credit is deposited. If this name is not specified, QuickBooks Online defaults to the Undeposited Funds account. |
| CreditMemo_RemainingCredit | Decimal | False | False | False |
The portion of the credit-memo amount that remains available to be applied against outstanding invoices or payments. | |
| CreditMemo_BillEmail_Address | String | False | False | False |
The email address where the credit memo will be sent. If the the EmailStatus attribute is set to NeedToSend, the billing email address is required. | |
| CreditMemo_ApplyTaxAfterDiscount | Boolean | False | False | False |
Indicates whether discounts should be applied before or after taxes are calculated. If this flag is set to true, taxes are applied after discounts. | |
| CreditMemo_CurrencyRef | String | False | False | False |
The unique Id of the currency that is used in the credit-memo transaction. | |
| CreditMemo_CurrencyRef_Name | String | True | False | False |
The name of the currency that is used in the credit-memo transaction. | |
| CreditMemo_ExchangeRate | Decimal | False | False | False |
The currency exchange rate that is applied to the credit-memo. This field is only valid when the company is enabled for multicurrency. Exchange rates are always recorded as the number of home currency units required to equal one unit of the foreign currency. This field is available only in the UK, AU, and CA editions of QuickBooks Online. | |
| CreditMemo_GlobalTaxCalculation | String | False | False | False |
The method that is used to apply taxes across the transaction, such as TaxExcluded, TaxInclusive, or NotApplicable. This field is available only in the UK, AU, and CA editions of QuickBooks Online. The allowed values are TaxExcluded, TaxInclusive, NotApplicable. | |
| CreditMemo_HomeTotalAmt | Decimal | True | False | False |
The total amount of the credit memo that is expressed in the company's home currency. This amount includes all charges, allowances, and taxes. This field is available only in the UK, AU, and CA editions of QuickBooks Online. |