JDBC Driver for QuickBooks

Build 21.0.7867

CreditMemoLineItems

Create, update, delete, and query QuickBooks Credit Memo Line Items.

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 CreditMemoLineItems 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. All Line Item columns can be used for inserting multiple Line Items for a new CreditMemo transaction. For example, the following will insert a new CreditMemo with two Line Items:

INSERT INTO CreditMemoLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Repairs', 1)
INSERT INTO CreditMemoLineItems#TEMP (CustomerName, ItemName, ItemQuantity) VALUES ('Abercrombie, Kristy', 'Removal', 2)
INSERT INTO CreditMemoLineItems (CustomerName, ItemName, ItemQuantity) SELECT CustomerName, ItemName, ItemQuantity FROM CreditMemoLineItems#TEMP

Columns

Name Type ReadOnly References ColumnSize Description
ID [KEY] String True 255

The unique identifier in the format CreditMemoId|ItemLineId.

CreditMemoId String False

CreditMemos.ID

255

The item 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

Customers.FullName

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

Accounts.FullName

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

ShippingMethods.Name

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

CustomerMessages.Name

101

A message to the customer.

MessageId String False

CustomerMessages.ID

255

Id of the message to the customer.

SalesRep String False

SalesReps.Initial

5

Reference to (the 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

SalesTaxItems.Name

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 it 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

Templates.Name

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

SalesTaxCodes.Name

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

Class.FullName

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.

CustomFields String False

Custom fields returned from QuickBooks and formatted into XML.

ItemLineId String True 255

The line item identifier.

ItemLineNumber String True 255

The line item number.

ItemName String False

Items.FullName

The item name.

ItemId String False

Items.ID

255

The item identifier.

ItemGroup String False

Items.FullName

100

Item group name. Reference to a group of line items this item is part of.

ItemGroupId String False

Items.ID

255

Item group Id. Reference to a group of line items this item is part of.

ItemDescription String False 5000

A description of the item.

ItemUnitOfMeasure String False

UnitOfMeasure.Name

31

In a transaction line item, the name of the unit of measure is selected from within the available units for the item. If the company file is enabled only for single unit of measure per item, this must be the base unit. Only available in QBXML Version 7.0 and above.

ItemQuantity Double False

The quantity of the item or item group specified in this line.

ItemRate Double False

The unit rate charged for this item.

ItemRatePercent Double False

The rate percent charged for this item.

ItemTaxCode String False

SalesTaxItems.Name

3

Sales tax information for this item (taxable or nontaxable).

ItemTaxCodeId String False

SalesTaxItems.ID

255

Sales tax information for this item (taxable or nontaxable).

ItemAmount Decimal False

Total amount for this item.

ItemClass String False

Class.FullName

1000

The class name of the item.

ItemClassId String False

Class.ID

255

The class name of the item.

ItemInventorySiteName String False

InventorySites.Name

31

The inventory site name of this item. This requires QBXML version at least 10.0 and the Advanced Inventory Add-on.

ItemInventorySiteId String False

InventorySites.ID

255

The inventory site Id of this item. This requires QBXML version at least 10.0 and the Advanced Inventory Add-on.

ItemInventorySiteLocationName String False 31

The inventory site location name of this item. This requires QBXML version at least 10.0 and the Advanced Inventory Add-on.

ItemInventorySiteLocationId String False 255

The inventory site location Id of this item. This requires QBXML version at least 10.0 and the Advanced Inventory Add-on.

ItemSerialNumber String False 5000

The serial number of this item. This requires QBXML version at least 11.0 and the Advanced Inventory Add-on.

ItemLotNumber String False 40

The lot number of this item. This requires QBXML version at least 11.0 and the Advanced Inventory Add-on.

ItemOther1 String False 29

The Other1 field of this line item. QBXMLVersion must be set to 6.0 or higher.

ItemOther2 String False 29

The Other2 field of this line item. QBXMLVersion must be set to 6.0 or higher.

ItemCustomFields String False

The custom fields for this lineitem.

ItemUOMSetFullName String False

UnitOfMeasure.Name

1000

Indicates the price of something as a percent.

ItemUOMSetListID String False

UnitOfMeasure.ID

1000

Indicates the price of something as a percent.

ItemIsGetPrintItemsInGroup String False 1000

If true, a list of this group's individual items their amounts will appear on printed forms.

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.

Name Type Description
ItemPriceLevel String

Item price level name. QuickBooks will not return the price level.

ItemOverrideAccount String

The Account Name used to override the default Account for the Item. This is only available during inserts and updates.

ItemOverrideAccountId String

The Account Id used to override the default Account for the Item. This is only available during inserts and updates.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7867