CreditMemoLineItems
Create, update, delete, and query QuickBooks Credit Memo Line Items.
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 |
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. | |
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. 使用できる値は次のとおりです。NotSet, NeedToPrint, PrintComplete デフォルト値はNotSetです。 | |
EmailStatus | String | False | False | False |
The email status of the invoice. 使用できる値は次のとおりです。NotSent, NeedToSend, EmailSent デフォルト値は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, 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, 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, and CA editions. | |
GlobalTaxCalculation | String | False | False | False |
The method in which tax is applied. This field is valid in only the UK, AU, and CA editions. 使用できる値は次のとおりです。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, and CA editions. |