ODBC Driver for QuickBooks Online

Build 25.0.9434

CreditMemoLineItems

Captures line-level details of customer credit memos, including products or services credited, amounts, and tax information for accurate revenue adjustments.

Table Specific Information

CreditMemos may be inserted, updated, or queried via the CreditMemos or CreditMemoLineItems tables. CreditMemos may be deleted by using the CreditMemos table.

Select

All filterable columns support the following operators:

  • =
  • !=
  • >=
  • <=
  • >
  • <
  • IN
  • LIKE
  • CONTAINS

The driver processes other filters client-side within the driver.

Insert

To add a CreditMemo, specify a Customer and at least one Line Item. The following shows an example of inserting multiple CreditMemos, each with a single line. To insert a CreditMemo with multiple lines, see the example on the CreditMemos table. 

 INSERT INTO CreditMemoLineItems#TEMP (CustomerRef, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount) VALUES ('4', 'SalesItemLineDetail', '2', 0.01)
INSERT INTO CreditMemoLineItems#TEMP (CustomerRef, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount) VALUES ('4', 'SalesItemLineDetail', '3', 0.02) 
 INSERT INTO CreditMemoLineItems (CustomerRef, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount) SELECT CustomerRef, Line_DetailType, Line_SalesItemLineDetail_ItemRef, Line_Amount FROM CreditMemoLineItems#TEMP

Columns

Name Type ReadOnly References Filterable Sortable Description
LineId [KEY] String True False False

Specifies the unique identifier (Id) of the credit-memo line item.

CreditMemoId [KEY] String False

CreditMemos.Id

True True

Specifies the unique Id of the credit memo to which the line item belongs.

SyncToken String True False False

Specifies the version number that is used to lock the credit-memo line item object for use by one application at a time. When an application modifies an object, its sync token is incremented. Attempts to modify an object with an older sync token fail.

MetaData_CreateTime Datetime True True True

Specifies the date and time when the credit-memo line item record was created in the source domain.

MetaData_LastUpdatedTime Datetime True True True

Specifies the date and time when the credit-memo line item record was last updated in the source domain.

CustomFieldAggregate String False False False

Specifies an XML aggregate of custom fields that are associated with the credit-memo line item.

DocNumber String False True True

Specifies the reference number for the credit-memo transaction.

TxnDate Date False True True

Specifies the date when the credit-memo transaction occurred.

PrivateNote String False False False

Specifies a private note about the credit-memo transaction. By default, this field does not appear on transaction records.

Line_Id String False False False

Specifies the unique Id of the line item within the credit memo.

Line_Description String False False False

Specifies the description of the line item that appears in the printed record.

Line_Amount Decimal False False False

Specifies the total amount of the charges or discounts for the line item, excluding tax amounts.

Line_DetailType String False False False

Specifies the detail type of the line item. Different detail types indicate different types of line items.

Line_SalesItemLineDetail_ItemRef String False

Items.Id

False False

Specifies the unique Id of the item referenced by the line. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount attribute is ignored.

Line_SalesItemLineDetail_ItemRef_Name String True

Items.Name

False False

Specifies the name of the item referenced by the line. When a line item lacks an item reference, it is treated as documentation and the Line_Amount attribute is ignored.

Line_SalesItemLineDetail_ClassRef String False

Class.Id

False False

Specifies the unique Id of the class entity that is assigned to the line item.

Line_SalesItemLineDetail_ClassRef_Name String True

Class.FullyQualifiedName

False False

Specifies the name of the class entity that is assigned to the line item.

Line_SalesItemLineDetail_UnitPrice Decimal False False False

Specifies the unit price of the item on the line.

Line_SalesItemLineDetail_Qty Double False False False

Specifies the quantity of items in the line item.

Line_SalesItemLineDetail_TaxCodeRef String False

TaxCodes.Id

False False

Specifies the tax code that is applied to this line item.

Line_SalesItemLineDetail_ServiceDate Date False False False

Specifies the date when the service for the line item was performed.

Line_GroupLineDetail_GroupItemRef String True False False

Specifies the unique Id of the group item object that is referenced by the line.

Line_GroupLineDetail_GroupItemRef_Name String True False False

Specifies the name of the group item object that is referenced by the line.

Line_GroupLineDetail_Quantity Integer True False False

Specifies the quantity of the group item on the line.

TxnTaxDetail_TxnTaxCodeRef String False

TaxCodes.Id

False False

Specifies the tax code for the credit-memo transaction.

TxnTaxDetail_TotalTax String False False False

Specifies the total tax calculated for the credit-memo transaction, excluding any tax lines that are manually inserted into the transaction line list.

TxnTaxDetail_TaxLineAggregate String False False False

Specifies an XML aggregate of tax line items that are associated with the credit-memo transaction.

