Company Component

Properties   Methods   Events   Config Settings   Errors  

The Company component is used to retrieve information about the QuickBooks company.

Syntax

DPayments.InQB.Company

Remarks

To retrieve information about the QuickBooks company, simply invoke Get. A variety of information will be returned, and may be accessed via read-only properties such as CompanyName, Address, etc. Note that the component allows only read-only access to company information; any changes must be done from within the QuickBooks UI.

The QuickBooks connection may be configured as with other components in the package.

Property List

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

Method List

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

Event List

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

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Address Property (Company Component)

Company address.

Syntax

• C#
• VB.NET

public string Address { get; }

Public ReadOnly Property Address As String

Default Value

""

Remarks

The address of the QuickBooks company.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address component to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

This property is read-only.

CompanyName Property (Company Component)

Company name.

Syntax

• C#
• VB.NET

public string CompanyName { get; }

Public ReadOnly Property CompanyName As String

Default Value

""

Remarks

The name of the QuickBooks company.

This property is read-only.

CompanyType Property (Company Component)

The type of company.

Syntax

• C#
• VB.NET

public string CompanyType { get; }

Public ReadOnly Property CompanyType As String

Default Value

""

Remarks

The type of company, as originally chosen by the QuickBooks user.

This property is read-only.

EIN Property (Company Component)

The EIN of the company.

Syntax

• C#
• VB.NET

public string EIN { get; }

Public ReadOnly Property EIN As String

Default Value

""

Remarks

The EIN (Employer Identification Number) of the company.

To retrieve this property, you must set QBXMLVersion to "2.0" or greater.

This property is read-only.

Email Property (Company Component)

Company email address.

Syntax

• C#
• VB.NET

public string Email { get; }

Public ReadOnly Property Email As String

Default Value

""

Remarks

The email address of the QuickBooks company.

This property is read-only.

Fax Property (Company Component)

Company fax number.

Syntax

• C#
• VB.NET

public string Fax { get; }

Public ReadOnly Property Fax As String

Default Value

""

Remarks

The fax number of the QuickBooks company.

This property is read-only.

FileId Property (Company Component)

Identifies a company file.

Syntax

• C#
• VB.NET

public string FileId { get; }

Public ReadOnly Property FileId As String

Default Value

""

Remarks

This property will be populated after a call to Get if OwnerId was specified in the request.

This is commonly used to identify if the company file has previously been accessed by your application identified by OwnerId.

This format of this value must adhere to the GUIDTYPE defined in the QuickBooks SDK. The format is {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX} where X is a hexadecimal digit. For example: {6B063959-81B0-4622-85D6-F548C8CCB517}

This property is read-only.

FirstMonthFiscal Property (Company Component)

The first month in the company's fiscal year.

Syntax

• C#
• VB.NET

public string FirstMonthFiscal { get; }

Public ReadOnly Property FirstMonthFiscal As String

Default Value

""

Remarks

The first month in the company's fiscal year. Will be the name of the month (i.e., "January", "February", etc.)

This property is read-only.

FirstMonthTax Property (Company Component)

The first month in the company's tax year.

Syntax

• C#
• VB.NET

public string FirstMonthTax { get; }

Public ReadOnly Property FirstMonthTax As String

Default Value

""

Remarks

The first month in the company's tax year. Will be the name of the month (i.e., "January", "February", etc.)

This property is read-only.

LegalAddress Property (Company Component)

Legal company address.

Syntax

• C#
• VB.NET

public string LegalAddress { get; }

Public ReadOnly Property LegalAddress As String

Default Value

""

Remarks

The legal address of the QuickBooks company.

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address component to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

This property is read-only.

LegalName Property (Company Component)

Legal company name.

Syntax

• C#
• VB.NET

public string LegalName { get; }

Public ReadOnly Property LegalName As String

Default Value

""

Remarks

The legal name of the QuickBooks company.

This property is read-only.

OwnerId Property (Company Component)

The Id of an application.

Syntax

• C#
• VB.NET

public string OwnerId { get; set; }

Public Property OwnerId As String

Default Value

""

Remarks

This property specifies the Id of an application. It is commonly used in conjunction with the QBWCServer component to check if the application has previously communicated with the specified company file in the past.

If this property is set before calling Get, QuickBooks will return a value for FileId (if one exists). This can be compared to a known FileId value to determine if your application has previously worked with this file.

This format of this value must adhere to the GUIDTYPE defined in the QuickBooks SDK. The format is {XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX} where X is a hexadecimal digit. For example: {6B063959-81B0-4622-85D6-F548C8CCB517}

Phone Property (Company Component)

