Stores balance information for all absence-plan and leave-of-absence types. This table enables tracking of employee entitlements, accruals, and remaining leave balances for payroll processing and compliance with leave policies.

Workday Resource Information

Retrieves the specified balance of all absence plan and leave of absence types for the specified balance ID. You can use a returned id from GET /balances.

Secured by: Self-Service: Leave of Absence Entitlements, Self-Service: Time Off Balances, Worker Data: Leave of Absence, Worker Data: Time Off (Time Off Balances Manager View), Worker Data: Time Off (Time Off Balances)

Scope: Time Off and Leave

Aggregate Fields

The driver represents the following fields as aggregates containing JSON text. Each of them conforms to their respective schema. Fields marked with an asterisk are required and must be included if their parent object is. Fields marked with a hyphen are read-only and must not be included when calling stored procedures or when performing an INSERT or UPDATE.

This information is derived from the Workday REST API specification which does not explicitly list all business rules and validations that apply to each object. More fields may be required than what is listed here.

AbsencePlan_AbsenceTable_Aggregate

[{
  descriptor: Text /* A preview of the instance */
  id: Text /* Id of the instance */
}]

Columns

Name	Type	Description
AbsencePlan_AbsenceTable_Aggregate	String	This field returns the absence table associated with the absence balance. The absence table provides detailed records of time off accruals, usage, and remaining balances.
AbsencePlan_Descriptor	String	This field provides a human-readable summary of the absence container based on the calendar display option. This descriptor ensures clarity in understanding the specific absence plan being referenced.
AbsencePlan_Id	String	This field contains the unique identifier (Id) for the absence container. The Id ensures that each absence plan is properly linked to a worker's leave or time-off records.
AbsencePlan_Timeoffs	String	This field returns the name of the time off category for which the balance is being reported. The time-off category defines the type of leave, such as vacation, sick leave, or parental leave.
Category_Descriptor	String	This field provides a human-readable summary of the absence category instance. The category descriptor helps classify absence balances based on specific leave types.
Category_Href	String	This field contains a direct link to the absence category instance. The link provides programmatic access to retrieve additional details about the category.
Category_Id	String	This field contains the unique Id for the absence category. The Id ensures accurate classification and grouping of absence balances within the system.
DateOfFirstAbsence	Datetime	This field records the first day of leave for the corresponding leave type for which the balance is being returned. The date helps track the start of an employee's time off period.
EffectiveDate	Datetime	This field specifies the date for which the absence balance is reported. The effective date ensures that the balance is accurate based on a specific point in time.
Position_Descriptor	String	This field provides a human-readable summary of the position associated with the absence balance. The descriptor helps identify which position the absence applies to, especially for workers with multiple roles.
Position_Id	String	This field contains the unique Id for the position associated with the absence balance. The Id ensures that absence balances are accurately linked to a worker's job position.
Quantity	Decimal	This field represents the balance amount for the time off, absence table, or leave type. The balance value specifies the remaining leave entitlement or accrued time available.
Unit_Descriptor	String	This field provides a human-readable summary of the unit used for tracking the absence balance. The unit descriptor helps clarify whether the balance is measured in hours, days, or another metric.
Unit_Href	String	This field contains a direct link to the unit instance associated with the absence balance. The link provides programmatic access to retrieve additional details about the unit of measure (UOM).
Unit_Id	String	This field contains the unique Id for the UOM. The Id ensures that the balance is accurately categorized based on the applicable unit type.
Worker_Descriptor	String	This field provides a human-readable summary of the worker associated with the absence balance. The descriptor helps identify the individual for whom the balance is being reported.
Worker_Href	String	This field contains a direct link to the worker instance. The link provides programmatic access to retrieve additional details about the worker's absence records.
Worker_Id	String	This field contains the unique Id for the worker associated with the absence balance. The Id ensures that absence balances are correctly attributed to the appropriate employee.
Category_Prompt	String	This field specifies the Workday Id of the time off, leave type, or absence table. The Id allows retrieval of absence balances for a specific leave category.
Effective_Prompt	Date	This field specifies the absence balance as of a given date using the YYYY-MM-DD format. The date filter allows users to view balance history and future entitlements.
Worker_Prompt	String	This field specifies the Workday Id of the worker for whom the balances are being returned. The Id ensures that absence balance information is retrieved for the correct employee.