Service Directory > v31.2 > Absence_Management > Get_Override_Balances
 

Operation: Get_Override_Balances

This operation sets Time Off Plan Override Balances for an Employee and Time Off Plan with the supplied information.


@ - A parameter name with this symbol denotes an XML attribute within the document instead of an XML element.


Contents

 

Web Service

 

Request

 

Response

 

Element(s)

 

Request Element: Get_Override_Balances_Request

Get Time Off Plan Override Balances Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Override_Balance_Request_References  [0..1]  Time Off Plan Balance Override Request References   
Request_Criteria [Choice]   Override_Balance_Request_Criteria  [0..1]  Time Off Plan Balance Override Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Override_Balance_Response_Group  [0..1]  Time Off Plan Balance Override Response Group   
top
 

Response Element: Get_Override_Balances_Response

Get Time Off Plan Override Balances Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Override_Balance_Request_References  [0..1]  Import Process Request References   
Request_Criteria  Override_Balance_Request_Criteria  [0..1]  Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Groups  Override_Balance_Response_Group  [0..1]  Response Groups   
Response_Results  Response_Results  [0..1]  The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.   
Response_Data  Override_Balance_Response_Data  [0..1]  Time Off Plan Override Balance Response Data   
top
 

Override_Balance_Request_References

part of: Get_Override_Balances_Request, Get_Override_Balances_Response
Time Off Plan Override Balance Request References
 
Parameter name Type/Value Cardinality Description Validations
Override_Balance_Reference  Time_Off_Plan_BalanceObject  [1..*]  Time Off Plan Balance Override Request References   
top
 

Time_Off_Plan_BalanceObject

part of: Override_Balance_Request_References, Override_Balance
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Time_Off_Plan_BalanceObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Time_Off_Plan_BalanceObjectID

part of: Time_Off_Plan_BalanceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Calculated_and_Override_Balance_Index  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Override_Balance_Request_Criteria

part of: Get_Override_Balances_Request, Get_Override_Balances_Response
Time Off Plan Override Balance Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [0..1]  Employee Reference   
Batch_Reference  Application_BatchObject  [0..1]  Batch Reference   
top
 

WorkerObject

part of: Override_Balance_Request_Criteria, Override_Balance_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  WorkerObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

WorkerObjectID

part of: WorkerObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Contingent_Worker_ID, Employee_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Application_BatchObject

part of: Override_Balance_Request_Criteria
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Application_BatchObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Application_BatchObjectID

part of: Application_BatchObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Batch_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Response_Filter

part of: Get_Override_Balances_Request, Get_Override_Balances_Response
Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes.
 
Parameter name Type/Value Cardinality Description Validations
As_Of_Effective_Date  date  [0..1]  Indicates the date when application data, such as benefits and compensation, are deemed effective in the Workday system. (Also referred to as the "Effective Moment".) If not specified, this date defaults to TODAY.   
As_Of_Entry_DateTime  dateTime  [0..1]  Indicates the date and time that data was entered into the system. (This field is also referred to as the "Entry Moment".) If not specified, defaults to the CURRENT DATE/TIME.   
Page  decimal (12, 0) >0   [0..1]  Indicates the page of data to return in the response, and defaults to the first page (Page = 1). For responses that contain more than one page of data, use this parameter to retrieve the additional pages of data. For example, set Page = 2 to retrieve the second page of data. Note: If you set the page parameter, you must also specify the "As_Of_Entry_Date" to ensure that the result set remains the same between your requests.   
Count  decimal (3, 0) >0   [0..1]  Sets the number of objects to return within each response page (Min = 1, Max = 999, Default = 100 if not set). Any values you set must be between 1-999.   
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
top
 

Override_Balance_Response_Group

part of: Get_Override_Balances_Request, Get_Override_Balances_Response
Time Off Plan Override Balance Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
Include_Override_Balance_Data  boolean  [0..1]  Include Time Off Plan Balance Override Data   
top
 

Response_Results

part of: Get_Override_Balances_Response
The "Response_Results" element contains summary information about the data that has been returned from your request including "Total_Results", "Total_Pages", and the current "Page" returned.
 
Parameter name Type/Value Cardinality Description Validations
Total_Results  decimal (12, 0) >0   [0..1]  The total number of results that have been returned from your request.   
Total_Pages  decimal (12, 0) >0   [0..1]  The total number of pages that exist for your request. A page of data in WWS contains a maximum of 100 entries. So, if you have exactly 1,000 employees returned in a request, then you will have 10 pages of data that will need to be retrieved to build your complete dataset. Each page contains a maximum of 100 entries.   
Page_Results  decimal (12, 0) >0   [0..1]  Number of Results in current page.   
Page  decimal (12, 0) >0   [0..1]  The page of data that has been returned for the given request.   
top
 

Override_Balance_Response_Data

