Service Directory > v32.1 > Revenue_Management > Get_Project_Billing_Rate_Sheets
 

Operation: Get_Project_Billing_Rate_Sheets

For Project Billing Rate Sheets


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

Contains Get Project Billing Rate Sheets Request Element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Project_Billing_Rate_Sheet_Request_References  [0..1]  Project Billing Rate Sheet Reference element contains the specific instance set containing the requested Project Billing Rate Sheet. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Project BIlling Rate Sheet.   
Request_Criteria [Choice]   Project_Billing_Rate_Sheet_Request_Criteria  [0..1]  This element is the wrapper around a list of element content representing the specific criteria needed to search for Project Billing Rate Sheet instances. All of the elements are "AND" conditions.   
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  Project_Billing_Rate_Sheet_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Project Billing Rate Sheet response.   
top
 

Response Element: Get_Project_Billing_Rate_Sheets_Response

Element contain Project Billing Rate Sheet response elements including the request data along with the results.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Project_Billing_Rate_Sheet_Request_References  [0..1]  Project Billing Rate Sheet Reference element contains the specific instance set containing the requested Project Billing Rate Sheet. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Project BIlling Rate Sheet.   
Request_Criteria  Project_Billing_Rate_Sheet_Request_Criteria  [0..1]  This element is the wrapper around a list of element content representing the specific criteria needed to search for Project Billing Rate Sheet instances. All of the elements are "AND" conditions.   
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  Project_Billing_Rate_Sheet_Response_Group  [0..1]  Wrapper element around a list of elements representing the amount of data that should be included in the Project Billing Rate Sheet response.   
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  Project_Billing_Rate_Sheet_Response_Data  [0..1]  Project Billing Rate Sheet Response Data Element   
top
 

Project_Billing_Rate_Sheet_Request_References

part of: Get_Project_Billing_Rate_Sheets_Request, Get_Project_Billing_Rate_Sheets_Response
Project Billing Rate Sheet Reference element contains the specific instance set containing the requested Project Billing Rate Sheet. The ID is the value and the Type attribute is either the Lookup ID type or the Workday ID (GUID) for the instance of Project BIlling Rate Sheet.
 
Parameter name Type/Value Cardinality Description Validations
Project_Billing_Rate_Sheet_Reference  Project_Billing_Rate_SheetObject  [1..*]  Instance Set containing the Project Billing Rate Sheet object.   
top
 

Project_Billing_Rate_SheetObject

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

Project_Billing_Rate_SheetObjectID

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

Project_Billing_Rate_Sheet_Request_Criteria

part of: Get_Project_Billing_Rate_Sheets_Request, Get_Project_Billing_Rate_Sheets_Response
This element is the wrapper around a list of element content representing the specific criteria needed to search for Project Billing Rate Sheet instances. All of the elements are "AND" conditions.
 
Parameter name Type/Value Cardinality Description Validations
Project_Billing_Rate_Sheet_Name  string  [0..1]  Project Billing Rate Sheet Name   
Currency_Reference  CurrencyObject  [0..1]  Project Billing Rate Sheet Currency   
top
 

CurrencyObject

part of: Project_Billing_Rate_Sheet_Request_Criteria, Project_Billing_Rate_Sheet_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
 

Response_Filter

part of: Get_Project_Billing_Rate_Sheets_Request, Get_Project_Billing_Rate_Sheets_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
 

Project_Billing_Rate_Sheet_Response_Group

part of: Get_Project_Billing_Rate_Sheets_Request, Get_Project_Billing_Rate_Sheets_Response
Wrapper element around a list of elements representing the amount of data that should be included in the Project Billing Rate Sheet response.
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Flag indicating if the Project Billing Rate Sheet Reference data is to be included in the response.   
top
 

Response_Results

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

Project_Billing_Rate_Sheet_Response_Data

part of: Get_Project_Billing_Rate_Sheets_Response
Project Billing Rate Sheet Response Data Element
 
Parameter name Type/Value Cardinality Description Validations
Project_Billing_Rate_Sheet  Project_Billing_Rate_Sheet  [0..*]  Project Billing Rate Sheet data details   
top
 

Project_Billing_Rate_Sheet

part of: Project_Billing_Rate_Sheet_Response_Data
Project Billing Rate Sheet data details
 
Parameter name Type/Value Cardinality Description Validations
Project_Billing_Rate_Sheet_Reference  Project_Billing_Rate_SheetObject  [0..1]  Project Billing Rate Sheet Reference   
Project_Billing_Rate_Sheet_Data  Project_Billing_Rate_Sheet_Data  [0..1]  The data for the Project Billing Rate Sheet. 
Validation Description
Project Billing Rate has duplicate entry for Project Role and Project Rate Category Members: [duplicates].   
Project Billing Rate has more than one Project Rate Category Member defined for the same Project Rate Category: [duplicates].   
Either select the Max check box or change the Unit of Time to Hours.   
Unit of Time must be equal to days for the Daily Rate Transaction Grouping to be valid.   
Select Active Transaction Grouping.   
 
