Service Directory > v31.2 > Compensation_Review > Get_Deferred_Bonus_Calculation
 

Operation: Get_Deferred_Bonus_Calculation

Deferred bonus calculations.


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

Get Deferred Bonus Calculations Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Deferred_Bonus_Calculation_Request_References  [0..1]  Deferred Bonus Calculation Request References   
Request_Criteria [Choice]   Deferred_Bonus_Calculation_Request_Criteria  [0..1]  Deferred Bonus Calculation Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Deferred_Bonus_Calculation_Response_Group  [0..1]  Deferred Bonus Calculation Response Group   
top
 

Response Element: Get_Deferred_Bonus_Calculations_Response

Get Deferred Bonus Calculations Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Deferred_Bonus_Calculation_Request_References  [0..1]  Deferred Bonus Calculation Request References   
Request_Criteria  Deferred_Bonus_Calculation_Request_Criteria  [0..1]  Deferred Bonus Calculation Request Criteria   
Response_Filter  Response_Filter  [0..1]  Parameters that let you filter the data returned in the response. You can filter returned data by dates and page attributes. 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Deferred_Bonus_Calculation_Response_Group  [0..1]  Deferred Bonus Calculation Response Group   
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  Deferred_Bonus_Calculation_Response_Data  [0..1]  Deferred bonus calculations response data   
top
 

Deferred_Bonus_Calculation_Request_References

part of: Get_Deferred_Bonus_Calculations_Response, Get_Deferred_Bonus_Calculations_Request
Deferred Bonus Calculation Request References
 
Parameter name Type/Value Cardinality Description Validations
Deferred_Bonus_Calculation_Reference  Deferred_Bonus_CalculationObject  [0..*]  Get Deferred Bonus Calculations Request Reference   
top
 

Deferred_Bonus_CalculationObject

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

Deferred_Bonus_CalculationObjectID

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

Deferred_Bonus_Calculation_Request_Criteria

part of: Get_Deferred_Bonus_Calculations_Response, Get_Deferred_Bonus_Calculations_Request
Deferred Bonus Calculation Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Deferred_Bonus_Calculations_Response, Get_Deferred_Bonus_Calculations_Request
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
 

Deferred_Bonus_Calculation_Response_Group

part of: Get_Deferred_Bonus_Calculations_Response, Get_Deferred_Bonus_Calculations_Request
Deferred Bonus Calculation Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Deferred bonus calculations details   
top
 

Response_Results

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

Deferred_Bonus_Calculation_Response_Data

part of: Get_Deferred_Bonus_Calculations_Response
Deferred bonus calculations response data
 
Parameter name Type/Value Cardinality Description Validations
Deferred_Bonus_Calculation  Deferred_Bonus_Calculation_Top  [0..*]  Deferred bonus calculations   
top
 

Deferred_Bonus_Calculation_Top

part of: Deferred_Bonus_Calculation_Response_Data
Deferred bonus calculations
 
Parameter name Type/Value Cardinality Description Validations
Deferred_Bonus_Calculation_Reference  Deferred_Bonus_CalculationObject  [0..1]  Deferred Bonus Calculation Instance   
Deferred_Bonus_Calculation_Data  Deferred_Bonus_Calculation_Data  [0..*]  Deferred Bonus Calculation Data 
Validation Description
Range values cannot overlap each other.   
The minimum threshold value must set to zero if progress calculation is not set.   
 
top
 

Deferred_Bonus_Calculation_Data

part of: Deferred_Bonus_Calculation_Top
Deferred Bonus Calculation Details
 
Parameter name Type/Value Cardinality Description Validations
Calculation_Name  string  [1..1]  Deferred Bonus Calculation Name   
Reference_Field_Reference  Deferred_Bonus_Reference_FieldObject  [1..*]  Deferred Bonus Calculation Reference Fields   
Currency_Reference  CurrencyObject  [1..1]  Deferred Bonus Calculation Data Reference Currency   
Progressive_Calculation  boolean  [0..1]  Deferred Bonus Calculation Progressive Calculation Flag   
Minimum_Threshold  decimal (22, 6) >0   [0..1]  Deferred Bonus Calculation Minimum Threshold   
Deferred_Bonus_Calculation_Range_Definition  Deferred_Bonus_Calculation_Range_Definition  [1..*]  Deferred Bonus Calculation Range Definitions 
Validation Description
Deferred bonus percent value is required.   
 
Validation Description
Range values cannot overlap each other.   
The minimum threshold value must set to zero if progress calculation is not set.   
top
 

Deferred_Bonus_Reference_FieldObject

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

Deferred_Bonus_Reference_FieldObjectID

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

CurrencyObject

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

CurrencyObjectID

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

Deferred_Bonus_Calculation_Range_Definition

part of: Deferred_Bonus_Calculation_Data
Deferred Bonus Calculation Range Definition Details
 
Parameter name Type/Value Cardinality Description Validations
Range_Name  string  [1..1]  Deferred Bonus Calculation Range Name   
Deferred_Bonus_Amount  decimal (26, 6) >0   [1..1]  Deferred Bonus Calculation Range Deferred To Bonus Amount   
Deferred_Bonus_Percent  decimal (7, 4) >0   [0..1]  Deferred Bonus Calculation Range Bonus Percent Deferred   
Validation Description
Deferred bonus percent value is required.   
top
 

Deferred_Bonus_CalculationReferenceEnumeration

part of: Deferred_Bonus_CalculationObjectID
Base Type
string
top
 

Deferred_Bonus_Reference_FieldReferenceEnumeration

part of: Deferred_Bonus_Reference_FieldObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top