QuickBooks Integrator Customer Component : Customer OCX, Customer .NET Component, Customer Class, Customer Bean, Customer Object

Available in: QUICKBOOKS

Customer Component [IBiz Integrator for QuickBooks - V4]

Properties Methods Events Configuration Settings

A Customer is anyone who buys goods or services from the QuickBooks company.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

A Customer is anyone who buys goods or services from the QuickBooks company. A Customer may also be used to represent a sub-customer or Job.

Required Fields (Add): CustomerName

Supported Methods: Add, Update (contact info only), Get (Id/Name), Delete

Online Edition: Leave out IsActive, ContactName, AltContactName, CustomerType*, SalesRep*, TaxCode*, TaxItem*, AccountNumber, and special fields related to job information.

Example (Adding a customer to QuickBooks)

Customer1.CustomerName = "John Doe" Customer1.Add()
Contact Information: Contact information may be added, retrieved, or changed. The key property is CustomerName. CompanyName, ContactName, and AltContactName may be used to specify additional names/contacts for the customer. BillingAddress, ShippingAddress, Fax, Email, Phone, and AltPhone may all be set or changed as well.

Categorization and Financial Information: the following properties are not used in Update operations, and may only be modified from within the QuickBooks UI.


CustomerType*	The type of customer: residential, commercial, etc.
SalesRep*	A sales rep for the customer.
TaxItem, TaxCode	Taxation information for the customer.
Terms*	Terms on which the customer will be billed.

Tracking Customer Balances:

The Customer component may be used to track the outstanding balances of customers. After invoking Get, simply inspect the Balance property;. The OBJSEARCH component can be used to find unpaid and paid INVOICEs tied to this customer.

When a customer is added to QuickBooks, the CreditLimit may be set, and the OpeningBalance (special field) may be set, if there is one. Once a customer is added to QuickBooks, there is no way to modify Balance directly! Instead, INVOICEs or CREDITMEMOs should be added referencing this customer.

Sub-Customers (Jobs)

QuickBooks allows the user to define customers hierarchically. This allows the QuickBooks user to track transactions involving the Job separately.

To add a job to QuickBooks, set the Parent* property to the parent customer. Then, detailed job information may be provided using Config. When a job is retrieved from QuickBooks, Parent* will refer to the parent customer.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


AccountNumber	Account number for this entity.
AltContactName	Alternate contact person for entity.
AltPhone	Alternate phone number of entity.
Balance	Money owed by this Customer, including sub-customers.
BillingAddress	Billing address for customer.
CompanyName	Company name of customer or vendor.
ContactName	Contact person for a customer or vendor.
CreditCardAddress	The address associated with the address for this credit card.
CreditCardExpMonth	The month when the credit card expires.
CreditCardExpYear	The year when the credit card expires.
CreditCardNumber	The credit card number on file for this customer.
CreditCardPostalCode	The postal code associated with the address for this credit card.
CreditLimit	Credit limit for this entity.
CustomerName	Customer's name.
CustomerTypeId	Reference to type of customer.
CustomerTypeName	Reference to type of customer.
Email	Email address of entity.
Fax	Fax number of entity.
IsActive	Whether or not entity is active.
NameOnCard	The name as it appears on the customer's credit card
Notes	Notes for this transaction.
ParentId	Reference to parent Customer.
ParentName	Reference to parent Customer.
Phone	Phone number of entity.
QBAddRequestAggregate	Request aggregate for an Add.
QBConnectionMode	The mode of connection to QuickBooks.
QBConnectionString	An aggregate consisting of various QuickBooks connection properties.
QBOpenCompanyFile	The file currently open in QuickBooks.
QBRequestId	The Id of the next message to be sent to QuickBooks.
QBResponseAggregate	The last XML response aggregate received from QuickBooks.
QBUpdateRequestAggregate	Request aggregate for an Update.
QBXMLVersion	The version of QBXML used in the outgoing message.
RefId	An alphanumerical identifier generated by the server.
ResaleNumber	Resale number.
SalesRepId	Reference to (initials of) sales rep.
SalesRepName	Reference to (initials of) sales rep.
ShippingAddress	Shipping address for customer.
TaxCodeId	Whether or not transactions with customer are taxable.
TaxCodeName	Whether or not transactions with customer are taxable.
TaxItemId	Reference to detailed taxation information.
TaxItemName	Reference to detailed taxation information.
TermsId	Reference to terms of payment.
TermsName	Reference to terms of payment.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


AXMExport	Exports the object.
AXMImport	Imports the object.
Add	Adds the record into QuickBooks.
CheckRequestStatus	Checks whether or not the specified request was processed by QuickBooks.
CloseQBConnection	Closes a persistent connection to QuickBooks.
Config	Sets or retrieves a component configuration setting.
Delete	Deletes the record from QuickBooks.
Get	Gets a single record from QuickBooks.
GetByName	Gets a single record from QuickBooks.
GetCustomField	Gets a custom field value from QuickBooks.
OpenQBConnection	Opens a persistent connection to QuickBooks.
Reset	Resets all properties to their defaults.
SetCustomField	Sets a custom field value within QuickBooks.
Update	Updates the entity object in QuickBooks.
WebExport	Exports the object to a web client.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


Error	Information about errors during data delivery.
Status	Shows the progress of the QuickBooks connection.
Warning	Fired when a warning occurs.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AppendAfter	Appends an xml tag after the specified QBXML element.
AuthFlags	Connection Flags (use for QuickBooks Simple Start).
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
EditSequence	An identifier for this copy of the object.
EnforceMaxLength	Indicates whether to enforce max lengths for QB Fields
FirstName	A first name.
FullName	The name of the customer.
GetHighestVersion	Highest QBXMLVersion supported by the installed instance of Quickbooks.
IgnoreQBOEWarnings	Ignores warnings returned from QuickBooks Online.
IsActive	Indicates whether the object is currently enabled for use by QuickBooks.
JobDescription	Description of the job.
JobEndDate	Actual end date of the job, YYYY-MM-DD.
JobProjectedEndDate	Projected end date of the job, YYYY-MM-DD.
JobStartDate	Start date of the job, YYYY-MM-DD.
JobStatus	The status of the job
JobTypeId	Reference to the type of job.
JobTypeName	Reference to the type of job.
LastName	A last name.
MiddleInitial	A middle initial.
NonInclusiveBalance	The Balance of the Customer, not including sub-customers.
OpeningBalance	The opening balance for the customer or vendor. Not used in Update operations.
OpeningBalanceDate	The opening balance date for the customer or vendor. Not used in Update operations.
PreferredPaymentMethodId	The preferred method of payment.
PreferredPaymentMethodName	The preferred method of payment.
PriceLevelId	Reference to a price level for the customer.
PriceLevelName	Reference to a price level for the customer.
SSLAcceptServerCert	The SSL certificate being used by the Remote Connector
SSLAcceptServerCertFile	The SSL certificate file being used by the Remote Connector
Salutation	A salutation, such as Mr., Mrs., etc.
SendRawXML	Sends specified XML to quickbooks without modification.
SeparateContact	A contact person other than the person specified by Salutation, FirstName, MiddleInitial, and LastName.
Sublevel	The number of ancestors this Customer has.
TimeCreated	The time the object was created.
TimeModified	The time the object was created.