ResourceTimeOffBalances
This entity describes the remaining time off a resource has accrued or has been allotted, according to their assigned Time Off Policy. You will be able to query the entity by resourceId or a combination of resourceId and year.
NOTE You can refer to the Online Help to find root and child access URLs of the entity you wish to query. Refer to Finding resource and child access URLs of REST API entities for more information.
Entity details
| Entity Name: | ResourceTimeOffBalances |
|
Entity Path: |
/atservicesrest/v1.0/ResourceTimeOffBalances |
|
Parent Entity: |
|
| Can Create: | |
| Can Update: | |
| Can Query: |
|
| Can Delete: | |
| Can Have UDFs: |
IMPORTANT Requests to this entity require special handling. Refer to the Entity URLs and relationships section of this article for details.
Entity URLs and relationshipsField definitions
| Field Name | Datatype | Read-Only | Is Required | Reference Name | Picklist |
|---|---|---|---|---|---|
| floatingHolidayAnnualAllowance | Decimal |
|
|||
| floatingHolidayBalance | Decimal |
|
|||
| floatingHolidayPlanned | Decimal |
|
|||
| floatingHolidayUsed | Decimal |
|
|||
| floatingHolidayApproval | Decimal |
|
|||
| ID | Long |
|
|
||
| personalTimeAnnualAllowance | Decimal |
|
|||
| personalTimeBalance | Decimal |
|
|||
| personalTimePlanned | Decimal |
|
|||
| personalTimeUsed | Decimal |
|
|||
| personalTimeWaitingApproval | Decimal |
|
|||
| resourceID | Integer |
|
Resources | ||
| sickTimeAnnualAllowance | Decimal |
|
|||
| sickTimeBalance | Decimal |
|
|||
| sickTimePlanned | Decimal |
|
|||
| sickTimeUsed | Decimal |
|
|||
| sickTimeWaitingApproval | Decimal |
|
|||
| vacationAnnualAllowance | Decimal |
|
|||
| vacationBalance | Decimal |
|
|||
| vacationPlanned | Decimal |
|
|||
|
vacationUsed |
Decimal |
|
|
|
|
|
vacationWaitingApproval |
Decimal |
|
|
|
|
|
Year |
Integer |
|
|
|
|
If the time off policy type for sick/personal/vacation/floating holiday for the year is Accrual, then the annual allowance fields will return just the annual hours value, otherwise the field will return the sum of the annual hours + additional + rollover hours.
