EmployeeTimeOff Type

Describes how time off (either sick or vacation) is accrued for an employee.

Remarks

This type is used by the Employee component.

Fields

Indicates how an employee accrues time off. If sending time off hours data in an Update request, AccrualPeriod is a required field, and cannot be set to stNone. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences.

Valid values:


stNone (0)	No value set.
stBeginningOfYear (1)	Time off is added at the beginning of each year.
stEveryHourOnPaycheck (2)	Time off is calculated by the employee's working hours.
stEveryPaycheck (3)	Time off is accumulated for every paycheck.

AccrualStartDate
String

Indicates the start date from which an employee accrues time off. This field requires QBXMLVersion to be set to "5.0" or greater.

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.

Accrued
String

The time off that the employee will accrue per AccrualPeriod. The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences

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.

Available
String

The total time off currently available for the employee to use. If this value is empty it will default to 0.

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.

MaximumTime
String

The maximum time off that the employee can accrue. (QuickBooks itself does not enforce this limit, however. Available time can be greater than MaximumTime.) The default value is whatever the QuickBooks user has set in the QuickBooks Employee Preferences.

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.

ResetsEachYear
Boolean

Indicates whether or not the accrued time off resets to zero at the beginning of the new year.

Used
String

The time off that the employee has used in the current AccrualPeriod. This field requires QBXMLVersion to be set to "5.0" or greater.

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.

Constructors

[VB.NET]
Public EmployeeTimeOff()

[C#]
public EmployeeTimeOff();