Service Directory > v31.2 > Revenue_Management > Get_Contract_Line_Fees
 

Operation: Get_Contract_Line_Fees

Returns Contract Line Fees by Reference ID. If no Reference ID or criteria is provided, all Contract Line Fees are returned.


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

Element Container for Get Contract Line Fees Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Contract_Line_Fee_Request_References  [0..1]  Element Container for Contract Line Fee Request References   
Request_Criteria [Choice]   Contract_Line_Fee_Request_Criteria  [0..1]  Element Container for Contract Line Fee 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. 
 
top
 

Response Element: Get_Contract_Line_Fees_Response

Element Container for Get Contract Line Fees Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Contract_Line_Fee_Request_References  [0..1]  Element Container for Contract Line Fee Request References   
Request_Criteria  Contract_Line_Fee_Request_Criteria  [0..1]  Element Container for Contract Line Fee 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_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_Line_Fee_Response_Data  [0..1]  Element Container for Contract Line Fee Response Data   
top
 

Contract_Line_Fee_Request_References

part of: Get_Contract_Line_Fees_Response, Get_Contract_Line_Fees_Request
Element Container for Contract Line Fee Request References
 
Parameter name Type/Value Cardinality Description Validations
Contract_Line_Fee_Reference  Contract_Line_FeeObject  [1..*]  Element Container for Contract Line Fee Request References   
top
 

Contract_Line_FeeObject

part of: Contract_Line_Fee_Data, Contract_Line_Fee_Request_References, Contract_Line_Fee
 
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_Line_FeeObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Contract_Line_FeeObjectID

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

part of: Get_Contract_Line_Fees_Response, Get_Contract_Line_Fees_Request
Element Container for Contract Line Fee Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Contract_Line_Fees_Response, Get_Contract_Line_Fees_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_Contract_Line_Fees_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_Line_Fee_Response_Data

part of: Get_Contract_Line_Fees_Response
Element Container for Contract Line Fee Response Data
 
Parameter name Type/Value Cardinality Description Validations
Contract_Line_Fee  Contract_Line_Fee  [0..*]  Element Container for Contract Line Fee   
top
 

Contract_Line_Fee

part of: Contract_Line_Fee_Response_Data
Element Container for Contract Line Fee
 
Parameter name Type/Value Cardinality Description Validations
Contract_Line_Fee_Reference  Contract_Line_FeeObject  [0..1]  Reference to an existing Contract Line Fee.   
Contract_Line_Fee_Data  Contract_Line_Fee_Data  [0..*]  Element Container for Contract Line Fee Data 
Validation Description
You can't enter a percentage less than -100.   
Revenue Category must match the Revenue Category for the Sales Item if that category is active.   
Inherit Worktags Source must be Project or Contract Line.   
 
top
 

Contract_Line_Fee_Data

part of: Contract_Line_Fee
Element Container for Contract Line Fee Data
 
Parameter name Type/Value Cardinality Description Validations
Contract_Line_Fee_Reference_ID  string  [0..1]  Contract Line Fee Reference ID. This is the unique Contract Line Fee identifier.   
Contract_Line_Fee_Reference  Contract_Line_FeeObject  [0..1]  Reference element representing the Contract Line Fee.   
Contract_Line_Fee_Name  string  [1..1]  Contract Line Fee Name.   
Contract_Line_Fee_Percentage  decimal (9, 6)   [1..1]  Contract Line Fee Percentage.   
Sales_Item_Reference  Sales_ItemObject  [0..1]  Reference element representing the sales item.   
Revenue_Category_Reference  Revenue_CategoryObject  [0..1]  Reference element representing the revenue category.   
Contract_Line_Fee_Worktag_Source_Reference  Contract_Line_Fee_Worktag_SourceObject  [1..1]  Reference element representing the Contract Line Fee Worktag Source.   
Validation Description
You can't enter a percentage less than -100.   
Revenue Category must match the Revenue Category for the Sales Item if that category is active.   
Inherit Worktags Source must be Project or Contract Line.   
top
 

Sales_ItemObject

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

Sales_ItemObjectID

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

Revenue_CategoryObject

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

Revenue_CategoryObjectID

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

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

Contract_Line_Fee_Worktag_SourceObjectID

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

part of: Contract_Line_FeeObjectID
Base Type
string
top
 

Sales_ItemReferenceEnumeration

part of: Sales_ItemObjectID
Base Type
string
top
 

Revenue_CategoryReferenceEnumeration

part of: Revenue_CategoryObjectID
Base Type
string
top
 

Contract_Line_Fee_Worktag_SourceReferenceEnumeration

part of: Contract_Line_Fee_Worktag_SourceObjectID
Base Type
string
top