CustomerRef String False

Customers.Id

True False

Specifies the unique Id of the customer that is associated with the credit-memo transaction.

CustomerRef_Name String True

Customers.DisplayName

False False

Specifies the name of the customer that is associated with the credit-memo transaction.

CustomerMemo String False False False

Specifies the message to the customer that is visible on the credit-memo transaction.

BillAddr_Id String False False False

Specifies the unique Id of the entity for the billing address, mainly used for modifying the address.

BillAddr_Line1 String False False False

Specifies the first line of the billing address.

BillAddr_Line2 String False False False

Specifies the second line of the billing address.

BillAddr_Line3 String False False False

Specifies the third line of the billing address.

BillAddr_Line4 String False False False

Specifies the fourth line of the billing address.

BillAddr_Line5 String False False False

Specifies the fifth line of the billing address.

BillAddr_City String False False False

Specifies the city name in the billing address.

BillAddr_Country String False False False

Specifies the country name in the billing address.

BillAddr_CountrySubDivisionCode String False False False

Specifies the region within the country. This field represents the state name for the USA or the province name for Canada.

BillAddr_PostalCode String False False False

Specifies the postal code in the billing address. This field represents the ZIP code for the USA and Canada.

BillAddr_Lat String False False False

Specifies the latitude coordinate of the geocoded billing address.

BillAddr_Long String False False False

Specifies the longitude coordinate of the geocoded billing address.

ShipAddr_Line1 String False False False

Specifies the first line of the shipping address.

ShipAddr_Line2 String False False False

Specifies the second line of the shipping address.

ShipAddr_Line3 String False False False

Specifies the third line of the shipping address.

ShipAddr_Line4 String False False False

Specifies the fourth line of the shipping address.

ShipAddr_Line5 String False False False

Specifies the fifth line of the shipping address.

ShipAddr_City String False False False

Specifies the city name in the shipping address.

ShipAddr_Country String False False False

Specifies the country name in the shipping address.

ShipAddr_CountrySubDivisionCode String False False False

Specifies the region within the country in the shipping address.

ShipAddr_PostalCode String False False False

Specifies the postal code in the shipping address.

ShipAddr_Lat String False False False

Specifies the latitude coordinate of the geocoded shipping address.

ShipAddr_Long String False False False

Specifies the longitude coordinate of the geocoded shipping address.

ClassRef String False

Class.Id

True False

Specifies the unique Id of the class assigned to the credit-memo transaction.

ClassRef_Name String True

Class.FullyQualifiedName

False False

Specifies the name of the class assigned to the credit-memo transaction.

SalesTermRef String False

Terms.Id

True False

Specifies the unique Id of the sales term associated with the credit-memo transaction.

SalesTermRef_Name String True

Terms.Name

False False

Specifies the name of the sales term associated with the credit-memo transaction.

TotalAmt Decimal False True True

Specifies the total amount of the credit-memo transaction, including all charges, allowances, and taxes.

PrintStatus String False False False

Specifies the print status of the credit memo.

The allowed values are NotSet, NeedToPrint, PrintComplete.

The default value is NotSet.

EmailStatus String False False False

Specifies the email status of the credit-memo transaction.

The allowed values are NotSent, NeedToSend, EmailSent.

The default value is NotSet.

RemainingCredit Decimal False False False

Specifies the total credit amount still available to apply towards payment.

DepartmentRef String False

Departments.Id

False False

Specifies the unique Id of the department that stores the location of the credit-memo transaction.

DepartmentRef_Name String True

Departments.Name

False False

Specifies the name of the department that stores the location of the credit-memo transaction.

BillEmail_Address String False False False

Specifies the email address where the credit memo is sent. If the value of EmailStatus is NeedToSend, this field is a required input.

ApplyTaxAfterDiscount Boolean False False False

Specifies whether the discount is applied before or after taxes are calculated.

CurrencyRef String False False False

Specifies the unique Id of the currency used for all amounts of the credit-memo transaction. This field is available only in the UK, AU, and CA editions.

CurrencyRef_Name String True False False

Specifies the name of the currency used for all amounts of the credit-memo transaction. This field is available only in the UK, AU, and CA editions.

ExchangeRate Decimal False False False

Specifies the currency exchange rate that is applied when the credit-memo transaction occurred. This field is valid only if the company file is set up to use the multicurrency feature and is available only in the UK, AU, and CA editions.

GlobalTaxCalculation String False False False

Specifies the method in which tax is applied. This field is valid only in the UK, AU, and CA editions.

The allowed values are TaxExcluded, TaxInclusive, NotApplicable.

HomeTotalAmt Decimal True False False

Specifies the total amount of the credit-memo transaction in the home currency, including all charges, allowances, and taxes. This field is valid only in the UK, AU, and CA editions.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434