CreditMemos

Manages QuickBooks Credit Memos, supporting creation, updates, deletion, and queries for issuing and tracking customer credits.

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 for the credit memo.
ReferenceNumber	String	False		21	The reference number associated with the credit memo transaction.
TxnNumber	Integer	True			The manually assigned transaction number, used to distinguish this credit memo from others in QuickBooks.
Date	Date	False			The date of the credit memo transaction. If specified in the WHERE clause of a SELECT query, it overrides the pseudo columns StartDate and EndDate.
CustomerName	String	False		1000	The name of the customer associated with the credit memo. Either CustomerName or CustomerId is required when inserting.
CustomerId	String	False	Customers.ID	255	The unique identifier of the customer associated with the credit memo. Either CustomerName or CustomerId is required when inserting.
AccountsReceivable	String	False		1000	The name of the accounts-receivable account where the credit memo is recorded.
AccountsReceivableId	String	False	Accounts.ID	255	The unique identifier of the accounts-receivable account where the credit memo is recorded.
ShipMethod	String	False		1000	The shipping method used for this transaction.
ShipMethodId	String	False	ShippingMethods.ID	255	The unique identifier for the shipping method used.
ShipDate	Date	False			The date when the items were shipped.
Memo	String	False		5000	A memo providing additional information about the credit memo transaction.
Amount	Decimal	False			The total amount for the credit memo transaction.
Message	String	False		101	A message for the customer associated with this credit memo.
MessageId	String	False	CustomerMessages.ID	255	The unique identifier for the message sent to the customer.
SalesRep	String	False		5	The initials or reference to the sales representative associated with the transaction.
SalesRepId	String	False	SalesReps.ID	255	The unique identifier for the sales representative.
FOB	String	False		13	Freight on board: The location from which goods are shipped.
BillingAddress	String	True			The full billing address associated with this credit memo.
BillingLine1	String	False		500	The first line of the billing address.
BillingLine2	String	False		500	The second line of the billing address.
BillingLine3	String	False		500	The third line of the billing address.
BillingLine4	String	False		500	The fourth line of the billing address.
BillingLine5	String	False		41	The fifth line of the billing address.
BillingCity	String	False		255	The city associated with the billing address.
BillingState	String	False		255	The state associated with the billing address.
BillingPostalCode	String	False		30	The postal code associated with the billing address.
BillingCountry	String	False		255	The country associated with the billing address.
BillingNote	String	False		41	A note providing additional context for the billing address.
ShippingAddress	String	True			The full shipping address associated with this credit memo.
ShippingLine1	String	False		500	The first line of the shipping address.
ShippingLine2	String	False		500	The second line of the shipping address.
ShippingLine3	String	False		500	The third line of the shipping address.
ShippingLine4	String	False		500	The fourth line of the shipping address.
ShippingLine5	String	False		41	The fifth line of the shipping address.
ShippingCity	String	False		255	The city associated with the shipping address.
ShippingState	String	False		255	The state associated with the shipping address.
ShippingPostalCode	String	False		30	The postal code associated with the shipping address.
ShippingCountry	String	False		255	The country associated with the shipping address.
ShippingNote	String	False		41	A note providing additional context for the shipping address.
Subtotal	Decimal	True			The gross subtotal of the credit memo, excluding tax or any applied payments.
Tax	Double	False			The total amount of sales tax applied to the credit memo.
TaxItem	String	False		100	The sales tax item applied to this transaction, collected at a specified rate and paid to a single agency.
TaxItemId	String	False	SalesTaxItems.ID	255	The unique identifier of the sales tax item applied to this transaction.
TaxPercent	Double	True			The percentage rate charged for sales tax on this transaction.
IsPending	Boolean	False			Indicates whether this transaction is pending or completed.
IsToBeEmailed	Boolean	False			Specifies whether the credit memo is to be emailed to the customer.
IsToBePrinted	Boolean	False			Specifies whether the credit memo is to be printed.
IsTaxIncluded	Boolean	False			Determines if the transaction amount includes tax. Available only in international editions of QuickBooks.
PONumber	String	False		25	The purchase order number associated with this transaction.
Terms	String	False		100	The payment terms associated with the credit memo.
TermsId	String	False		255	The unique identifier for the payment terms.
CreditRemaining	Double	True			The remaining credit amount available for this credit memo.
DueDate	Date	False			The date when the credit memo payment is due.
Template	String	False		100	The name of the template applied to this credit memo transaction.
TemplateId	String	False	Templates.ID	255	The unique identifier of the template applied to this credit memo.
CustomerSalesTax	String	False		3	The sales tax information for the customer associated with this transaction.
CustomerSalesTaxId	String	False	SalesTaxCodes.ID	255	The unique identifier of the sales tax information for the customer.
Class	String	False		1000	The class associated with this credit memo transaction for categorization.
ClassId	String	False	Class.ID	255	The unique identifier for the class associated with this credit memo transaction.
ExchangeRate	Double	False			The exchange rate used for converting currency in this transaction.
ItemCount	Integer	True			The total number of line items in this credit memo.
ItemAggregate	String	False		5000	An aggregate of the line item data, useful for adding a credit memo with its line items.
TransactionCount	Integer	True			The total number of related transactions linked to this credit memo.
TransactionAggregate	String	True		5000	An aggregate of the data for transactions linked to this credit memo.
CustomFields	String	False			Custom fields associated with this credit memo, formatted as XML.
EditSequence	String	True		16	An identifier used for versioning this specific credit memo object.
TimeModified	Datetime	True			The timestamp of the last modification made to this credit memo.
TimeCreated	Datetime	True			The timestamp of when this 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.