Retrieves the specified balance of all absence plan and leave of absence types.

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 cmdlet 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.

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	Supported for: SELECT. A JSON aggregate. Returns the Absence Table for the Absence Balance.
AbsencePlan_Descriptor	String	Supported for: SELECT. Descriptor for Absence Container based on Calendar Display Option
AbsencePlan_Id	String	Supported for: SELECT. ID for Absence Container.
AbsencePlan_Timeoffs	String	Supported for: SELECT. The Time Off name for which the balance is returned.
Category_Descriptor	String	Supported for: SELECT. A description of the instance
Category_Href	String	Supported for: SELECT. A link to the instance
Category_Id	String	Supported for: SELECT. wid / id / reference id
DateOfFirstAbsence	Datetime	Supported for: SELECT. The first day of leave for the corresponding leave type for which the balance is returned.
EffectiveDate	Datetime	Supported for: SELECT. The date for which the balance is returned.
Position_Descriptor	String	Supported for: SELECT. A preview of the instance
Position_Id	String	Supported for: SELECT. Id of the instance
Quantity	Decimal	Supported for: SELECT. The balance for the time off, absence table or leave type.
Unit_Descriptor	String	Supported for: SELECT. A description of the instance
Unit_Href	String	Supported for: SELECT. A link to the instance
Unit_Id	String	Supported for: SELECT. wid / id / reference id
Worker_Descriptor	String	Supported for: SELECT. A description of the instance
Worker_Href	String	Supported for: SELECT. A link to the instance
Worker_Id	String	Supported for: SELECT. wid / id / reference id
Category_Prompt	String	The Workday ID of the Time Off, Leave Type, or Absence Table.
Effective_Prompt	Date	Absence balances as of the specified date using the yyyy-mm-dd format.
Worker_Prompt	String	The Workday ID of the worker for which balances are returned.