CreditMemoLineItems

Columns

Name	Type	ReadOnly	References	Filterable	Sortable	Description
LineId [KEY]	String	True		false	false	The Id of the line item of the credit memo.
CreditMemoId [KEY]	String	False	CreditMemos.Id	true	true	The Id of the credit memo.
SyncToken	String	True		false	false	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fails. Only the latest version of the object is maintained by QuickBooks Online.
MetaData_CreateTime	Datetime	True		true	true	The time the record was created.
MetaData_LastUpdatedTime	Datetime	True		true	true	The time the record was last updated.
CustomFieldAggregate	String	False		false	false	An XML aggregate of custom fields for the credit memo.
DocNumber	String	False		true	true	The reference number for the transaction.
TxnDate	Date	False		true	true	The date when the transaction occurred.
PrivateNote	String	False		false	false	A private note about the transaction. By default, this field will not appear on transaction records.
LinkedTxnAggregate	String	False		false	false	An XML aggregate of linked transactions on the credit memo.
Line_Id	String	False		false	false	The Id of the line item.
Line_Description	String	False		false	false	The description of the line item that appears in the printed record.
Line_Amount	Decimal	False		false	false	The total amount of the charges or discounts for the given line. This includes the charges and allowances but excludes the tax amount.
Line_DetailType	String	False		false	false	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	The Id of the item. 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	The name of the item. When a line item lacks an ItemRef it is treated as documentation and the Line_Amount attribute is ignored.
Line_SalesItemLineDetail_ClassRef	String	False	Class.Id	false	false	The Id of the class entity of the line item.
Line_SalesItemLineDetail_ClassRef_Name	String	True	Class.FullyQualifiedName	false	false	The name of the class entity of the line item.
Line_SalesItemLineDetail_UnitPrice	Decimal	False		false	false	The unit price of the item.
Line_SalesItemLineDetail_Qty	Double	False		false	false	The number of items in the line item.
Line_SalesItemLineDetail_TaxCodeRef	String	False	TaxCodes.Id	false	false	The tax code for this item.
Line_SalesItemLineDetail_ServiceDate	Date	False		false	false	The date when the service was performed.
Line_GroupLineDetail_GroupItemRef	String	True		false	false	The Id of the group item object.
Line_GroupLineDetail_GroupItemRef_Name	String	True		false	false	The name of the group item object.
Line_GroupLineDetail_Quantity	Integer	True		false	false	The amount of the group item.
TxnTaxDetail_TxnTaxCodeRef	String	False	TaxCodes.Id	false	false	The tax code for the transaction.
TxnTaxDetail_TotalTax	String	False		false	false	The total tax calculated for the transaction, excluding any tax lines manually inserted into the transaction line list.
TxnTaxDetail_TaxLineAggregate	String	False		false	false	An XML aggregate of tax line items.
CustomerRef	String	False	Customers.Id	true	true	The Id of the customer.
CustomerRef_Name	String	True	Customers.DisplayName	false	false	A name that identifies the customer.
CustomerMemo	String	False		false	false	A message to the customer, visible on the transaction.
BillAddr_Id	String	False		false	false	The Id of the entity for the billing address, mainly used for modifying the address. This field is assigned by the data service.
BillAddr_Line1	String	False		false	false	The first line of the address.
BillAddr_Line2	String	False		false	false	The second line of the address.
BillAddr_Line3	String	False		false	false	The third line of the address.
BillAddr_Line4	String	False		false	false	The fourth line of the address.
BillAddr_Line5	String	False		false	false	The fifth line of the address.
BillAddr_City	String	False		false	false	The city name.
BillAddr_Country	String	False		false	false	The country name.
BillAddr_CountrySubDivisionCode	String	False		false	false	The country region. The state name for the USA or the province name for Canada.
BillAddr_PostalCode	String	False		false	false	The postal code. The zip code for the USA and Canada.
BillAddr_Note	String	False		false	false	The note for the customer.
BillAddr_Lat	String	False		false	false	The latitude coordinate of the geocoded address.
BillAddr_Long	String	False		false	false	The longitude coordinate of the geocoded address.
ShipAddr_Line1	String	False		false	false	The first line of the shipping address.
ShipAddr_Line2	String	False		false	false	The second line of the shipping address.
ShipAddr_Line3	String	False		false	false	The third line of the shipping address.
ShipAddr_Line4	String	False		false	false	The fourth line of the shipping address.
ShipAddr_Line5	String	False		false	false	The fifth line of the shipping address.
ShipAddr_City	String	False		false	false	The city name
ShipAddr_Country	String	False		false	false	The country name
ShipAddr_CountrySubDivisionCode	String	False		false	false	The region within a country.
ShipAddr_PostalCode	String	False		false	false	The postal code.
ShipAddr_Lat	String	False		false	false	The latitude coordinate of the geocoded shipping address.
ShipAddr_Long	String	False		false	false	The longitude coordinate of the geocoded shipping address.
ClassRef	String	False	Class.Id	true	false	The Id of the class.
ClassRef_Name	String	True	Class.FullyQualifiedName	false	false	The name of the class.
SalesTermRef	String	False	Terms.Id	true	false	The Id of the sales term associated with the transaction.
SalesTermRef_Name	String	True	Terms.Name	false	false	A name that identifies the sales term associated with the transaction.
TotalAmt	Decimal	False		true	true	The total amount of the transaction. This includes the total of all the charges, allowances, and taxes.
PrintStatus	String	False		false	false	The print status of the credit memo. The allowed values are NotSet, NeedToPrint, PrintComplete. The default value is NotSet.
EmailStatus	String	False		false	false	The email status of the invoice. The allowed values are NotSent, NeedToSend, EmailSent. The default value is NotSet.
DepositToAccountRef	String	False	Accounts.Id	false	false	The asset account where the payment money is deposited. If you do not specify this account, QuickBooks Online uses the Undeposited Funds account.
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.
RemainingCredit	Decimal	False		false	false	The total credit amount still available to apply towards the payment.
DepartmentRef	String	False	Departments.Id	false	false	The Id of the department, which stores the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	false	false	The name of the department, which stores location of the transaction.
BillEmail_Address	String	False		false	false	The email address where the invoice is sent. If the value of EmailStatus is NeedToSend, this field is a required input.
ApplyTaxAfterDiscount	Boolean	False		false	false	This field sets whether the discount is applied before or after taxes are calculated.
CurrencyRef	String	False		false	false	The Id of the currency used for all amounts of the transaction. This field is available in only the UK, AU, IN, and CA editions.
CurrencyRef_Name	String	True		false	false	The name of the currency used for all amounts of the transaction. This field is available in only the UK, AU, IN, and CA editions.
ExchangeRate	Decimal	False		false	false	The currency exchange rate. 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, IN, and CA editions.
GlobalTaxCalculation	String	False		false	false	The method in which tax is applied. This field is valid in only the UK, AU, IN, and CA editions. The allowed values are TaxExcluded, TaxInclusive, NotApplicable.
HomeTotalAmt	Decimal	True		false	false	The total amount of the transaction 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, IN, and CA editions.