Service Directory > v32.1 > Revenue_Management > Get_Worker_Billing_Rates
 

Operation: Get_Worker_Billing_Rates

This web service can be used to retrieve worker billing rate data. Data can be retrieved by providing one or more worker billing rate references. Alternatively, data can be retrieved by providing one or more worker references. Leave the Request References and Request criteria null to retrieve all 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_Worker_Billing_Rates_Request

This is the web service operation to get worker billing rates. To get specific worker billing rates specify either the Request References or Request Criteria. To get all leave both of these null.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Worker_Billing_Rate_Request_References  [0..1]  Element encapsulating worker billing rate references   
Request_Criteria [Choice]   Worker_Billing_Rate_Request_Criteria  [0..1]  Element encapsulating worker references for the request   
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. 
 
top
 

Response Element: Get_Worker_Billing_Rates_Response

This is the element encapsulating the Worker Billing Rate response data from the Get Worker Billing Rates request.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Worker_Billing_Rate_Request_References  [0..1]  This is the element encapsulating Worker Billing Rate References.   
Request_Criteria  Worker_Billing_Rate_Request_Criteria  [0..1]  This is the element encapsulating Worker References.   
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_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  Worker_Billing_Rate_Response_Data  [0..1]  This is the element encapsulating the Worker Billing Rate Data.   
top
 

Worker_Billing_Rate_Request_References

part of: Get_Worker_Billing_Rates_Response, Get_Worker_Billing_Rates_Request
This is the element encapsulating Worker Billing Rate References.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Billing_Rate_Reference  Worker_Billing_RateObject  [1..*]  Worker Billing Rate Reference   
top
 

Worker_Billing_RateObject

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

Worker_Billing_RateObjectID

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

part of: Get_Worker_Billing_Rates_Response, Get_Worker_Billing_Rates_Request
This is the element encapsulating Worker References.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..*]  Worker reference   
top
 

WorkerObject

part of: Worker_Billing_Rate_Request_Criteria, Worker_Billing_Rate__HV__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
 

Response_Filter

part of: Get_Worker_Billing_Rates_Response, Get_Worker_Billing_Rates_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
 

Response_Results

part of: Get_Worker_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_Billing_Rate_Response_Data

part of: Get_Worker_Billing_Rates_Response
This is the element encapsulating the Worker Billing Rate Data.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Billing_Rate_Data  Worker_Billing_Rate__HV__Data  [0..*]  Worker Billing Rate Data. Only one row should exist per worker. 
Validation Description
You cannot update an existing worker billing rate to use a different worker.   
You cannot submit two or more rates for a worker using the same date.   
You cannot create a new worker billing rate when one already exists for the worker.   
 
top
 

Worker_Billing_Rate__HV__Data

part of: Worker_Billing_Rate_Response_Data
Worker Billing Rate Data. Only one row should exist per worker.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Billing_Rate_Reference  Worker_Billing_RateObject  [0..1]  Reference to an existing worker billing rate for update purposes   
Worker_Billing_Rate_Reference_ID  string  [0..1]  Reference ID for a worker billing rate   
Worker_Reference  WorkerObject  [1..1]  Worker for a worker billing rate   
Currency_Reference  CurrencyObject  [1..1]  Currency for a worker billing rate   
Inactive  boolean  [0..1]  Inactive Flag for Worker Billing Rate.   
Billing_Rate_Data  Worker_Billing_Rate_Snapshot__HV__Data  [1..*]  Element containing billing rate for an effective date   
Validation Description
You cannot update an existing worker billing rate to use a different worker.   
You cannot submit two or more rates for a worker using the same date.   
You cannot create a new worker billing rate when one already exists for the worker.   
top
 

CurrencyObject

part of: Worker_Billing_Rate__HV__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_Billing_Rate_Snapshot__HV__Data

part of: Worker_Billing_Rate__HV__Data
Element containing billing rate for an effective date
 
Parameter name Type/Value Cardinality Description Validations
Worker_Billing_Rate  decimal (18, 3) >0   [0..1]  Worker billing rate   
Effective_Date  date  [1..1]  Effective date for worker billing rate   
top
 

Worker_Billing_RateReferenceEnumeration

part of: Worker_Billing_RateObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top