top
 

Project_Billing_Rate_Sheet_Data

part of: Project_Billing_Rate_Sheet
Contains element data for Get/Put of Project Billing Rate Sheet data.
 
Parameter name Type/Value Cardinality Description Validations
Project_Billing_Rate_Sheet_ID  string  [0..1]  Project Billing Rate Sheet ID   
Project_Billing_Rate_Sheet_Name  string  [1..1]  Project Billing Rate Sheet Name   
Currency_Reference  CurrencyObject  [0..1]  Project Billing Rate Sheet Currency   
Unit_of_Time_Reference  Unit_of_TimeObject  [1..1]  Unit of Time Reference for the Project Billing Rate Sheet 
Validation Description
Unit of Time must be Days or Hours.   
 
Effective_Date  date  [1..1]  Project Billing Rate Sheet effective date   
Daily_Rate_Transaction_Grouping_Reference  Daily_Rate_Transaction_GroupingObject  [0..1]  Daily Rate Transaction Grouping   
Project_Billing_Rates  Project_Billing_Rate_Data  [0..*]  Project Billing Rate Sheet data details   
Time_Definitions  Rate_Sheet_Conversion_Definition_Data  [0..*]  Time Definition details the Project Billing Rate Sheet 
Validation Description
There is a gap between the Hours To value [To] and the Hours From value in the next row. Change the values so the gap is [break].   
The Hours From value cannot be greater than the Hours To value. Change either value so Hours From is not greater than Hours To.   
There is a gap between the Hours From value [From] and the Hours To value in the previous row. Change the values so the gap is [break].   
To set up Time Definitions, your Unit of Time must be Days.   
You can select only one max tier.   
 
Validation Description
Project Billing Rate has duplicate entry for Project Role and Project Rate Category Members: [duplicates].   
Project Billing Rate has more than one Project Rate Category Member defined for the same Project Rate Category: [duplicates].   
Either select the Max check box or change the Unit of Time to Hours.   
Unit of Time must be equal to days for the Daily Rate Transaction Grouping to be valid.   
Select Active Transaction Grouping.   
top
 

Unit_of_TimeObject

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

Unit_of_TimeObjectID

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

Daily_Rate_Transaction_GroupingObject

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

Daily_Rate_Transaction_GroupingObjectID

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

Project_Billing_Rate_Data

part of: Project_Billing_Rate_Sheet_Data
Project Billing Rate Data. Need to potentially define category members based on the available categories in the system. In addition, you must specify a project role and hourly rate.
 
Parameter name Type/Value Cardinality Description Validations
Project_Rate_Category_Member_Reference  Project_Rate_Category_MemberObject  [0..*]  Project Rate Categories are pre-defined and contain members. Need to assign the members that define the rate for the project role. This allows you to have multiple rates per project role based on the unique member combinations.   
Project_Role_Reference  Project_RoleObject  [1..1]  Project role assigned to the rate.   
Rate  decimal (18, 6) >0   [1..1]  Hourly rate for the project role.   
top
 

Project_Rate_Category_MemberObject

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

Project_Rate_Category_MemberObjectID

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

Project_RoleObject

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

Project_RoleObjectID

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

Rate_Sheet_Conversion_Definition_Data

part of: Project_Billing_Rate_Sheet_Data
Time Definition details for the Project Billing Rate Sheet
 
Parameter name Type/Value Cardinality Description Validations
Hours_From  decimal (14, 2) >0   [0..1]  Hours From for the Time Definition   
Hours_To  decimal (14, 2) >0   [0..1]  Hours To for the Time Definition   
Conversion_Rate  decimal (21, 6) >0   [0..1]  Conversion Rate for the Time Definition   
Max_Tier  boolean  [0..1]  Max Tier for the Time definition. There will be only one max tier.   
Validation Description
There is a gap between the Hours To value [To] and the Hours From value in the next row. Change the values so the gap is [break].   
The Hours From value cannot be greater than the Hours To value. Change either value so Hours From is not greater than Hours To.   
There is a gap between the Hours From value [From] and the Hours To value in the previous row. Change the values so the gap is [break].   
To set up Time Definitions, your Unit of Time must be Days.   
You can select only one max tier.   
top
 

Project_Billing_Rate_SheetReferenceEnumeration

part of: Project_Billing_Rate_SheetObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Unit_of_TimeReferenceEnumeration

part of: Unit_of_TimeObjectID
Base Type
string
top
 

Daily_Rate_Transaction_GroupingReferenceEnumeration

part of: Daily_Rate_Transaction_GroupingObjectID
Base Type
string
top
 

Project_Rate_Category_MemberReferenceEnumeration

part of: Project_Rate_Category_MemberObjectID
Base Type
string
top
 

Project_RoleReferenceEnumeration

part of: Project_RoleObjectID
Base Type
string
top