Company phone number.

Syntax

• C#
• VB.NET

public string Phone { get; }

Public ReadOnly Property Phone As String

Default Value

""

Remarks

The phone number of the QuickBooks company.

This property is read-only.

QBConnectionString Property (Company Component)

An aggregate consisting of various QuickBooks connection properties.

Syntax

• C#
• VB.NET

public string QBConnectionString { get; set; }

Public Property QBConnectionString As String

Default Value

""

Remarks

QBConnectionString allows the user to customize the application's interaction with QuickBooks.

The connection properties should be formatted in a sequence as follows:

propertyname = "propertyvalue" propertyname = "propertyvalue" ...

The order is irrelevant, and the whitespace around the equal sign is optional.

The following properties are currently supported:

QBRequestAggregate Property (Company Component)

The request aggregate.

Syntax

• C#
• VB.NET

public string QBRequestAggregate { get; set; }

Public Property QBRequestAggregate As String

Default Value

""

Remarks

This property will be populated when QBRequestMode is set to rmOffline and a method is called. This is used when working with the QBWCServer component to generate requests to be sent to QuickBooks Web Connector.

This property is not available at design time.

QBRequestMode Property (Company Component)

Defines whether the request is made online or stored offline.

Syntax

• C#
• VB.NET

public CompanyQBRequestModes QBRequestMode { get; set; }

enum CompanyQBRequestModes {
  rmOnline,
  rmOffline
}

Public Property QBRequestMode As CompanyQBRequestModes

Enum CompanyQBRequestModes
  rmOnline
  rmOffline
End Enum

Default Value

0

Remarks

This property defines the behavior of the component when calling a method. Possible values are:

The use of offline mode is required when using the QBWCServer component. This allows requests to be generated and passed to QuickBooks Web Connector through the QBWCServer component.

For normal communication to QuickBooks either directly or through the QBConnector application use the default online mode.

QBResponseAggregate Property (Company Component)

The last QBXML response aggregate received from QuickBooks.

Syntax

• C#
• VB.NET

public string QBResponseAggregate { get; set; }

Public Property QBResponseAggregate As String

Default Value

""

Remarks

The last QBXML response aggregate received from QuickBooks. This property is set whenever a response is received from QuickBooks.

This property may also be set to a response aggregate. When set to a QBXML aggregate, such as a response from ObjSearch or QBWCServer the component will parse the response as if it had been received directly from QuickBooks and the applicable properties will be updated.

This property is not available at design time.

QBXMLVersion Property (Company Component)

The version of QBXML used in the outgoing message.

Syntax

• C#
• VB.NET

public string QBXMLVersion { get; set; }

Public Property QBXMLVersion As String

Default Value

"3.0"

Remarks

The version of QBXML used in the outgoing message. Except as noted in the documentation, a value of "1.1" will suffice for all requests, and for all versions of QuickBooks which support integrated applications.

With each release of QuickBooks since 2002, a corresponding version of the QuickBooks SDK has also been released: 1.0 for QuickBooks 2002, 2.0 for QuickBooks 2003, 3.0 for QuickBooks 2004, etc., up to 8.0 for QuickBooks 2009. In addition, each release of QuickBooks continues to support all earlier versions of the SDK, meaning that requests using version 1.1 of the QuickBooks SDK are supported by all versions of QuickBooks. However, new requests and newer fields in existing requests are only supported in later versions of the QuickBooks SDK. As such, it is recommended that you set the QBXMLVersion property to correspond to the version of QuickBooks you are interacting with. These values are:

In addition, versions of QuickBooks outside of the U.S. released before Quickbooks 2008 adhere to a different version of the QuickBooks SDK. These versions were updated with less frequency than the U.S. SDK, and may omit features introduced in later releases:

With the exception of Province in Address (set State) or EligibleForT4A in Vendor (set EligibleFor1099), Canadian-only fields are read-only and may be accessed with Config.

This property is not available at design time.

Services Property (Company Component)

Information about the Intuit services the company is currently subscribed to.

Syntax

• C#
• VB.NET

public CompanyServiceList Services { get; }

Public ReadOnly Property Services As CompanyServiceList

Remarks

This collection will contain a list of Intuit services that the queried company is currently subscribed to. For example: Intuit Payroll, QBMS, and so forth.

This property is read-only and not available at design time.

ShipToAddress Property (Company Component)

Company shipping address.

Syntax

• C#
• VB.NET

public string ShipToAddress { get; }

Public ReadOnly Property ShipToAddress As String

Default Value

""

Remarks

The shipping address of the QuickBooks company (as it will appear on purchase orders).

