CData Python Connector for Reckon

Build 23.0.8839

Customers

Create, update, delete, and query Reckon Customers.

Table Specific Information

To add a Customer, you must specify the Name field.

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 typically be used with only the equals or = comparison. The available columns for Customers are Id, Name, Balance, IsActive, and TimeModified. TimeModified may be used with the >, >=, <, <=, or = conditions and may be used twice to specify a range. Balance may be used with the >=, <=, or = conditions but cannot be used to specify a range. Name may be used with the = or LIKE conditions to establish a starts-with, ends-with, or contains syntax. For example:

SELECT * FROM Customers WHERE Name LIKE '%George%' AND TimeModified > '1/1/2011' AND TimeModified < '2/1/2011' AND Balance > 100.00 AND Balance < 200.00

Columns

Name Type ReadOnly References Description
ID [KEY] String True

The unique identifier of the customer.

Name String False

The name of the customer. This is required to have a value when inserting.

FullName String True

The full name of the customer, including parents in the format parent:customer.

Salutation String False

A salutation, such as Mr., Mrs., etc.

FirstName String False

The first name of the customer as stated in the address info.

MiddleInitial String False

A middle name or middle initial of the customer.

LastName String False

The last name of the customer as stated in the address info.

AccountNumber String False

The account number for the customer.

Company String False

The name of the company of the customer.

Balance Double True

The balance owned by this customer including subcustomers.

CustomerBalance Double True

The balance owned by only this customer not including subcustomers.

Contact String False

The name of the main contact person for the customer.

Type String False

CustomerTypes.FullName

A predefined customer type within Reckon. Typical customer types, if defined, might be Commercial, Residential, etc.

TypeId String False

CustomerTypes.ID

A predefined customer type within Reckon.

Phone String False

The main telephone number for the customer.

Fax String False

The fax number number for the customer.

AlternateContact String False

The name of an alternate contact person for the customer.

AlternatePhone String False

The alternate telephone number for the customer.

Email String False

The email address for communicating with the customer.

Notes String False

The first note for a customer. To retrieve all notes for a customer, use the NotesAggregate column or the CustomerNotes table.

ParentName String False

Customers.FullName

The parent name of the job.

ParentId String False

Customers.ID

The parent Id of the job.

Sublevel Integer False

The number of ancestors this customer has.

JobStatus String False

The current status of the job.

The allowed values are Awarded, Closed, InProgress, None, NotAwarded, Pending.

JobStartDate Date False

The start date of the job.

JobProjectedEndDate Date False

The expected end date for the job.

JobEndDate Date False

The actual end date for the job.

JobDescription String False

A description of the job.

JobType String False

The name of the job type.

JobTypeId String False

A job type reference Id.

CreditCardAddress String False

The address associated with the credit card.

CreditCardExpMonth Integer False

The expiration month associated with the credit card.

CreditCardExpYear Integer False

The expiration year associated with the credit card.

CreditCardNameOnCard String False

The name as it appears on the credit card of the customer.

CreditCardNumber String False

The credit card number on file for this customer.

CreditCardPostalCode String False

The postal code associated with the address and number on file for this customer.

CreditLimit Double False

The credit limit for this customer. If it is equal to 0, there is no credit limit.

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 of the customer.

BillingState String False

State name for the billing address of the customer.

BillingPostalCode String False

Postal code for the billing address of the customer.

BillingCountry String False

Country for the billing address of the customer.

BillingNote String False

Note for the billing address of the customer.

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 of the customer.

ShippingState String False

State name for the shipping address of the customer.

ShippingPostalCode String False

Postal code for the shipping address of the customer.

ShippingCountry String False

Country for the shipping address of the customer.

ShippingNote String False

Note for the shipping address of the customer.

ResaleNumber String False

The resale number of the customer, if he/she has one. This field can be set in inserts but not in updates.

SalesRep String False

SalesReps.ID

A reference to a sales rep for the customer.

SalesRepId String False

SalesReps.Initial

A reference to a sales rep for the customer.

Terms String False

A reference to terms of payment for this customer. A typical example might be '2% 10 Net 60'. This field can be set in inserts but not in updates.

TermsId String False

A reference to terms of payment for this customer.

TaxCode String False

SalesTaxCodes.Name

This is a reference to a sales tax code predefined within Reckon. This field can be set in inserts but not in updates.

TaxCodeId String False

SalesTaxCodes.ID

This is a reference to a sales tax code predefined within Reckon. This field can be set in inserts but not in updates.

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.

SalesTaxCountry String False

Identifies the country collecting applicable sales taxes. Only available in international editons of Reckon.

PriceLevel String False

PriceLevels.Name

Reference to a price level for the customer.

PriceLevelId String False

PriceLevels.ID

Reference to a price level for the customer.

PreferredPaymentMethodName String False

PaymentMethods.Name

The preferred method of payment.

PreferredPaymentMethodId String False

PaymentMethods.ID

The preferred method of payment.

IsActive Boolean False

Whether or not the customer is active.

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

TimeCreated Datetime True

When the customer 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
NameMatchType String

This pseudo column is deprecated and should no longer be used. Type of match to perform on SearchName.

The allowed values are CONTAINS, EXACT, STARTSWITH, ENDSWITH.

The default value is CONTAINS.

IncludeJobs Boolean

Whether or not to include job information in the results.

The default value is TRUE.

ActiveStatus String

This pseudo column is deprecated and should no longer be used. Limits the search to active or inactive records only or all records.

The allowed values are ACTIVE, INACTIVE, ALL, NA.

The default value is ALL.

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.

MinBalance String

This pseudo column is deprecated and should no longer be used. A minimum balance that returned records should have. Limits the search to records with balances greater than or equal to MinBalance.

MaxBalance String

This pseudo column is deprecated and should no longer be used. A maximum balance that returned records should have. Limits the search to records with balances less than or equal to MaxBalance.

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