TimeTracking Component
Properties Methods Events Configuration Settings Errors
The TimeTracking component is used to track employees' time.
Syntax
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.
BillableStatus | Line item property: Billing status of this item. |
CustomerId | A reference to the customer or customer job. |
CustomerName | A reference to the customer or customer job. |
Duration | The duration of time. |
EmployeeId | Reference to employee or subcontractor whose time is being tracked. |
EmployeeName | Reference to employee or subcontractor whose time is being tracked. |
Notes | Notes about this transaction. |
PayrollWageItemId | A payment scheme, such as 'Regular Pay'. |
PayrollWageItemName | A payment scheme, such as 'Regular Pay'. |
QBConnectionString | An aggregate consisting of various QuickBooks connection properties. |
QBRequestAggregate | The request aggregate. |
QBRequestId | The Id of the next message to be sent to QuickBooks. |
QBRequestMode | Defines whether the request is made online or stored offline. |
QBResponseAggregate | The last QBXML response aggregate received from QuickBooks. |
QBXMLVersion | The version of QBXML used in the outgoing message. |
RefId | An alphanumerical identifier generated by the server. |
ServiceItemId | Reference to the type of work being performed. |
ServiceItemName | Reference to the type of work being performed. |
TransactionDate | Date of transaction. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
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 configuration setting. |
Delete | Deletes the record from QuickBooks. |
Get | Gets a single record from QuickBooks. |
GetCustomField | Gets a custom field value from QuickBooks. |
ImportQBXML | Imports a QBXML response aggregate. |
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 sales order in QuickBooks. |
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.
Error | Information about errors during data delivery. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
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 further details.
AppendAfter | Appends an XML tag after the specified QBXML element. |
AuthFlags | Connection Flags (use for QuickBooks Simple Start). |
ClassId | Id of the transaction class to which this transaction belongs. |
ClassName | Name of the transaction class to which this transaction belongs. |
EditSequence | An identifier for this copy of the object. |
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. |
TimeCreated | The time the object was created. |
TimeModified | The time the object was created. |
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. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseDaemonThreads | Whether threads created by the component are daemon threads. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |