Service Directory > v25.1 > Revenue_Management > Put_Contract_Rate_Sheet
 

Operation: Put_Contract_Rate_Sheet

This service operation will add or update Contract Rate Sheet. Contract Rate Sheet includes contract rates for workers and different billing rate rules.


@ - 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: Put_Contract_Rate_Sheet_Request

Request element to create Contract Rate Sheet
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Contract_Rate_Sheet_Reference  Contract_Rate_SheetObject  [0..1]  Contract Rate Sheet Reference   
Contract_Rate_Sheet_Data  Contract_Rate_Sheet_Data  [1..1]  Contains Contract Rate Sheet Data   
Validation Description
The Web Service is set to Add Only, but the Contract Rate Sheet already exists.   
top
 

Response Element: Put_Contract_Rate_Sheet_Response

Put Contract Rate Sheet Response Element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Contract_Rate_Sheet_Reference  Contract_Rate_SheetObject  [0..1]  Reference of Contract Rate Sheet which got created   
top
 

Contract_Rate_SheetObject

part of: Put_Contract_Rate_Sheet_Request, Put_Contract_Rate_Sheet_Response
 
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_Data

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