Service Directory > v32.1 > Absence_Management > Put_Override_Balance
 

Operation: Put_Override_Balance

This operation will add or update a new Time Off Plan Override Balance record for a given Employee and Time Off Plan.


@ - 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: Put_Override_Balance_Request

Put Override Balance Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Override_Balance_Reference  Time_Off_Plan_BalanceObject  [0..1]  Override Balance Reference   
Override_Balance_Data  Override_Balance_Data  [1..1]  Override Balance 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
 

Response Element: Put_Override_Balance_Response

Put Override Balance Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Override_Balance_Reference  Time_Off_Plan_BalanceObject  [0..1]  Time Off Plan Override Balance Reference   
top
 

Time_Off_Plan_BalanceObject

part of: Put_Override_Balance_Request, Put_Override_Balance_Response
 
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_Data

part of: Put_Override_Balance_Request
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
 

WorkerObject

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

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
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top