part of: Get_Override_Balances_Response
Time Off Plan Override Balance Response Data
 
Parameter name Type/Value Cardinality Description Validations
Override_Balance  Override_Balance  [0..*]  Time Off Plan Balance Override   
top
 

Override_Balance

part of: Override_Balance_Response_Data
Time Off Plan Override Balance
 
Parameter name Type/Value Cardinality Description Validations
Override_Balance_Reference  Time_Off_Plan_BalanceObject  [0..1]  Time Off Plan Balance Override Reference   
Override_Balance_Data  Override_Balance_Data  [0..1]  Time Off Plan Balance Override Data 
Validation Description
Override Balances cannot be loaded for a Time Off Plan for which Track Balance is False.   
Worker is not eligible for the Time Off Plan for the period that includes the override balance date.   
Batch ID is already associated with other types of Application Batches.   
Override Balance needs exactly [count] carryover components.   
Override Balance Date must be the period start date of a period or sub period for the period schedule or a carryover expiration date associated with the Time Off Plan for the override balance.   
You cannot make changes to this input as it affects a completed termination adjustment.  You cannot make changes to this input as it affects a completed termination adjustment. 
Override Balances cannot be loaded for a Time Off Plan for which Overrides Allowed is False on the corresponding snapshot.   
 
top
 

Override_Balance_Data

part of: Override_Balance
Time Off Plan Override Balance Data
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Reference ID   
Batch_ID  string  [0..1]  Batch ID   
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Position_Reference  Position_ElementObject  [0..1]  Position Reference 
Validation Description
Position is not valid for this Worker as of the effective date. Worker: [worker] Position: [position] Date: [date]   
The field Position Reference is required and must have a value.   
Position Reference is not valid for the Time Off Plan Reference given.   
 
Time_Off_Plan_Reference  Absence_Plan_Reference  [1..1]  Absence Plan Reference   
Override_Balance_Date  date  [1..1]  Override Balance Date   
Override_Balance_Units  decimal (18, 6)   [0..1]  Override Balance Units   
Override_Balance_Units_Data  Carryover_Override_Balance_Units_Data  [0..*]  Override Balance Units 
Validation Description
Carryover Units must be 0 or greater.   
Carryover Expiration Date for [worker] with an Override Balance Date of [override date] must be a valid date ([list of valid dates]) that the Carryover Balance expires for [plan].   
Carryover Expiration Dates for [worker] must be unique for [plan] for the Override Balance Date of [override balance date].   
 
Comments  string  [0..1]  Comments   
Validation Description
Override Balances cannot be loaded for a Time Off Plan for which Track Balance is False.   
Worker is not eligible for the Time Off Plan for the period that includes the override balance date.   
Batch ID is already associated with other types of Application Batches.   
Override Balance needs exactly [count] carryover components.   
Override Balance Date must be the period start date of a period or sub period for the period schedule or a carryover expiration date associated with the Time Off Plan for the override balance.   
You cannot make changes to this input as it affects a completed termination adjustment.  You cannot make changes to this input as it affects a completed termination adjustment. 
Override Balances cannot be loaded for a Time Off Plan for which Overrides Allowed is False on the corresponding snapshot.   
top
 

Position_ElementObject

part of: Override_Balance_Data
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]  Display information used to describe an instance of an object. This 'optional' information is for outbound descriptive purposes only and is not processed on inbound Workday Web Services requests.   
ID  Position_ElementObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Position_ElementObjectID

part of: Position_ElementObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Position_ID  [1..1]  The unique identifier type. Each "ID" for an instance of an object contains a type and a value. A single instance of an object can have multiple "ID" but only a single "ID" per "type".   
top
 

Absence_Plan_Reference

part of: Override_Balance_Data
Absence Plan Reference
 
Parameter name Type/Value Cardinality Description Validations
Time_Off_Plan_Name  string  [1..1]  Time Off Plan Name 
Validation Description
Absence Plan does not exist.   
 
top
 

Carryover_Override_Balance_Units_Data

part of: Override_Balance_Data
Override Balance Units Data
 
Parameter name Type/Value Cardinality Description Validations
Carryover_Expiration_Date  date  [0..1]  Carryover Expiration Date   
Carryover_Override_Balance_Units  decimal (18, 6)   [0..1]  Carryover Override Balance Units   
Validation Description
Carryover Units must be 0 or greater.   
Carryover Expiration Date for [worker] with an Override Balance Date of [override date] must be a valid date ([list of valid dates]) that the Carryover Balance expires for [plan].   
Carryover Expiration Dates for [worker] must be unique for [plan] for the Override Balance Date of [override balance date].   
top
 

Time_Off_Plan_BalanceReferenceEnumeration

part of: Time_Off_Plan_BalanceObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Application_BatchReferenceEnumeration

part of: Application_BatchObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top