ADO.NET Provider for QuickBooks

Build 24.0.8964

SalesReceipts

Create, update, delete, and query QuickBooks Sales Receipts.

Table Specific Information

SalesReceipts may be inserted, queried, or updated via the SalesReceipts or SalesReceiptLineItems tables. SalesReceipts may be deleted by using the SalesReceipts 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 only be used with the equals or = comparison. The available columns for SalesReceipts are Id, Date, TimeModified, ReferenceNumber, CustomerName, CustomerId, DepositAccount, and DepositAccountId. 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 SalesReceipts WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a SalesReceipt, specify the Customer and at least one Line Item. The ItemAggregate columns 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 SalesReceiptLineItems table and it starts with Item. For example, the following will insert a new SalesReceipt with two Line Items:

INSERT INTO SalesReceipts (CustomerName, ItemAggregate) 
VALUES ('Cook, Brian', 
'<SalesReceiptLineItems>
<Row><ItemName>Repairs</ItemName><ItemQuantity>1</ItemQuantity></Row>
<Row><ItemName>Removal</ItemName><ItemQuantity>2</ItemQuantity></Row>
</SalesReceiptLineItems>')

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

Transaction reference number.

TxnNumber Integer True

The transaction number. An identifying number for the transaction, but not the QuickBooks-generated Id.

CustomerName String False 1000

Customer name this transaction is recorded under.

CustomerId String False

Customers.ID

255

Customer Id this transaction is recorded under.

Date Date False

Transaction date. If it is set in the WHERE clause of a SELECT query, the pseudo columns StartDate and EndDate are overwritten with the value.

ShipMethod String False 1000

Shipping method.

ShipMethodId String False

ShippingMethods.ID

255

Shipping method.

ShipDate Date False

Shipping date.

Memo String False 5000

Memo regarding this transaction.

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.

DueDate Date False

The date when payment is due.

TotalAmount Decimal True

Total amount for this transaction.

Message String False 101

Message to the customer.

MessageId String False

CustomerMessages.ID

255

Message to the customer.

SalesRep String False 5

Reference to (the initials of) the sales rep.

SalesRepId String False

SalesReps.ID

255

Reference to the sales rep.

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.

ExchangeRate Double False

Currency exchange rate for this sales receipt.

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.

BillingState String False 255

State name for the billing address.

BillingPostalCode String False 30

Postal code for the billing address.

BillingCountry String False 255

Country for the billing address.

BillingNote String False 41

Note for the billing address.

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.

ShippingState String False 255

State name for the shipping address.

ShippingPostalCode String False 30

Postal code for the shipping address.

ShippingCountry String False 255

Country for the shipping address.

ShippingNote String False 41

Note for the shipping address.

Subtotal Decimal True

Gross subtotal. This does not include tax or the amount already paid.

Tax Double True

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 it is still pending).

IsToBePrinted Boolean False

Whether this transaction is to be printed.

IsTaxIncluded Boolean False

Determines if tax is included in the transaction amount. This is only available in UK and CA editions.

IsToBeEmailed Boolean False

When true, if no email address is on file for the customer the transaction will fail.

ItemCount Integer True

The count of item entries for this transaction.

ItemAggregate String False 5000

An aggregate of the line item data which can be used for adding a sales receipt and its line item data.

CheckNumber String False 25

Check number.

PaymentMethod String False 100

Payment method.

PaymentMethodId String False

PaymentMethods.ID

255

Payment method.

DepositAccount String False 1000

Account name where this payment is deposited.

DepositAccountId String False

Accounts.ID

255

Account name where this payment is deposited.

CustomerTaxCode String True 3

The tax code specific to this customer.

CustomerTaxCodeId String True

SalesTaxCodes.ID

255

The tax code specific to this customer.

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 sales receipt was last modified.

TimeCreated Datetime True

When the sales receipt 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
Item* String

All line-item-specific columns may be used in insertions.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8964