Service Directory > v31.2 > Revenue_Management > Get_Worker_Rule_Billing_Rates
 

Operation: Get_Worker_Rule_Billing_Rates

Returns Worker Rule Billing Rate[plural] by Reference ID, or returns all Worker Rule Billing Rate[plural] if no Reference ID is provided.


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

Get Worker Rule Billing Rates Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Worker_Rule_Billing_Rate_Request_References  [0..1]  Worker Rule Billing Rate Request References   
Request_Criteria [Choice]   Worker_Rule_Billing_Rate_Request_Criteria  [0..1]  Worker Rule Billing Rate Request Criteria   
Response_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
top
 

Response Element: Get_Worker_Rule_Billing_Rates_Response

Get Worker Rule Billing Rates Response Element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Worker_Rule_Billing_Rate_Request_References  [0..1]  Worker Rule Billing Rate Request References   
Request_Criteria  Worker_Rule_Billing_Rate_Request_Criteria  [0..1]  Worker Rule Billing Rate Request Criteria Element   
Response_Filter  Response_Filter  [0..1]  Response Filter element from Get Worker Rule Billing Rates Response element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Results element from Get Worker Rule Billing Rates Response element   
Response_Data  Worker_Rule_Billing_Rate_Response_Data  [0..1]  Response Data   
top
 

Worker_Rule_Billing_Rate_Request_References

part of: Get_Worker_Rule_Billing_Rates_Request, Get_Worker_Rule_Billing_Rates_Response
Worker Rule Billing Rate Request References
 
Parameter name Type/Value Cardinality Description Validations
Worker_Rule_Billing_Rate_Reference  Worker_Rule_Billing_RateObject  [1..*]  Worker Rule Billing Rate instances in Get request   
top
 

Worker_Rule_Billing_RateObject

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

Worker_Rule_Billing_RateObjectID

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

Worker_Rule_Billing_Rate_Request_Criteria

part of: Get_Worker_Rule_Billing_Rates_Request, Get_Worker_Rule_Billing_Rates_Response
Worker Rule Billing Rate Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
Project_Cost_Rate_Rule_Reference  Project_Cost_Rate_RuleObject  [1..1]  Project Cost Rate Rule Reference in Request Criteria.   
top
 

Project_Cost_Rate_RuleObject

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

Project_Cost_Rate_RuleObjectID

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

Response_Results

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

Worker_Rule_Billing_Rate_Response_Data

part of: Get_Worker_Rule_Billing_Rates_Response
Worker Rule Billing Rate Response Data element
 
Parameter name Type/Value Cardinality Description Validations
Worker_Rule_Billing_Rate  Worker_Rule_Billing_Rate  [0..*]  Worker Rule Billing Rate in Response   
top
 

Worker_Rule_Billing_Rate

part of: Worker_Rule_Billing_Rate_Response_Data
Worker Rule Billing Rate element
 
Parameter name Type/Value Cardinality Description Validations
Worker_Rule_Billing_Rate_Reference  Worker_Rule_Billing_RateObject  [0..1]  Worker Rule Billing Rate Reference   
Worker_Rule_Billing_Rate_Data  Worker_Rule_Billing_Rate_Data  [0..*]  Worker Rule Billing Rate Data Element 
Validation Description
You can't associate the Project Cost Rate Rule to more than 1 Worker Rule Billing Rate.  You can't associate the Project Cost Rate Rule to more than 1 Worker Rule Billing Rate. 
You can't have more than 1 Worker Rule Billing Rate with the same effective date.  You can't have more than 1 Worker Rule Billing Rate with the same effective date. 
Your Worker Rule Billing Rates can't have the same order number.  Your Worker Rule Billing Rates can't have the same order number. 
 
top
 

Worker_Rule_Billing_Rate_Data

part of: Worker_Rule_Billing_Rate
The element holds data needed to create Worker Rule Billing Rate instance and it's snapshot
 
Parameter name Type/Value Cardinality Description Validations
Worker_Rule_Billing_Rate_ID  string  [0..1]  Reference ID for Worker Rule Billing Rate instance   
Worker_Rule_Billing_Rate_Order  string (6)   [1..1]  Worker Rule Billing Rate Order   
XMLNAME__Project__Cost_Rate_Rule_Reference  Project_Cost_Rate_RuleObject  [1..1]  Project Cost Rule Rate for Worker Rule Billing Rate   
Worker_Rule_Billing_Rate_Currency_Reference  CurrencyObject  [1..1]  Currency for Worker Rule Billing Rate   
Inactive  boolean  [0..1]  Inactive boolean for Worker Rule Billing Rate.   
Worker_Billing_Rate_Snapshot_Data  Worker_Rule_Billing_Rate_Snapshot_Data  [1..*]  Element Container for Worker Billing Rate Snapshot Data element.   
Validation Description
You can't associate the Project Cost Rate Rule to more than 1 Worker Rule Billing Rate.  You can't associate the Project Cost Rate Rule to more than 1 Worker Rule Billing Rate. 
You can't have more than 1 Worker Rule Billing Rate with the same effective date.  You can't have more than 1 Worker Rule Billing Rate with the same effective date. 
Your Worker Rule Billing Rates can't have the same order number.  Your Worker Rule Billing Rates can't have the same order number. 
top
 

CurrencyObject

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

Worker_Rule_Billing_Rate_Snapshot_Data

part of: Worker_Rule_Billing_Rate_Data
The element holds snapshot effective date and Worker Billing Rate to create Worker Billing Snapshot instance
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Snapshot Effective Date   
Worker_Billing_Rate  decimal (18, 3) >0   [0..1]  Worker Billing Rate by Rule   
top
 

Worker_Rule_Billing_RateReferenceEnumeration

part of: Worker_Rule_Billing_RateObjectID
Base Type
string
top
 

Project_Cost_Rate_RuleReferenceEnumeration

part of: Project_Cost_Rate_RuleObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top