Company Class
Properties Methods Events Configuration Settings Errors
The Company class is used to retrieve information about the QuickBooks company.
Syntax
class 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 company_name, address, etc. Note that the class 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 classs in the package.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| address | Company address. |
| company_name | Company name. |
| company_type | The type of company. |
| ein | The EIN of the company. |
| Company email address. | |
| fax | Company fax number. |
| file_id | Identifies a company file. |
| first_month_fiscal | The first month in the company's fiscal year. |
| first_month_tax | The first month in the company's tax year. |
| legal_address | Legal company address. |
| legal_name | Legal company name. |
| owner_id | The Id of an application. |
| phone | Company phone number. |
| qb_connection_string | An aggregate consisting of various QuickBooks connection properties. |
| qb_request_aggregate | The request aggregate. |
| qb_request_mode | Defines whether the request is made online or stored offline. |
| qb_response_aggregate | The last QBXML response aggregate received from QuickBooks. |
| qbxml_version | The version of QBXML used in the outgoing message. |
| service_count | The number of records in the Service arrays. |
| service_domain | Indicates the provider of the service that the company is (or has been) subscribed to. |
| service_name | The name of the Intuit service that the company is (or has been) subscribed to. |
| service_status | The status of the Intuit service that the company is (or has been) subscribed to. |
| ship_to_address | Company shipping address. |
| ssn | The SSN of the company. |
| tax_form | The tax form used by the company. |
| website | Company website URL. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| config | Sets or retrieves a configuration setting. |
| get | Gets the company information from QuickBooks. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| on_error | Information about errors during data delivery. |
| on_ssl_server_authentication | Fired after the server presents its certificate to the client. |
| on_ssl_status | Shows the progress of the secure connection. |
| on_status | Shows the progress of the QuickBooks connection. |
| on_warning | Fired when a warning occurs. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| AppendAfter | Appends an XML tag after the specified QBXML element. |
| AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
| EnforceMaxLength | Indicates whether to enforce max lengths for QB Fields. |
| GetHighestVersion | Highest QBXMLVersion supported by the installed instance of QuickBooks. |
| GetRequestProcessorDLLVersion | Returns the version of the QB Request Processor that is installed on your system. |
| GetSupportedVersions | Returns a list of QBXMLVersions that are supported by QuickBooks. |
| IsReadOnly | This causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only. |
| PersonalDataPref | Whether the connecting application will require access to personal data such as SSN or credit card information. |
| QBConnectionMode | The mode of connection to QuickBooks. |
| QBFileStatus | The status of the company file as it pertains to accepting connections. |
| QBOpenCompanyFile | The file currently open in QuickBooks. |
| SendRawXML | Sends specified XML to quickbooks without modification. |
| SSLAcceptServerCert | The SSL certificate being used by the Remote Connector. |
| SSLAcceptServerCertFile | The SSL certificate file being used by the Remote Connector. |
| StopOnError | Specifies how QuickBooks is to proceed if an error occurs in processing of the current request. |
| UnattendedModePref | Whether connecting while QuickBooks is closed is required or optional for the user. |
| WarningCodes | A comma-separated list of QuickBooks warning codes that should not result in an exception. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |