Service Directory > v32.1 > Revenue_Management > Get_Salary_Caps
 

Operation: Get_Salary_Caps

This service operation will get award salary cap for the specified criteria.Award Salary Cap Data includes Award Salary Cap Reference ID, Award Limit Name, Award Limit Snapshot Data.


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

Element Containing Get Salary Caps Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Limit_Request_References  [0..1]  Salary Cap Request References   
Request_Criteria [Choice]   Payroll_Limit_Request_Criteria  [0..1]  Payroll Limit 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  Payroll_Limit_Response_Group  [0..1]  Payroll Limit Response Group   
top
 

Response Element: Get_Salary_Caps_Response

Get Salary Caps Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Limit_Request_References  [0..1]  Salary Cap Request References   
Request_Criteria  Payroll_Limit_Request_Criteria  [0..1]  Payroll Limit 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  Payroll_Limit_Response_Group  [0..1]  Payroll Limit 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  Payroll_Limit_Response_Data  [0..1]  Element containing Salary Cap Response Data   
top
 

Payroll_Limit_Request_References

part of: Get_Salary_Caps_Request, Get_Salary_Caps_Response
Salary Cap Request References
 
Parameter name Type/Value Cardinality Description Validations
Salary_Cap_Request_Reference  Payroll_LimitObject  [1..*]  Award Salary Cap Reference   
top
 

Payroll_LimitObject

part of: Payroll_Limit_Request_References, Payroll_Limit, Payroll_Limit_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  Payroll_LimitObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Payroll_LimitObjectID

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

Payroll_Limit_Request_Criteria

part of: Get_Salary_Caps_Request, Get_Salary_Caps_Response
Payroll Limit Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Salary_Caps_Request, Get_Salary_Caps_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
 

Payroll_Limit_Response_Group

part of: Get_Salary_Caps_Request, Get_Salary_Caps_Response
Payroll Limit Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Payroll_Limit_Response_Data

part of: Get_Salary_Caps_Response
Element containing Salary Cap Response Data
 
Parameter name Type/Value Cardinality Description Validations
Salary_Cap  Payroll_Limit  [0..*]  Award Salary Cap   
top
 

Payroll_Limit

part of: Payroll_Limit_Response_Data
Element containing Salary Cap
 
Parameter name Type/Value Cardinality Description Validations
Salary_Cap_Request_Reference  Payroll_LimitObject  [0..1]  Award Salary Cap Reference   
Salary_Cap_Data  Payroll_Limit_Data  [0..*]  Award Salary Cap Data   
top
 

Payroll_Limit_Data

part of: Payroll_Limit
Element containing Award Salary Cap Data
 
Parameter name Type/Value Cardinality Description Validations
Salary_Cap_Reference  Payroll_LimitObject  [0..1]  Payroll Limit Reference   
Salary_Cap_ID  string  [0..1]  Award Salary Cap Reference ID   
Salary_Cap_Name  string  [1..1]  Award Limit Name 
Validation Description
Enter a Salary Cap Name that isn't already in use.   
 
Salary_Cap_Description  string  [0..1]  Award Limit Description   
Salary_Over_The_Cap_Type_Reference  Salary_Over_The_Cap_TypeObject  [1..1]  Salary Over The Cap Type Reference   
Pay_Component_Group_for_Salary_Cap_Reference  Pay_Component_Group__All_Object  [1..1]  Pay Component Group for Payroll Limit Reference   
Inactive  boolean  [0..1]  Inactive   
Salary_Cap_Interval_Data  Payroll_Limit_Snapshot_Data  [0..*]  Award Limit Snapshot Data 
Validation Description
The Salary Cap Interval Date From is later than Date To. Enter a Date From that is before Date To.   
Enter a Salary Cap Interval period that does not overlap another, existing Salary Cap Interval period.   
The Date To value on the Salary Cap Interval is missing. Only the last Salary Cap Interval can have a blank Date To value.   
Validation Description
You can't change interval dates of a Salary Cap that is In use.   
You can't change the Salary Cap Amount of a Salary Cap that is In use.   
 
top
 

Salary_Over_The_Cap_TypeObject

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

Salary_Over_The_Cap_TypeObjectID

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

Pay_Component_Group__All_Object

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

Pay_Component_Group__All_ObjectID

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

Payroll_Limit_Snapshot_Data

part of: Payroll_Limit_Data
Element containing Salary Cap Snapshot Data
 
Parameter name Type/Value Cardinality Description Validations
Salary_Cap_Interval_Reference  Payroll_Limit_SnapshotObject  [0..1]  Payroll Limit Snapshot Reference   
Salary_Cap_Interval_ID  string  [0..1]  Payroll Limit Snapshot Reference ID   
Date_From  date  [1..1]  Date From   
Date_To  date  [0..1]  Date To   
Salary_Cap_Amount  decimal (10, 2) >0   [1..1]  Award Limit Amount   
Validation Description
You can't change interval dates of a Salary Cap that is In use.   
You can't change the Salary Cap Amount of a Salary Cap that is In use.   
top
 

Payroll_Limit_SnapshotObject

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

Payroll_Limit_SnapshotObjectID

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

Payroll_LimitReferenceEnumeration

part of: Payroll_LimitObjectID
Base Type
string
top
 

Salary_Over_The_Cap_TypeReferenceEnumeration

part of: Salary_Over_The_Cap_TypeObjectID
Base Type
string
top
 

Pay_Component_Group__All_ReferenceEnumeration

part of: Pay_Component_Group__All_ObjectID
Base Type
string
top
 

Payroll_Limit_SnapshotReferenceEnumeration

part of: Payroll_Limit_SnapshotObjectID
Base Type
string
top