CreditMemos

Create, update, delete, and query QuickBooks Credit Memos.

Table Specific Information

CreditMemos may be inserted, queried, or updated 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 LineAggregate column may be used to specify an XML aggregate of Line Item data. Each _ denotes hierarchy. Use <Line> at the base level. The contents of LineAggregate will be sent to the API as is. All values for each field in the aggregate should adhere to the API's specifications (e.g. for dates in format yyyy-MM-dd, for date times in format yyyy-MM-dd'T'HH:mm:sszzz). The columns that may be used in the aggregates begin with the prefix 'Line_' to indicate they are part of the line item. Use the Line_ column along with the DocNumber to indicate which lines go with which CreditMemos. For example:

INSERT INTO CreditMemos (CustomerRef, LineAggregate) 
VALUES ('4', '
<Line><Amount>0.01</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>2</ItemRef></SalesItemLineDetail></Line>
<Line><Amount>0.02</Amount><DetailType>SalesItemLineDetail</DetailType><SalesItemLineDetail><ItemRef>3</ItemRef></SalesItemLineDetail></Line>
')

Columns


Name	Type	ReadOnly	References	Filterable	Sortable	Description
Id [KEY]	String	True		False	False	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 this transaction occurred.
PrivateNote	String	False		False	False	The private note about the transaction.
LineAggregate	String	False		False	False	An XML aggregate of line items on the credit memo.
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	The name of the customer or job.
CustomerMemo	String	False		False	False	The message to the customer, visible on the transaction.
BillAddr_Id	String	False		False	False	The Id of the entity for the address, mainly used for modifying the address. This value 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 billing address.
BillAddr_Long	String	False		False	False	The longitude coordinate of the geocoded billing address.
ShipAddr_Id	String	False		False	False	The Id of the entity for hte 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 associated with the transaction.
ClassRef_Name	String	True	Class.FullyQualifiedName	False	False	The name of the class associated with the transaction.
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	The name of 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	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 be applied towards the payment.
DepartmentRef	String	False	Departments.Id	False	False	The Id of the location of the transaction.
DepartmentRef_Name	String	True	Departments.Name	False	False	The name of the 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, BillEmail is a required input.
ApplyTaxAfterDiscount	Boolean	False		False	False	This field sets whether discounts are applied before taxes are calculated.
CurrencyRef	String	False		False	False	The Id of the currency used in the transaction.
CurrencyRef_Name	String	True		False	False	The name of the currency used in the transaction.
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 the UK, AU, IN, and CA editions.
GlobalTaxCalculation	String	False		False	False	The method used to apply the tax. 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, expressed in the home currency. This includes the total of all the charges, allowances, and taxes. This field is valid in the UK, AU, IN, and CA editions.

JDBC Driver for QuickBooks Online

CreditMemos

Table Specific Information

Select

Insert

Columns