Service Directory > v31.2 > Performance_Management > Put_Goal_Payout_Band
 

Operation: Put_Goal_Payout_Band

Creates a new ~Goal~ Payout Band (or updates an existing ~Goal~ Payout Band) with the information supplied in the request.


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

Web Service element for Put Goal Payout Band Request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only boolean that signifies that the Goal Payout Band will be added.   
Goal_Payout_Band_Reference  Goal_Payout_BandObject  [0..1]  Goal Payout Band reference to be added or updated.   
Goal_Payout_Band_Data  Goal_Payout_Band_Data  [1..1]  Element container for Goal Payout Band Data.   
Validation Description
The web service is set to add only, but the Goal Payout Band already exists.   
top
 

Response Element: Put_Goal_Payout_Band_Response

Web service element that returns the Goal Payout Band Reference after a put request is sent.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Goal_Payout_Band_Reference  Goal_Payout_BandObject  [0..1]  Reference to the Goal Payout Band that was added or updated.   
top
 

Goal_Payout_BandObject

part of: Put_Goal_Payout_Band_Request, Put_Goal_Payout_Band_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  Goal_Payout_BandObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Goal_Payout_BandObjectID

part of: Goal_Payout_BandObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Goal_Payout_Band_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
 

Goal_Payout_Band_Data

part of: Put_Goal_Payout_Band_Request
Element which contains all the components that define a Goal Payout Band.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  The ID of a Goal Payout Band.   
Goal_Payout_Band_Name  string  [0..1]  The Name for a Goal Payout Band. 
Validation Description
You cannot create a Goal Payout Band with the same name as another Goal Payout Band.   
The field Payout Band is required and must have a value.   
 
Calculation_Reference  CalculationObject  [1..1]  The Calculation Type used by the Goal Payout Band. 
Validation Description
You cannot edit or delete a Goal Payout Band if it is in use.   
 
Minimum_Payout_Percent  decimal (22, 10) >0   [0..1]  The Minimum Payout Percent of the Goal Payout Band. This field may not be editable depending on the Calculation Type selected. 
Validation Description
Minimum must be less than or equal to target, and target must be less than or equal to maximum.   
The Maximum must be greater than the Minimum.   
You may not load a Goal Payout Band with a Minimum Percent, Target Percent or Maximum Percent if that field is not utilized by the Calculation Type of the Goal Payout Band.   
You cannot edit or delete a Goal Payout Band if it is in use.   
 
Target_Payout_Percent  decimal (22, 10) >0   [0..1]  The Target Payout Percent of the Goal Payout Band. This field may not be editable depending on the Calculation Type selected. 
Validation Description
You may not load a Goal Payout Band with a Minimum Percent, Target Percent or Maximum Percent if that field is not utilized by the Calculation Type of the Goal Payout Band.   
Minimum must be less than or equal to target, and target must be less than or equal to maximum.   
You cannot edit or delete a Goal Payout Band if it is in use.   
The Target may not be zero.   
 
Maximum_Payout_Percent  decimal (22, 10) >0   [0..1]  The Maximum Payout Percent of the Goal Payout Band. This field may not be editable depending on the Calculation Type selected. 
Validation Description
You may not load a Goal Payout Band with a Minimum Percent, Target Percent or Maximum Percent if that field is not utilized by the Calculation Type of the Goal Payout Band.   
Minimum must be less than or equal to target, and target must be less than or equal to maximum.   
The Maximum must be greater than the Minimum.   
You cannot edit or delete a Goal Payout Band if it is in use.   
 
Inactive  boolean  [0..1]  The inactive boolean for a Goal Payout Band which allows the user to determine whether or not this Goal Payout Band should be inactive.   
top
 

CalculationObject

part of: Goal_Payout_Band_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  CalculationObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

CalculationObjectID

part of: CalculationObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Balance_ID, Absence_Component_Related_Calculation_ID, Absence_Plan_ID, Accrual_Code, Aggregate_Calculation_ID, Arithmetic_Calculation_ID, Build_Date_Calculation_ID, Calculation_Compensation_Basis_ID, Compensation_Basis_ID, Compensation_Plan_ID, Conditional_Calculation_ID, Constant_Date_Calculation_ID, Constant_Value_Calculation_ID, Date_Difference_Calculation_ID, Date_Extract_Calculation_ID, Date_Increment_Decrement_Calculation_ID, Deduction_Code, Earning_Code, Instance_Set_Comparison_Calculation, Instance_Value_Calculation_ID, Logic_Calculation_ID, Lookup_Calculation_ID, Pay_Accumulation_Code, Pay_Balance_Code, Pay_Component_Group_Code, Pay_Component_Related_Calculation_Code, Related_Calculation_ID, Time_Off_Code, Value_Comparison_Calculation_ID, Workday_Absence_Balance_ID, Workday_Absence_Code, Workday_Absence_Component_Related_Calculation_ID, Workday_Absence_Plan_ID, Workday_Accrual_Code, Workday_Deduction_Code, Workday_Earning_Code, Workday_Pay_Accumulation_Code, Workday_Pay_Balance_Code, Workday_Pay_Component_Group_Code, Workday_Pay_Component_Related_Calculation_Code, Workday_Related_Calculation_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
 

Goal_Payout_BandReferenceEnumeration

part of: Goal_Payout_BandObjectID
Base Type
string
top
 

CalculationReferenceEnumeration

part of: CalculationObjectID
Base Type
string
top