Service Directory > v25.1 > Revenue_Management > Get_Contract_Rate_Sheets
 

Operation: Get_Contract_Rate_Sheets

This service operation returns Contract Rate Sheet. Data includes: Contract Rates and details of Billing Rate Rule Set.


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

Contains Get Contract Rate Sheets Request Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Contract_Rate_Sheet_Request_References  [0..1]  Request References   
Request_Criteria [Choice]   Contract_Rate_Sheet_Request_Criteria  [0..1]  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  Contract_Rate_Sheet_Response_Group  [0..1]  Response Group   
top
 

Response Element: Get_Contract_Rate_Sheets_Response

Get Contract Rate Sheets Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Contract_Rate_Sheet_Request_References  [0..1]  Contract Rate Sheet Request References Element   
Request_Criteria  Contract_Rate_Sheet_Request_Criteria  [0..1]  Contract Rate Sheet Request Criteria Element   
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  Contract_Rate_Sheet_Response_Group  [0..1]  Contract Rate Sheet Response Group Element   
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  Contract_Rate_Sheet_Response_Data  [0..1]  Response Data   
top
 

Contract_Rate_Sheet_Request_References

part of: Get_Contract_Rate_Sheets_Request, Get_Contract_Rate_Sheets_Response
Contract Rate Sheet Request References Element
 
Parameter name Type/Value Cardinality Description Validations
Contract_Rate_Sheet_Reference  Contract_Rate_SheetObject  [1..*]  Contract Rate Sheet Reference   
top
 

Contract_Rate_SheetObject

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

Contract_Rate_SheetObjectID

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

Contract_Rate_Sheet_Request_Criteria

part of: Get_Contract_Rate_Sheets_Request, Get_Contract_Rate_Sheets_Response
Contract Rate Sheet Request Criteria Element
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Contract_Rate_Sheets_Request, Get_Contract_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
 

Contract_Rate_Sheet_Response_Group

part of: Get_Contract_Rate_Sheets_Request, Get_Contract_Rate_Sheets_Response
Contract Rate Sheet Response Group Element
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Contract_Rate_Sheet_Response_Data

part of: Get_Contract_Rate_Sheets_Response
Contract Rate Sheet Response Data Element
 
Parameter name Type/Value Cardinality Description Validations
Contract_Rate_Sheet  Contract_Rate_Sheet  [0..*]  Contract Rate Sheet details   
top
 

Contract_Rate_Sheet

part of: Contract_Rate_Sheet_Response_Data
Contract Rate Sheet details
 
Parameter name Type/Value Cardinality Description Validations
Contract_Rate_Sheet_Reference  Contract_Rate_SheetObject  [0..1]  Contract Rate Sheet Reference   
Contract_Rate_Sheet_Data  Contract_Rate_Sheet_Data  [0..1]  Contains Contract Rate Sheet Data   
top
 

Contract_Rate_Sheet_Data

part of: Contract_Rate_Sheet
Contains Contract Rate Sheet Data
 
Parameter name Type/Value Cardinality Description Validations
Contract_Rate_Sheet_ID  string  [0..1]  Contract Rate Sheet ID   
Contract_Rate_Sheet_Name  string  [1..1]  Contract Rate Sheet Name   
Effective_Date  date  [1..1]  Contract Rate Sheet Effective Date 
Validation Description
Edit date must be equal to the current effective contract rate sheet, [effective contract rate sheet date], or in the future.   
 
Project_Billing_Rate_Sheet_Reference  Project_Billing_Rate_SheetObject  [0..1]  Project Billing Rate Sheet Reference 
Validation Description
The Project Billing Rate Sheet must be effective for the given date.   
 
Project_Rate_Category_Member_Reference  Project_Rate_Category_MemberObject  [0..*]  Project Rate Category Member Reference 
Validation Description
The Project Rate Category must belong to the Project Billing Rate Sheet.   
 
Customer_Contract_Line_Reference  Customer_Contract_LineObject  [0..*]  Customer Contract Line Reference   
Currency_Reference  CurrencyObject  [1..1]  Currency Reference for Contract Rate Sheet   
Contract_Rates  Contract_Rate_Data  [0..*]  Contains Contract Rates 
Validation Description
The Currency must be same for all the Contract Rates.   
 
top
 

Project_Billing_Rate_SheetObject

part of: Contract_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  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_Rate_Category_MemberObject

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

Customer_Contract_LineObject

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

Customer_Contract_LineObjectID

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

Contract_Rate_Data

part of: Contract_Rate_Sheet_Data
Contains Contract Rate Data
 
Parameter name Type/Value Cardinality Description Validations
Project_Role_Reference  Project_RoleObject  [1..1]  Project Role Reference   
Standard_Rate  decimal (21, 6)   [0..1]  Standard Rate 
Validation Description
The Standard Rate must match the Standard Rate on the Project Billing Rate Sheet or, if no rate is present, then it must be zero.   
 
Adjustment_Percent  decimal (9, 6)   [0..1]  Adjustment % for Contract Rate 
Validation Description
Discount must be less than 100%.   
Adjustment % must be less than 1000.   
The Adjustment % is incorrect. Adjustment % = ((Contract Rate - Standard Rate)/Standard Rate)*100.   
 
Contract_Rate  decimal (21, 6)   [1..1]  Contract Rate 
Validation Description
Contract Bill Rate must be greater than zero.   
 
Currency_Reference  CurrencyObject  [1..1]  Currency Reference for Contract Rate 
Validation Description
The Contract Rate Currency and the Project Billing Rate Sheet Currency must be same.   
 
Validation Description
The Currency must be same for all the Contract Rates.   
top
 

Project_RoleObject

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

Contract_Rate_SheetReferenceEnumeration

part of: Contract_Rate_SheetObjectID
Base Type
string
top
 

Project_Billing_Rate_SheetReferenceEnumeration

part of: Project_Billing_Rate_SheetObjectID
Base Type
string
top
 

Project_Rate_Category_MemberReferenceEnumeration

part of: Project_Rate_Category_MemberObjectID
Base Type
string
top
 

Customer_Contract_LineReferenceEnumeration

part of: Customer_Contract_LineObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Project_RoleReferenceEnumeration

part of: Project_RoleObjectID
Base Type
string
top