4D Accounting SDK 2020 .NET Edition

Questions / Feedback?

TimeTracking Component

Properties   Methods   Events   Configuration Settings   Errors  

The TimeTracking component is used to track employees' time.

Syntax

DPayments.DAccountingSDK.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.

BillableStatusLine item property: Billing status of this item.
CustomerIdA reference to the customer or customer job.
CustomerNameA reference to the customer or customer job.
DurationThe duration of time.
EmployeeIdReference to employee or subcontractor whose time is being tracked.
EmployeeNameReference to employee or subcontractor whose time is being tracked.
NotesNotes about this transaction.
PayrollWageItemIdA payment scheme, such as 'Regular Pay'.
PayrollWageItemNameA payment scheme, such as 'Regular Pay'.
QBConnectionStringAn aggregate consisting of various QuickBooks connection properties.
QBRequestAggregateThe request aggregate.
QBRequestIdThe Id of the next message to be sent to QuickBooks.
QBRequestModeDefines whether the request is made online or stored offline.
QBResponseAggregateThe last QBXML response aggregate received from QuickBooks.
QBXMLVersionThe version of QBXML used in the outgoing message.
RefIdAn alphanumerical identifier generated by the server.
ServiceItemIdReference to the type of work being performed.
ServiceItemNameReference to the type of work being performed.
TransactionDateDate 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.

AddAdds the record into QuickBooks.
CheckRequestStatusChecks whether or not the specified request was processed by QuickBooks.
CloseQBConnectionCloses a persistent connection to QuickBooks.
ConfigSets or retrieves a configuration setting.
DeleteDeletes the record from QuickBooks.
GetGets a single record from QuickBooks.
GetCustomFieldGets a custom field value from QuickBooks.
ImportQBXMLImports a QBXML response aggregate.
OpenQBConnectionOpens a persistent connection to QuickBooks.
ResetResets all properties to their defaults.
SetCustomFieldSets a custom field value within QuickBooks.
UpdateUpdates 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.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the QuickBooks connection.
WarningFired 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.

AppendAfterAppends an XML tag after the specified QBXML element.
AuthFlagsConnection Flags (use for QuickBooks Simple Start).
ClassIdId of the transaction class to which this transaction belongs.
ClassNameName of the transaction class to which this transaction belongs.
EditSequenceAn identifier for this copy of the object.
EnforceMaxLengthIndicates whether to enforce max lengths for QB Fields.
GetHighestVersionHighest QBXMLVersion supported by the installed instance of QuickBooks.
GetRequestProcessorDLLVersionReturns the version of the QB Request Processor that is installed on your system.
GetSupportedVersionsReturns a list of QBXMLVersions that are supported by QuickBooks.
IsReadOnlyThis causes the QuickBooks authorization dialog to display text informing the user that its access will be read-only.
PersonalDataPrefWhether the connecting application will require access to personal data such as SSN or credit card information.
QBConnectionModeThe mode of connection to QuickBooks.
QBFileStatusThe status of the company file as it pertains to accepting connections.
QBOpenCompanyFileThe file currently open in QuickBooks.
SendRawXMLSends specified XML to quickbooks without modification.
SSLAcceptServerCertThe SSL certificate being used by the Remote Connector.
SSLAcceptServerCertFileThe SSL certificate file being used by the Remote Connector.
StopOnErrorSpecifies how QuickBooks is to proceed if an error occurs in processing of the current request.
TimeCreatedThe time the object was created.
TimeModifiedThe time the object was created.
UnattendedModePrefWhether connecting while QuickBooks is closed is required or optional for the user.
WarningCodesA comma-separated list of QuickBooks warning codes that should not result in an exception.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2021 4D Payments Inc. - All rights reserved.
4D Accounting SDK 2020 .NET Edition - Version 20.0 [Build 7887]