TimeTracking Component

Properties   Methods   Events   Config Settings   Errors  

The TimeTracking component is used to track employees' time.

Syntax

DPayments.InQB.Timetracking

Remarks

The TimeTracking component is used to track employees' or subcontractors' time.

To add a TimeTracking record to QuickBooks, specify Employee (Name or Id) and set Duration to the number of minutes worked. Employee is not limited to being a QuickBooks employee, and in case a subcontractor or partner's time is being tracked, Employee might be a QuickBooks Vendor or "Other Name" as well.

If the time is billable to a customer, you must also set the BillableStatus, Customer, and ItemService properties. ItemService refers to a service item from the QuickBooks item list, which describes the type of work performed.

Additional properties that may be specified include TransactionDate, PayrollWageItem, and Notes.

Required Fields (Add): Employee*, Duration

Supported Methods: Add, Get (Id), Delete

Example TimeTracking1.EmployeeName = "John Q. Engineer" '* TimeTracking1.Duration = "8:00" '8 hours, 0 minutes Timetracking1.TransactionDate = "04/01/06" TimeTracking1.BillableStatus = bsBillable TimeTracking1.CustomerName = "Our Customer, Inc." '* TimeTracking1.ServiceItemName = "Engineering Design" '* TimeTracking1.Add() '*: Item must already exist in QuickBooks.

The component supports a variety of other operations as well. The component's Get, Cancel, and Delete methods may be used to retrieve and delete TimeTracking records, respectively. The ObjSearch Component may be used to search for TimeTracking records in the QuickBooks database.

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.

BillableStatus Property (TimeTracking Component)

Line item property: Billing status of this item.

Syntax

• C#
• VB.NET

public BillableStatus BillableStatus { get; set; }

enum TimetrackingBillableStatus {
  bsEmpty,
  bsBillable,
  bsNotBillable,
  bsHasBeenBilled
}

Public Property BillableStatus As BillableStatus

Enum TimetrackingBillableStatus
  bsEmpty
  bsBillable
  bsNotBillable
  bsHasBeenBilled
End Enum

Default Value

0

Remarks

The billing status of this line item. If the billing status is empty (that is, if no billing status appears in QuickBooks), then no BillableStatus value will be returned.

Values:

• bsEmpty (0)
• bsBillable (1)
• bsNotBillable (2)
• bsHasBeenBilled (3)

Note, for QBXMLVersion 5.0 and earlier bsBillable corresponds to "IsBillable" and bsHasBeenBilled corresponds to "IsBilled".

CustomerId Property (TimeTracking Component)

A reference to the customer or customer job.

Syntax

• C#
• VB.NET

public string CustomerId { get; set; }

Public Property CustomerId As String

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the company.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

Either CustomerId or CustomerName is required.

CustomerName Property (TimeTracking Component)

A reference to the customer or customer job.

Syntax

• C#
• VB.NET

public string CustomerName { get; set; }

Public Property CustomerName As String

Default Value

""

Remarks

The Customer property indicates the Customer who has purchased goods or services from the company.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Either CustomerId or CustomerName is required.

Duration Property (TimeTracking Component)

The duration of time.

Syntax

• C#
• VB.NET

public string Duration { get; set; }

Public Property Duration As String

Default Value

""

Remarks

The duration of time being tracked.

Time is represented in hours followed by minutes, with the character ':' (colon) separating them. For instance, two hours and thirty minutes is represented as "2:30". Seconds are not supported.

EmployeeId Property (TimeTracking Component)

Reference to employee or subcontractor whose time is being tracked.

Syntax

• C#
• VB.NET

public string EmployeeId { get; set; }

Public Property EmployeeId As String

Default Value

""

Remarks

A reference to the employee or subcontractor whose time is being tracked. The person is typically an Employee but may be a Vendor or an "Other Name" as well. Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

EmployeeName Property (TimeTracking Component)

Reference to employee or subcontractor whose time is being tracked.

Syntax

• C#
• VB.NET

public string EmployeeName { get; set; }

Public Property EmployeeName As String

Default Value

""

Remarks

A reference to the employee or subcontractor whose time is being tracked. The person is typically an Employee but may be a Vendor or an "Other Name" as well. Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

Notes Property (TimeTracking Component)

Notes about this transaction.

Syntax

• C#
• VB.NET

public string Notes { get; set; }

Public Property Notes As String

Default Value

""

Remarks

Notes about this transaction.

PayrollWageItemId Property (TimeTracking Component)

A payment scheme, such as 'Regular Pay'.

Syntax

• C#
• VB.NET

public string PayrollWageItemId { get; set; }

Public Property PayrollWageItemId As String

Default Value

""

Remarks

A payment scheme, such as "Regular Pay", "Overtime Pay", etc. This property may only be specified if (1) Employee in fact refers to an employee, and not a vendor or subcontractor, and (2) the "Use time data to create paychecks" option is selected for this employee (from within the QuickBooks UI.)

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

PayrollWageItemName Property (TimeTracking Component)

A payment scheme, such as 'Regular Pay'.

Syntax

• C#
• VB.NET

public string PayrollWageItemName { get; set; }

Public Property PayrollWageItemName As String

Default Value

""

Remarks

A payment scheme, such as "Regular Pay", "Overtime Pay", etc. This property may only be specified if (1) Employee in fact refers to an employee, and not a vendor or subcontractor, and (2) the "Use time data to create paychecks" option is selected for this employee (from within the QuickBooks UI.)

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

QBConnectionString Property (TimeTracking 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 (TimeTracking 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.

QBRequestId Property (TimeTracking Component)

The Id of the next message to be sent to QuickBooks.

Syntax

• C#
• VB.NET

public string QBRequestId { get; set; }

Public Property QBRequestId As String

Default Value

""

Remarks

The next message Id to be sent to QuickBooks. Message Id's are used by CheckRequestStatus to check on the status of previously made requests.

This property allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this property in conjunction with CheckRequestStatus allows the user to query this internal list.

To enable error recovery, the user application should store the value of QBRequestId before submitting a request to QuickBooks. If a system failure occurs, CheckRequestStatus should be called with this value of QBRequestId to find whether the request was processed before the system failed.

Unique values for QBRequestId will be generated on startup and after each request to QuickBooks. The automatically generated value may be overwritten by the user. Error checking may be turned off by setting QBRequestId equal to the empty string. See CheckRequestStatus for more information on error recovery.

This property is not available at design time.

QBRequestMode Property (TimeTracking Component)

Defines whether the request is made online or stored offline.

Syntax

• C#
• VB.NET

public TimetrackingQBRequestModes QBRequestMode { get; set; }

enum TimetrackingQBRequestModes {
  rmOnline,
  rmOffline
}

Public Property QBRequestMode As TimetrackingQBRequestModes

Enum TimetrackingQBRequestModes
  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 (TimeTracking 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 (TimeTracking 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.

RefId Property (TimeTracking Component)

An alphanumerical identifier generated by the server.

Syntax

• C#
• VB.NET

public string RefId { get; }

Public ReadOnly Property RefId As String

Default Value

""

Remarks

An Id is an alphanumerical identifier assigned by the server whenever an object is added to QuickBooks. It is guaranteed to be unique across all objects of the same type.

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

ServiceItemId Property (TimeTracking Component)

Reference to the type of work being performed.

Syntax

• C#
• VB.NET

public string ServiceItemId { get; set; }

Public Property ServiceItemId As String

Default Value

""

Remarks

The type of work being performed.

If a Customer is not specified, ServiceItem is not needed. If BillableStatus is set to bsBillable, then both ServiceItem and Customer are required.

Id/Name Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its Id (this property) or its full Name, for which a corresponding property is defined.

Using the Id is recommended when feasible, as the Id is guaranteed to never change once defined.

Setting the value of this property will set the corresponding Name property to an empty string.

ServiceItemName Property (TimeTracking Component)

Reference to the type of work being performed.

Syntax

• C#
• VB.NET

public string ServiceItemName { get; set; }

Public Property ServiceItemName As String

Default Value

""

Remarks

The type of work being performed.

If a Customer is not specified, ServiceItem is not needed. If BillableStatus is set to bsBillable, then both ServiceItem and Customer are required.

Name/Id Reference Properties

This property is used to reference an object that is already done within QuickBooks. This may be done with its full Name (this property) or its Id, for which a corresponding property is defined. If Name is used, it must contain the full name of the object referred to, as generated by QuickBooks. For hierarchically defined objects, such as Customers, this includes the names of parent objects, and the full name can be determined by reading the FullName special field.

Setting the value of this property will set the corresponding Id property to an empty string.

TransactionDate Property (TimeTracking Component)

Date of transaction.

Syntax

• C#
• VB.NET

public string TransactionDate { get; set; }

Public Property TransactionDate As String

Default Value

""

Remarks

The date of the transaction.

The standard formatting for dates is YYYY-MM-DD; i.e., September 2, 2002 is formatted as 2002-09-02. When getting the value of a date property, the date will always be in this format.

When setting the value of a date property, the formats MM-DD-YY, MM-DD-YYYY, MM/DD/YY, and MM/DD/YYYY are also acceptable. Dates in these formats will be automatically parsed and stored in YYYY-MM-DD format.

This property is required in Accounts Payable (Bill and VendorCredit) transactions. In other kinds of transactions this property is optional.

Add Method (TimeTracking Component)

Adds the record into QuickBooks.

Syntax

• C#
• VB.NET

public void Add();

Public Sub Add()

Remarks

Add is used to add the object to QuickBooks.

If QuickBooks is able to add the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

For example, read-only properties such as RefIds will be assigned. In transaction objects, line item information will be filled out, and ItemGroups will be broken up into their respective Items. Also, a total will be calculated.

If QuickBooks is not able to add the object, a trappable error will occur.

CheckRequestStatus Method (TimeTracking Component)

Checks whether or not the specified request was processed by QuickBooks.

Syntax

• C#
• VB.NET

public string CheckRequestStatus(string requestId);

Public Function CheckRequestStatus(ByVal RequestId As String) As String

Remarks

This method allows the user to determine whether a previous request was successfully processed by QuickBooks. Ordinarily QuickBooks either processes requests successfully or returns an error, but in the event of a power outage or other system failure, QuickBooks might or might not have time to process a request before issuing a response.

QuickBooks stores internally a list of QBRequestIds for which it has processed a request, and updated its internal state accordingly. Use of this method allows the user to query the list for any RequestId whose value is known.

The method returns a string corresponding to the result of the query. If the request was processed successfully, an empty string ("") will be returned. If the request was not processed, the string "Request not processed." will be returned. If the request was processed but an error occurred, a string containing the error code and a description will be returned; for example, "801: A QuickBooks internal error has occurred."

See QBRequestId for more information on error recovery.

CloseQBConnection Method (TimeTracking Component)

Closes a persistent connection to QuickBooks.

Syntax

• C#
• VB.NET

public void CloseQBConnection();

Public Sub CloseQBConnection()

Remarks

Invoking CloseQBConnection closes the QuickBooks connection specified in QBConnectionString. After the connection has been closed, the component will revert to its default behavior, and a new connection will be established for each request until QBConnectionString is invoked again.

In case the connection is already closed invoking CloseQBConnection will have no effect. Moreover, if multiple connections are open CloseQBConnection will only close the connection specified in QBConnectionString.

Be sure to always invoke this method after calling OpenQBConnection.

Config Method (TimeTracking 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.

Delete Method (TimeTracking Component)

Deletes the record from QuickBooks.

Syntax

• C#
• VB.NET

public void Delete();

Public Sub Delete()

Remarks

Delete causes the object to be deleted in QuickBooks. After this method is called, the values of all fields will be reset to their defaults.

The object deleted in QuickBooks is the one specified by RefId. This read-only property may be assigned either by calling Get or by assigning the value of QBResponseAggregate.

A typical example: Customer.GetByName("John Smith") 'this will assign the RefId Customer.Delete() Deleting entity objects (Customer, Employee, and Vendor) requires that QuickBooks be open in single-user mode. Transaction objects, however, may be deleted while QuickBooks is in any mode.

Use this method with caution, as there is no way to recover deleted objects.

Get Method (TimeTracking Component)

Gets a single record from QuickBooks.

Syntax

• C#
• VB.NET

public void Get(string id);

Public Sub Get(ByVal Id As String)

Remarks

Get may be used to retrieve a single object from QuickBooks, based on its RefId. When the method is called, a search will be initiated for the requested object. If it is found, all properties of the component will be set to the information retrieved from QuickBooks. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

The RefId of any component, or the Id of any reference property, may be used for the parameter. So for example, the following pseudocode would get customer information for a Customer listed on an Invoice:

Customer.Get( Invoice.CustomerId )

The GetByName method, present only in entity objects (Customer, Vendor, and Employee) and QBObject, may be used to get an object based on its Name. To retrieve multiple objects, to retrieve transaction objects whose RefId is not known, or to perform more advanced searches the ObjSearch component may be used.

GetCustomField Method (TimeTracking Component)

Gets a custom field value from QuickBooks.

Syntax

• C#
• VB.NET

public string GetCustomField(string fieldName);

Public Function GetCustomField(ByVal FieldName As String) As String

Remarks

This method will get the value of a custom field, which has been defined by the user from within the QuickBooks UI.

To read the values of custom fields, be sure to set QBXMLVersion to at least "2.0" when retrieving data from QuickBooks. Then, QuickBooks will return custom field information, and it will be accessible through this method.

You may also invoke Config to read the value of custom fields. However, to set the value of custom fields you must set QBXMLVersion to at least "3.0" and invoke SetCustomField.

ImportQBXML Method (TimeTracking Component)

Imports a QBXML response aggregate.

Syntax

• C#
• VB.NET

public void ImportQBXML(string XMLData);

Public Sub ImportQBXML(ByVal XMLData As String)

Remarks

This method imports a QBXML response aggregate. When called with 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.

OpenQBConnection Method (TimeTracking Component)

Opens a persistent connection to QuickBooks.

Syntax

• C#
• VB.NET

public void OpenQBConnection();

Public Sub OpenQBConnection()

Remarks

Invoking OpenQBConnection will open a persistent connection to QuickBooks. After invoking OpenQBConnection, all requests such as Get, Add, etc. will use the established connection until CloseQBConnection is invoked.

The effect of OpenQBConnection is to increase performance. If OpenQBConnection is not invoked, a connection to QuickBooks will automatically be created and destroyed each time the component communicates with QuickBooks. Using OpenQBConnection will be faster, particularly in the case of automatic login.

After OpenQBConnection is invoked, QuickBooks will issue a connection ticket, and it will be stored in QBConnectionString. When CloseQBConnection is invoked the ticket will be invalidated, and any further attempts to use it will fail.

Be sure to invoke CloseQBConnection when you have finished communicating with QuickBooks. Leaving an open QuickBooks connection may lock out other integrated applications, affect QuickBooks performance, or cause other problems.

Reset Method (TimeTracking Component)

Resets all properties to their defaults.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

This method resets the values of all properties (and all special fields) to their defaults.

After calling this method, the component may be reused as if it were newly created.

SetCustomField Method (TimeTracking Component)

Sets a custom field value within QuickBooks.

Syntax

• C#
• VB.NET

public void SetCustomField(string fieldName, string fieldValue);

Public Sub SetCustomField(ByVal FieldName As String, ByVal FieldValue As String)

Remarks

This method requires QuickBooks 2004 or above, with QBXMLVersion set to at least "3.0".

This method will immediately set the value of a QuickBooks custom field, which has been defined by the user from within the QuickBooks UI. Before calling this method, the preceding operation must retrieve the object from QuickBooks, using Get, ObjSearch, etc. Then, you may use SetCustomField to set custom field values (the fields will be modified or added, as appropriate).

Note that invoking this method will create a connection to QuickBooks if one is not already in place.

Update Method (TimeTracking Component)

Updates the sales order in QuickBooks.

Syntax

• C#
• VB.NET

public void Update();

Public Sub Update()

Remarks

This method will update the sales order in QuickBooks.

When the method is called, an Update request will be submitted to QuickBooks. The sales order will have its information updated based on the various property values.

If QuickBooks is able to update the object, it will return a copy of the object, and the values of all properties will be reset from the QuickBooks response. The QBResponseAggregate property will also be set to the entire QBXML aggregate received from QuickBooks.

QBXMLVersion must be set to "3.0" or greater to update a sales order. Moreover, QBXMLVersion should be set to the same value when retrieving the sales order from QuickBooks (either through ObjSearch or through the Get method).

Error Event (TimeTracking Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class TimetrackingErrorEventArgs 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 (TimeTracking 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, TimetrackingSSLServerAuthenticationEventArgs e);

public class TimetrackingSSLServerAuthenticationEventArgs : 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 TimetrackingSSLServerAuthenticationEventArgs)

Public Class TimetrackingSSLServerAuthenticationEventArgs 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 (TimeTracking Component)

Shows the progress of the secure connection.

Syntax

• C#
• VB.NET

public event OnSSLStatusHandler OnSSLStatus;

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

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

Public Event OnSSLStatus As OnSSLStatusHandler

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

Public Class TimetrackingSSLStatusEventArgs 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 (TimeTracking Component)

Shows the progress of the QuickBooks connection.

Syntax

• C#
• VB.NET

public event OnStatusHandler OnStatus;

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

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

Public Event OnStatus As OnStatusHandler

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

Public Class TimetrackingStatusEventArgs 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 (TimeTracking Component)

Fired when a warning occurs.

Syntax

• C#
• VB.NET

public event OnWarningHandler OnWarning;

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

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

Public Event OnWarning As OnWarningHandler

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

Public Class TimetrackingWarningEventArgs 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.

Config Settings (TimeTracking Component)

TimeTracking Config Settings

Base Config Settings

Trappable Errors (TimeTracking 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.

TimeTracking 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.