The address is stored as a string, formatted as XML. It may be read and written directly, or with the Address component.

To read an address, set the Aggregate property of an Address component to this value, and read the values of the desired fields. To write an address, write the values of the desired Address fields and set this property to the Address's Aggregate.

To read and/or write directly, use the QBXML formatting: <Addr1>Line1</Addr1><Addr2>Line2</Addr2><Addr3>Line3</Addr3> <City>City</City><State>State</State><PostalCode>PostalCode</PostalCode> <Country>Country</Country>

This property is read-only.

SSN Property (Company Component)

The SSN of the company.

Syntax

• C#
• VB.NET

public string SSN { get; }

Public ReadOnly Property SSN As String

Default Value

""

Remarks

The Social Security Number, used if no EIN has been issued by the government.

To retrieve this property, you must set QBXMLVersion to "2.1" or greater.

This property is read-only.

TaxForm Property (Company Component)

The tax form used by the company.

Syntax

• C#
• VB.NET

public string TaxForm { get; }

Public ReadOnly Property TaxForm As String

Default Value

""

Remarks

The tax form used by the company. Will be one of the following values: "Form1120", "Form1120S", "Form1065", "Form990", "Form990PF", "Form990T", "Form1040", "OtherOrNone".

To retrieve this property, you must set QBXMLVersion to "2.1" or greater.

This property is read-only.

Website Property (Company Component)

Company website URL.

Syntax

• C#
• VB.NET

public string Website { get; }

Public ReadOnly Property Website As String

Default Value

""

Remarks

The web URL of the QuickBooks company.

This property is read-only.

Config Method (Company Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Get Method (Company Component)

Gets the company information from QuickBooks.

Syntax

• C#
• VB.NET

public void Get();

Public Sub Get()

Remarks

When you invoke Get, the component will get the company information from QuickBooks, using the connection information provided in QBConnectionString, QBXMLVersion, and elsewhere. When the method returns you may retrieve the appropriate information from the relevant properties.

Error Event (Company Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, CompanyErrorEventArgs e);

public class CompanyErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As CompanyErrorEventArgs)

Public Class CompanyErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

SSLServerAuthentication Event (Company Component)

Fired after the server presents its certificate to the client.

Syntax

• C#
• VB.NET

public event OnSSLServerAuthenticationHandler OnSSLServerAuthentication;

public delegate void OnSSLServerAuthenticationHandler(object sender, CompanySSLServerAuthenticationEventArgs e);

public class CompanySSLServerAuthenticationEventArgs : EventArgs {
  public string CertEncoded { get; }
  public byte[] CertEncodedB { get; }
  public string CertSubject { get; }
  public string CertIssuer { get; }
  public string Status { get; }
  public bool Accept { get; set; }
}

Public Event OnSSLServerAuthentication As OnSSLServerAuthenticationHandler

Public Delegate Sub OnSSLServerAuthenticationHandler(sender As Object, e As CompanySSLServerAuthenticationEventArgs)

Public Class CompanySSLServerAuthenticationEventArgs Inherits EventArgs
  Public ReadOnly Property CertEncoded As String
  Public ReadOnly Property CertEncodedB As Byte()
  Public ReadOnly Property CertSubject As String
  Public ReadOnly Property CertIssuer As String
  Public ReadOnly Property Status As String
  Public Property Accept As Boolean
End Class

Remarks

This event is where the client can decide whether to continue with the connection process or not. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue or not.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK"). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (Company Component)

Shows the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

public delegate void OnSSLStatusHandler(object sender, CompanySSLStatusEventArgs e);

public class CompanySSLStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnSSLStatus As OnSSLStatusHandler

Public Delegate Sub OnSSLStatusHandler(sender As Object, e As CompanySSLStatusEventArgs)

Public Class CompanySSLStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Status Event (Company Component)

Shows the progress of the QuickBooks connection.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

public delegate void OnStatusHandler(object sender, CompanyStatusEventArgs e);

public class CompanyStatusEventArgs : EventArgs {
  public string Message { get; }
}

Public Event OnStatus As OnStatusHandler

Public Delegate Sub OnStatusHandler(sender As Object, e As CompanyStatusEventArgs)

Public Class CompanyStatusEventArgs Inherits EventArgs
  Public ReadOnly Property Message As String
End Class

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Warning Event (Company Component)

Fired when a warning occurs.

Syntax

• C#
• VB.NET

public event OnWarningHandler OnWarning;

public delegate void OnWarningHandler(object sender, CompanyWarningEventArgs e);

public class CompanyWarningEventArgs : EventArgs {
  public int Code { get; }
  public string Description { get; }
}

Public Event OnWarning As OnWarningHandler

Public Delegate Sub OnWarningHandler(sender As Object, e As CompanyWarningEventArgs)

Public Class CompanyWarningEventArgs Inherits EventArgs
  Public ReadOnly Property Code As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Warning event is fired when the component has produced, or will produce, possibly unexpected results.

Warnings may be generated by QuickBooks or the component. Starred warning codes correspond to warnings and warning codes generated by QuickBooks.

Unlisted QuickBooks warnings will cause the component to throw an exception instead.

Warning 801 will be thrown if the user attempts to Update properties that cannot be updated. For example, the following code will cause this warning to be fired: Customer1.GetByName("Joe Smith") Customer1.Email = "joe@abc.com" 'ok Customer1.CreditLimit = "200.00" 'Not used in Update operations! Customer1.Update() Only the email address will be updated, and the credit limit will be unchanged. Each property description for entity objects lists whether or not it is used in Update operations.

CompanyService Type

Information about a single Intuit service that a company is currently subscribed to.

Remarks

This type contains the Name, Domain, and Status of a single service that a company is subscribed to.

Fields

Constructors

• C#
• VB.NET

public CompanyService();

Public CompanyService()

Config Settings (Company Component)

Company Config Settings

Base Config Settings

Trappable Errors (Company Component)

The following errors may be generated by the component. Note that frequently the error message will contain more specific information than what is listed here.

Company Errors

	101   String too long.
	103   Invalid date format (YYYY-MM-DD is standard).
	104   Invalid value for enumerated field.
	105   Invalid integer.
	106   Invalid dollar amount.
	107   Invalid boolean value (must be 'true' or 'false').
	108   Invalid number.
	111   Invalid special characters in string.
	112   Invalid special field syntax.
	181   Could not load certificate file.
	201   Required field unspecified.
	211   Unsupported field specified.
	301   Array line count must be nonnegative.
	302   Array index out of bounds.
	303   Invalid field index.
	401   Field not accessible as a special field.
	402   Write access attempted of readonly field.
	403   Read access attempted of writeonly field.
	421   The object cannot be modified.
	511   The QBRequestId has been previously used. Please generate a new one.
	601   Could not access QuickBooks.
	602   Could not open specified file.
	603   The version of QuickBooks currently being used is not supported.
	604   QuickBooks has not been installed properly.
	605   The specified file was of an incorrect version.
	606   Could not start QuickBooks.
	607   QuickBooks is open in a mode different than the one requested.
	608   QuickBooks cannot currently be accessed.
	609   An application name must be specified.
	610   A file name must be specified if one is not currently open in QuickBooks.
	611   Access denied.
	612   QuickBooks is busy and cannot open your application in the mode requested.
	699   The connection to QuickBooks has failed for an unknown reason.
	702   The object requested does not exist in QuickBooks.
	751   Unsupported QBXML version.
	752   The QBXMLVersion chosen is insufficient to execute the request.
	801   A QuickBooks internal error has occurred.
	802   QuickBooks is not available due to a system-related problem.
	803   The Id specified is invalid.
	804   Invalid object name.
	805   The name already exists in QuickBooks.
	807   An object could not be found in QuickBooks.
	808   A reference did not refer to an object that exists in QuickBooks.
	809   The object is currently in use by the QuickBooks end user.
	810   The object may not be added.
	811   The object may not be updated because it is obsolete.
	812   The address is invalid.
	813   Permission to perform this operation is not granted.
	814   The request has not been processed.
	815   Time creation mismatch.
	816   The feature is turned off or not enabled.
	817   Permission level configured is insufficient for access.
	818    The item specified was of an unknown type.
	819   The object may not be changed.
	820   An internal QuickBooks error has occurred.
	821   An attempt was made to use a connection that was not properly initiated.
	822   An attempt was made to use a connection that is invalid or was previously closed.
	823   Not enough memory.
	824   Unable to lock the necessary information to allow this application access to the company file. Try again later.
	850   An older version of QuickBooks 2002 is being used. Please download the latest update from Intuit.
	851   The QuickBooks request processor was not found. Check that QuickBooks Pro 2002 or higher is installed on your system.
	861   Server error on WebExport (details follow).
	862   The WebExport is impossible: an HTTP context was not found.
	871   You may not set the value of QBConnectionTicket. This value is readonly.
	880   Interrupted by the user.
	881   An error has occurred connecting to a remote machine.
	899   An unknown QuickBooks error has occurred. The message contains more details.
	901   XML Parser Error. Should not occur under normal circumstances.