CreditMemos

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

Table Specific Information

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

This table has a Custom Fields column. See the Custom Fields page for more information.

Select

By default, SupportEnhancedSQL is set to true, and the following will be honored if present. Other filters will be executed client side. If SupportEnhancedSQL is set to false, only the following filters will be honored.

QuickBooks allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only the equals or = comparison. The available columns for CreditMemos are Id, ReferenceNumber, Date, TimeModified, CustomerName, CustomerId, AccountsReceivable, and AccountsReceivableId. TimeModified and Date may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. ReferenceNumber may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:

SELECT * FROM CreditMemos WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a CreditMemo, specify a Customer and at least one Line Item. The ItemAggregate column may be used to specify an XML aggregate of Line Item data. The columns that may be used in these aggregates are defined in the CreditMemoLineItems tableand it starts with Item. For example, the following will insert a new CreditMemo with two Line Items:

INSERT INTO CreditMemos (CustomerName, ItemAggregate) 
VALUES ('Abercrombie, Kristy', 
'<CreditMemoLineItems>
<Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row>
<Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row>
</CreditMemoLineItems>')

To insert subitems, set the ItemName field to the FullName of the item; for example, '<Row><ItemName>Subs:Carpet</ItemName><ItemQuantity>0</ItemQuantity></Row>'

Columns


Name	Type	ReadOnly	References	ColumnSize	Description
ID [KEY]	String	True		255	The unique identifier.
ReferenceNumber	String	False		21	The transaction reference number.
TxnNumber	Integer	True			The transaction number. An identifying number for the transaction, different from the QuickBooks-generated Id.
Date	Date	False			The date of the transaction. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value.
CustomerName	String	False		1000	The name of the customer on the credit memo. CustomerName or CustomerId are required to have a value when inserting.
CustomerId	String	False	Customers.ID	255	The Id of the customer on the credit memo. CustomerName or CustomerId are required to have a value when inserting.
AccountsReceivable	String	False		1000	A reference to the name of the accounts-receivable account where the money received from this transaction will be deposited.
AccountsReceivableId	String	False	Accounts.ID	255	A reference to the Id of the accounts-receivable account where the money received from this transaction will be deposited.
ShipMethod	String	False		1000	The shipping method.
ShipMethodId	String	False	ShippingMethods.ID	255	The shipping method Id.
ShipDate	Date	False			The shipping date.
Memo	String	False		5000	A memo regarding this transaction.
Amount	Decimal	False			Total amount for this transaction.
Message	String	False		101	A message to the customer.
MessageId	String	False	CustomerMessages.ID	255	Id of the message to the customer.
SalesRep	String	False		5	Reference to (initials of) the sales rep.
SalesRepId	String	False	SalesReps.ID	255	Reference Id to the sales rep.
FOB	String	False		13	Freight on board: The place to ship from.
BillingAddress	String	True			Full billing address returned by QuickBooks.
BillingLine1	String	False		500	First line of the billing address.
BillingLine2	String	False		500	Second line of the billing address.
BillingLine3	String	False		500	Third line of the billing address.
BillingLine4	String	False		500	Fourth line of the billing address.
BillingLine5	String	False		41	Fifth line of the billing address.
BillingCity	String	False		255	City name for the billing address of the credit memo.
BillingState	String	False		255	State name for the billing address of the credit memo.
BillingPostalCode	String	False		30	Postal code for the billing address of the credit memo.
BillingCountry	String	False		255	Country for the billing address of the credit memo.
BillingNote	String	False		41	Note for the billing address of the credit memo.
ShippingAddress	String	True			Full shipping address returned by QuickBooks.
ShippingLine1	String	False		500	First line of the shipping address.
ShippingLine2	String	False		500	Second line of the shipping address.
ShippingLine3	String	False		500	Third line of the shipping address.
ShippingLine4	String	False		500	Fourth line of the shipping address.
ShippingLine5	String	False		41	Fifth line of the shipping address.
ShippingCity	String	False		255	City name for the shipping address of the credit memo.
ShippingState	String	False		255	State name for the shipping address of the credit memo.
ShippingPostalCode	String	False		30	Postal code for the shipping address of the credit memo.
ShippingCountry	String	False		255	Country for the shipping address of the credit memo.
ShippingNote	String	False		41	Note for the shipping address of the credit memo.
Subtotal	Decimal	True			The gross subtotal. This does not include tax or the amount already paid.
Tax	Double	False			Total sales tax applied to this transaction.
TaxItem	String	False		100	A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency.
TaxItemId	String	False	SalesTaxItems.ID	255	A sales tax item refers to a single sales tax that is collected at a specified rate and paid to a single agency.
TaxPercent	Double	True			Percentage charged for sales tax.
IsPending	Boolean	False			Transaction status (whether this transaction has been completed or is still pending).
IsToBeEmailed	Boolean	False			Whether this credit memo is to be emailed.
IsToBePrinted	Boolean	False			Whether this transaction is to be printed.
IsTaxIncluded	Boolean	False			Determines if tax is included in the transaction amount. Available in only international editions of QuickBooks.
PONumber	String	False		25	The purchase order number.
Terms	String	False		100	The payment terms.
TermsId	String	False		255	The payment terms.
CreditRemaining	Double	True			Remaining credit.
DueDate	Date	False			Date when the credit is due.
Template	String	False		100	The name of an existing template to apply to the transaction.
TemplateId	String	False	Templates.ID	255	The Id of an existing template to apply to the transaction.
CustomerSalesTax	String	False		3	Reference to sales tax information for the customer.
CustomerSalesTaxId	String	False	SalesTaxCodes.ID	255	Reference to sales tax information for the customer.
Class	String	False		1000	A reference to the class of the transaction.
ClassId	String	False	Class.ID	255	A reference to the class of the transaction.
ExchangeRate	Double	False			Indicates the exchange rate for the transaction.
ItemCount	Integer	True			The count of line items.
ItemAggregate	String	False		5000	An aggregate of the line item data which can be used for adding a credit memo and its line item data.
TransactionCount	Integer	True			The count of related transactions to the credi tmemo.
TransactionAggregate	String	True		5000	An aggregate of the linked transaction data.
CustomFields	String	False			Custom fields returned from QuickBooks and formatted into XML.
EditSequence	String	True		16	An identifier used for versioning for this copy of the object.
TimeModified	Datetime	True			When the credit memo was last modified.
TimeCreated	Datetime	True			When the credit memo was created.

Pseudo-Columns

Pseudo Column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.