RecurringCreditMemoTransactionsLineItems
Captures line-level details of recurring credit memos, including products or services credited, amounts, and taxes applied automatically.
Columns
| Name | Type | ReadOnly | References | Filterable | Sortable | Description |
| CreditMemo_LineId [KEY] | String | True | False | False |
The unique Id of the line item on the recurring credit-memo transaction. | |
| CreditMemo_CreditMemoId [KEY] | String | False |
CreditMemos.Id | True | True |
The unique Id of the recurring credit-memo transaction that this line item is associated with. |
| CreditMemo_SyncToken | String | True | False | False |
The version number of the object that is used to lock the recurring credit memo 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. | |
| CreditMemo_MetaData_CreateTime | Datetime | True | True | True |
The date and time when the recurring credit memo line item record was created in QuickBooks Online. | |
| CreditMemo_MetaData_LastUpdatedTime | Datetime | True | True | True |
The date and time when the recurring credit memo line item record was last updated in QuickBooks Online. | |
| CreditMemo_CustomFieldAggregate | String | False | False | False |
An XML aggregate of all custom fields that are associated with the recurring credit-memo transaction. | |
| CreditMemo_DocNumber | String | False | True | True |
The reference number that is assigned to the recurring credit-memo transaction. | |
| CreditMemo_TxnDate | Date | False | True | True |
The date that is entered by the user when the recurring credit-memo transaction occurred. | |
| CreditMemo_PrivateNote | String | False | False | False |
A private note for the recurring credit-memo transaction that does not appear on the transaction records by default. | |
| CreditMemo_LinkedTxnAggregate | String | False | False | False |
An XML aggregate of all linked transactions that are associated with the recurring credit-memo transaction. | |
| CreditMemo_Line_Id | String | False | False | False |
The unique Id of the line item on the recurring credit-memo transaction. | |
| CreditMemo_Line_Description | String | False | False | False |
The description of the line item that appears on the printed recurring credit memo record. | |
| CreditMemo_Line_Amount | Decimal | False | False | False |
The total monetary amount of the charges or discounts for the given line. This includes all charges and allowances but excludes any tax amount. | |
| CreditMemo_Line_DetailType | String | False | False | False |
The detail type of the line item. Different detail types indicate different categories of line items, such as sales, group, or discount lines. | |
| CreditMemo_Line_SalesItemLineDetail_ItemRef | String | False |
Items.Id | False | False |
The unique Id of the item on the line. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored. |
| CreditMemo_Line_SalesItemLineDetail_ItemRef_Name | String | True |
Items.Name | False | False |
The name of the item on the line. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount field is ignored. |
| CreditMemo_Line_SalesItemLineDetail_ClassRef | String | False |
Class.Id | False | False |
The unique Id of the class entity of the line item that is associated with the recurring credit-memo transaction. |
| CreditMemo_Line_SalesItemLineDetail_ClassRef_Name | String | True |
Class.FullyQualifiedName | False | False |
The name of the class entity of the line item that is associated with the recurring credit-memo transaction. |
| CreditMemo_Line_SalesItemLineDetail_UnitPrice | Decimal | False | False | False |
The unit price of the item for this line on the recurring credit memo. | |
| CreditMemo_Line_SalesItemLineDetail_Qty | Double | False | False | False |
The quantity of items for this line on the recurring credit memo. | |
| CreditMemo_Line_SalesItemLineDetail_TaxCodeRef | String | False |
TaxCodes.Id | False | False |
The tax code that is applied to this line item. |
| CreditMemo_Line_SalesItemLineDetail_ServiceDate | Date | False | False | False |
The date when the service was performed or delivered for this line item. | |
| CreditMemo_Line_GroupLineDetail_GroupItemRef | String | True | False | False |
The unique Id of the group item object if the line item is a group line. | |
| CreditMemo_Line_GroupLineDetail_GroupItemRef_Name | String | True | False | False |
The name of the group item object if the line item is a group line. | |
| CreditMemo_Line_GroupLineDetail_Quantity | Integer | True | False | False |
The quantity of the group item on the recurring credit memo line. | |
| CreditMemo_TxnTaxDetail_TxnTaxCodeRef | String | False |
TaxCodes.Id | False | False |
The unique Id of the tax code that is applied to the recurring credit-memo transaction. |
| CreditMemo_TxnTaxDetail_TotalTax | String | False | False | False |
The total tax amount calculated for the recurring credit-memo transaction, excluding any tax lines manually inserted into the transaction line list. | |
| CreditMemo_TxnTaxDetail_TaxLineAggregate | String | False | False | False |
An XML aggregate of all tax line items that are associated with the recurring credit-memo transaction. | |
| CreditMemo_RecurDataRef | String | False | False | False |
The unique Id of the recurrence data reference that identifies the recurring credit memo template or schedule. | |
| CreditMemo_RecurDataRef_Name | String | True | False | False |
The name of the recurrence data reference that identifies the recurring credit memo template or schedule. | |
| CreditMemo_RecurringInfo_Name | String | False | False | False |
The descriptive name of the recurring credit-memo schedule or template. | |
| CreditMemo_RecurringInfo_RecurType | String | False | False | False |
The recurring type of the credit-memo schedule, such as scheduled, reminder, or unscheduled. The allowed values are Automated, Reminded, UnScheduled. | |
| CreditMemo_RecurringInfo_Active | Boolean | False | False | False |
Indicates whether the recurring credit-memo schedule is active or inactive. | |
| CreditMemo_RecurringInfo_ScheduleInfo_IntervalType | String | False | False | False |
The interval type of the recurring credit-memo schedule that defines how often the credit memo recurs, such as weekly, monthly, or yearly. The allowed values are Yearly, Monthly, Weekly, Daily. | |
| CreditMemo_RecurringInfo_ScheduleInfo_NumInterval | Integer | False | False | False |
The number of intervals for the recurring credit-memo schedule. This value determines how frequently the credit memo recurs based on the interval type. | |
| CreditMemo_RecurringInfo_ScheduleInfo_DayOfWeek | String | False | False | False |
The day of the week on which the recurring credit memo is scheduled to occur when the interval type is weekly. | |
| CreditMemo_RecurringInfo_ScheduleInfo_WeekOfMonth | String | False | False | False |
The week of the month on which the recurring credit memo is scheduled to occur when the interval type is monthly. | |
| CreditMemo_RecurringInfo_ScheduleInfo_MaxOccurrences | String | False | False | False |
The maximum number of occurrences allowed for the recurring credit-memo schedule. | |
| CreditMemo_RecurringInfo_ScheduleInfo_RemindDays | String | False | False | False |
The number of days before the start date on which a reminder for the recurring credit memo should be sent. | |
| CreditMemo_RecurringInfo_ScheduleInfo_MonthOfYear | String | False | False | False |
The month of the year on which the recurring credit memo is scheduled to occur when the interval type is yearly. | |
| CreditMemo_RecurringInfo_ScheduleInfo_DaysBefore | String | False | False | False |
The number of days before the scheduled date on which the recurring credit memo is processed or triggered. | |
| CreditMemo_RecurringInfo_ScheduleInfo_DayOfMonth | String | False | False | False |
The day of the month on which the recurring credit memo is scheduled to occur. | |
| CreditMemo_RecurringInfo_ScheduleInfo_StartDate | Datetime | False | False | False |
The start date of the recurring credit-memo schedule that is associated with the recurrence template. | |
| CreditMemo_RecurringInfo_ScheduleInfo_NextDate | Datetime | False | False | False |
The next scheduled date for the recurring credit memo to occur. | |
| CreditMemo_RecurringInfo_ScheduleInfo_EndDate | Datetime | False | False | False |
The end date of the recurring credit-memo schedule when no further occurrences are generated. | |
| CreditMemo_RecurringInfo_ScheduleInfo_PreviousDate | Datetime | False | False | False |
The previous scheduled date on which the recurring credit memo occurred. | |
| CreditMemo_CustomerRef | String | False |
Customers.Id | True | True |
The unique Id of the customer that is associated with the recurring credit-memo transaction. |
| CreditMemo_CustomerRef_Name | String | True |
Customers.DisplayName | False | False |
The name of the customer that is associated with the recurring credit-memo transaction. |
| CreditMemo_CustomerMemo | String | False | False | False |
The message to the customer that appears on the recurring credit-memo transaction. | |
| CreditMemo_BillAddr_Id | String | False | False | False |
The Id of the entity for the billing address, which is mainly used for modifying the address. This field is assigned by the data service. | |
| CreditMemo_BillAddr_Line1 | String | False | False | False |
The first line of the billing address. | |
| CreditMemo_BillAddr_Line2 | String | False | False | False |
The second line of the billing address. | |
| CreditMemo_BillAddr_Line3 | String | False | False | False |
The third line of the billing address. | |
| CreditMemo_BillAddr_Line4 | String | False | False | False |
The fourth line of the billing address. | |
| CreditMemo_BillAddr_Line5 | String | False | False | False |
The fifth line of the billing address. | |
| CreditMemo_BillAddr_City | String | False | False | False |
The city name of the billing address. | |
| CreditMemo_BillAddr_Country | String | False | False | False |
The country name of the billing address. | |
| CreditMemo_BillAddr_CountrySubDivisionCode | String | False | False | False |
The region within a country of the billing address. For example, this value is the state name for the USA or the province name for Canada. | |
| CreditMemo_BillAddr_PostalCode | String | False | False | False |
The postal code of the billing address. For example, this value is the ZIP code for the USA and the postal code for Canada. | |
| CreditMemo_BillAddr_Note | String | False | False | False |
A note that is related to the billing address for the customer. | |
| CreditMemo_BillAddr_Lat | String | False | False | False |
The latitude coordinate of the geocoded billing address. | |
| CreditMemo_BillAddr_Long | String | False | False | False |
The longitude coordinate of the geocoded billing address. | |
| CreditMemo_ShipAddr_Line1 | String | False | False | False |
The first line of the shipping address. | |
| CreditMemo_ShipAddr_Line2 | String | False | False | False |
The second line of the shipping address. | |
| CreditMemo_ShipAddr_Line3 | String | False | False | False |
The third line of the shipping address. | |
| CreditMemo_ShipAddr_Line4 | String | False | False | False |
The fourth line of the shipping address. | |
| CreditMemo_ShipAddr_Line5 | String | False | False | False |
The fifth line of the shipping address. | |
| CreditMemo_ShipAddr_City | String | False | False | False |
The city name of the shipping address. | |
| CreditMemo_ShipAddr_Country | String | False | False | False |
The country name of the shipping address. | |
| CreditMemo_ShipAddr_CountrySubDivisionCode | String | False | False | False |
The region within a country of the shipping address. For example, this value is the state name for the USA or the province name for Canada. | |
| CreditMemo_ShipAddr_PostalCode | String | False | False | False |
The postal code of the shipping address. For example, this value is the ZIP code for the USA and the postal code for Canada. | |
| CreditMemo_ShipAddr_Lat | String | False | False | False |
The latitude coordinate of the geocoded shipping address. | |
| CreditMemo_ShipAddr_Long | String | False | False | False |
The longitude coordinate of the geocoded shipping address. | |
| CreditMemo_ClassRef | String | False |
Class.Id | True | False |
The unique Id of the class that is associated with the credit-memo transaction. |
| 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 Id of the sales term that is associated with the credit-memo transaction. |
| CreditMemo_SalesTermRef_Name | String | True |
Terms.Name | False | False |
The name of the sales term that is associated with the credit-memo transaction. |
| CreditMemo_TotalAmt | Decimal | False | True | True |
The total monetary amount of the credit-memo transaction. This includes the total of all the charges, allowances, and taxes. | |
| CreditMemo_PrintStatus | String | False | False | False |
The print status of the credit-memo transaction, which indicates whether the document has been printed. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet. | |
| CreditMemo_EmailStatus | String | False | False | False |
The email status of the credit-memo transaction, which indicates whether the document has been emailed. The allowed values are NotSent, NeedToSend, EmailSent. The default value is NotSet. | |
| CreditMemo_DepositToAccountRef | String | False |
Accounts.Id | False | False |
The Id of the asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account. |
| CreditMemo_DepositToAccountRef_Name | String | True |
Accounts.Name | False | False |
The name of the asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account. |
| CreditMemo_RemainingCredit | Decimal | False | False | False |
The total credit amount that is still available to apply toward the customer's outstanding payments. | |
| CreditMemo_DepartmentRef | String | False |
Departments.Id | False | False |
The Id of the department or location that stores the credit-memo transaction in QuickBooks Online. |
| CreditMemo_DepartmentRef_Name | String | True |
Departments.Name | False | False |
The name of the department or location that stores the credit-memo transaction in QuickBooks Online. |
| CreditMemo_BillEmail_Address | String | False | False | False |
The email address where the credit memo or related invoice is sent. If the value of the EmailStatus attribute is NeedToSend, this billing email address is required. | |
| CreditMemo_ApplyTaxAfterDiscount | Boolean | False | False | False |
Sets whether the discount is applied before or after taxes are calculated on the credit-memo transaction. | |
| CreditMemo_CurrencyRef | String | False | False | False |
The Id of the currency used for all monetary amounts of the credit-memo transaction. This field is available in only the UK, AU, and CA editions. | |
| CreditMemo_CurrencyRef_Name | String | True | False | False |
The name of the currency used for all monetary amounts of the credit-memo transaction. This field is available in only the UK, AU, and CA editions. | |
| CreditMemo_ExchangeRate | Decimal | False | False | False |
The currency exchange rate that is applied to the credit-memo 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 only the UK, AU, and CA editions. | |
| CreditMemo_GlobalTaxCalculation | String | False | False | False |
The method in which tax is applied on the credit-memo transaction. This field is valid in only the UK, AU, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable. | |
| CreditMemo_HomeTotalAmt | Decimal | True | False | False |
The total amount of the credit-memo transaction expressed in the home currency. This field includes the total of all the charges, allowances, and taxes. This field is valid in only the UK, AU, and CA editions. |