CData JDBC Driver for Reckon 2019 - Online Help
Questions / Feedback?

SalesOrders

CData JDBC Driver for Reckon 2019 - Build 19.0.7354

Create, update, delete, and query Reckon Sales Orders.

Table Specific Information

SalesOrders may be inserted, queried, or updated via the SalesOrders or SalesOrderLineItems table. SalesOrders may be deleted by using the SalesOrders 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.

Reckon 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 SalesOrders are Id, Date, TimeModified, ReferenceNumber, CustomerName, and CustomerId. 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 SalesOrders WHERE TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND ReferenceNumber LIKE '%12345%'

Insert

To add a SalesOrder, specify the 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 SalesOrderLineItems tables as # columns. For example, the following will insert a new SalesOrder with two Line Items:

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

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 Description
ID [KEY] String True

The unique identifier.

ReferenceNumber String False

Transaction reference number.

TxnNumber Integer True

The transaction number. An identifying number for the transaction, different from the Reckon-generated Id.

CustomerName String False

Customers.FullName

Customer name this transaction is recorded under. This is required to have a value when inserting.

CustomerId String False

Customers.ID

Customer Id this transaction is recorded under.

Date Date False

Transaction date.

ShipMethod String False

ShippingMethods.Name

Shipping method.

ShipMethodId String False

ShippingMethods.ID

Shipping method.

ShipDate Date False

Shipping date.

Memo String False

Memo regarding this transaction.

Class String False

Class.FullName

A reference to the class of the transaction.

ClassId String False

Class.ID

A reference to the class of the transaction.

TotalAmount Double False

Total amount for this transaction.

DueDate Date False

Date the payment is due.

Message String False

CustomerMessages.Name

Message to the customer.

MessageId String False

CustomerMessages.ID

Message to the customer.

SalesRep String False

SalesReps.Initial

Reference to (the initials of) the sales rep.

SalesRepId String False

SalesReps.ID

Reference to the sales rep.

Template String False

Templates.Name

The name of an existing template to apply to the transaction.

TemplateId String False

Templates.ID

The Id of an existing template to apply to the transaction.

FOB String False

Freight on board: The place to ship from.

BillingAddress String True

Full billing address returned by Reckon.

BillingLine1 String False

First line of the billing address.

BillingLine2 String False

Second line of the billing address.

BillingLine3 String False

Third line of the billing address.

BillingLine4 String False

Fourth line of the billing address.

BillingLine5 String False

Fifth line of the billing address.

BillingCity String False

City name for the billing address.

BillingState String False

State name for the billing address.

BillingPostalCode String False

Postal code for the billing address.

BillingCountry String False

Country for the billing address.

BillingNote String False

Note for the billing address.

ShippingAddress String True

Full shipping address returned by Reckon.

ShippingLine1 String False

First line of the shipping address.

ShippingLine2 String False

Second line of the shipping address.

ShippingLine3 String False

Third line of the shipping address.

ShippingLine4 String False

Fourth line of the shipping address.

ShippingLine5 String False

Fifth line of the shipping address.

ShippingCity String False

City name for the shipping address.

ShippingState String False

State name for the shipping address.

ShippingPostalCode String False

Postal code for the shipping address.

ShippingCountry String False

Country for the shipping address.

ShippingNote String False

Note for the shipping address.

Subtotal Double 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

SalesTaxItems.Name

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

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.

PONumber String False

Purchase order number.

Terms String False

Payment terms.

TermsId String False

Payment terms.

ItemCount Integer True

The count of item entries for this transaction.

ItemAggregate String False

An aggregate of the line item data which can be used for adding a SalesOrders and its Line Item data.

TransactionCount Integer True

The count of related transactions to the bill.

TransactionAggregate String True

An aggregate of the linked transaction data.

CustomerTaxCode String False

SalesTaxCodes.Name

The tax code specific to this customer.

CustomerTaxCodeId String False

SalesTaxCodes.ID

The tax code specific to this customer.

IsPrinted Boolean True

Whether this invoice is to be printed.

IsManuallyClosed Boolean False

Whether this sales order is manually closed.

IsFullyInvoiced Boolean True

Whether this sales order is fully invoiced.

IsTaxIncluded Boolean False

Determines if tax is included in the transaction amount.

IsToBePrinted Boolean False

Whether this sales order is to be printed.

IsToBeEmailed Boolean False

Whether this sales order is to be emailed.

Other String False

A predefined Reckon custom field.

CustomFields String False

Custom fields returned from Reckon and formatted into XML.

EditSequence String True

An identifier used for versioning for this copy of the object.

TimeModified Datetime True

When the sales order was last modified.

TimeCreated Datetime True

When the sales order 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.

StartTxnDate String

This pseudo column is deprecated and should no longer be used. Earliest transaction date to search for.

EndTxnDate String

This pseudo column is deprecated and should no longer be used. Latest transaction date to search for.

StartModifiedDate String

This pseudo column is deprecated and should no longer be used. Earliest modified date to search for.

EndModifiedDate String

This pseudo column is deprecated and should no longer be used. Latest modified date to search for.

 
 
Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 19.0.7354.0