Service Directory > v32.1 > Financial_Management > Get_Budget_Fringe_Rate_Tables
 

Operation: Get_Budget_Fringe_Rate_Tables

This task gets Fringe rate tables, and can retrieve a specific instance by reference id, wid, or Fringe Rate Table Name


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

Request element to get fringe tables
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Budget_Fringe_Rate_Table_Request_References  [0..1]  Element request references by wid or ref id   
Request_Criteria [Choice]   Budget_Fringe_Rate_Table_Request_Criteria  [0..1]  Element to request references by criteria (i.e) name   
Response_Filter  Response_Filter  [0..1]  Response filter element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Budget_Fringe_Rate_Table_Response_Group  [0..1]  element to group responses   
top
 

Response Element: Get_Budget_Fringe_Rate_Tables_Response

response element for getting fringe table
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Budget_Fringe_Rate_Table_Request_References  [0..1]  element which requests references   
Request_Criteria  Budget_Fringe_Rate_Table_Request_Criteria  [0..1]  Request Criteria Element   
Response_Filter  Response_Filter  [0..1]  Response Filter Element 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Budget_Fringe_Rate_Table_Response_Group  [0..1]  Response group element for fringe rate tables   
Response_Results  Response_Results  [0..1]  Response result element for fringe rate tables   
Response_Data  Budget_Fringe_Rate_Table_Response_Data  [0..1]  Response data element for fringe rate tables   
top
 

Budget_Fringe_Rate_Table_Request_References

part of: Get_Budget_Fringe_Rate_Tables_Request, Get_Budget_Fringe_Rate_Tables_Response
Request references using workday id or ref id
 
Parameter name Type/Value Cardinality Description Validations
Fringe_Rate_Table_Reference  Budget_Fringe_Rate_TableObject  [1..*]  field to request references by wid or reference id   
top
 

Budget_Fringe_Rate_TableObject

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

Budget_Fringe_Rate_TableObjectID

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

Budget_Fringe_Rate_Table_Request_Criteria

part of: Get_Budget_Fringe_Rate_Tables_Request, Get_Budget_Fringe_Rate_Tables_Response
Budget Fringe Tables can be requested by ID
 
Parameter name Type/Value Cardinality Description Validations
Fringe_Rate_Table_Name  string  [0..1]  Request a Fringe Rate Table by name   
top
 

Response_Filter

part of: Get_Budget_Fringe_Rate_Tables_Request, Get_Budget_Fringe_Rate_Tables_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
 

Budget_Fringe_Rate_Table_Response_Group

part of: Get_Budget_Fringe_Rate_Tables_Request, Get_Budget_Fringe_Rate_Tables_Response
Response Group Element for Fringe Rate Tables
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Budget_Fringe_Rate_Table_Response_Data

part of: Get_Budget_Fringe_Rate_Tables_Response
Response Element for Get Fringe Rate Tables
 
Parameter name Type/Value Cardinality Description Validations
Fringe_Rate_Table  Budget_Fringe_Rate_Table  [0..*]  Element that contains fringe rates   
top
 

Budget_Fringe_Rate_Table

part of: Budget_Fringe_Rate_Table_Response_Data
Content for Fringe Rate Table
 
Parameter name Type/Value Cardinality Description Validations
Fringe_Rate_Table_Reference  Budget_Fringe_Rate_TableObject  [0..1]  Fringe Rate Table Reference   
Fringe_Rate_Table_Data  Fringe_Rate_Table_Data  [0..*]  Data for Fringe Rate Table   
top
 

Fringe_Rate_Table_Data

part of: Budget_Fringe_Rate_Table
Element containing Fringe Rate Table reference for add/update and Fringe Rate lines data.
 
Parameter name Type/Value Cardinality Description Validations
Fringe_Rate_Table_ID  string  [0..1]  Fringe Rate Table Reference ID. This is the Fringe Rate Table unique identifier.   
Fringe_Rate_Table_Name  string  [0..1]  Fringe Rate Table Name   
Fringe_Rate_Data  Fringe_Rate_Data  [0..*]  Fringe Rate Line Data. A Fringe Rate Table can contain multiple Fringe Rate Lines. 
Validation Description
Enter Fringe Rate Description that isn't already in use within the set.   
 
top
 

Fringe_Rate_Data

part of: Fringe_Rate_Table_Data
Element containing all Fringe Rate line data
 
Parameter name Type/Value Cardinality Description Validations
Fringe_Rate_Order  string  [0..1]  Ordering for Fringe Rate Lines. This orders the Fringe Rate Lines in the table.   
Fringe_Rate_Description  string  [1..1]  Fringe Rate Line Description   
Fringe_Rate  decimal (5, 2) >0   [0..1]  Fringe Rate   
Fringe_Rate_ID  string  [0..1]  Fringe Rate Reference ID   
Validation Description
Enter Fringe Rate Description that isn't already in use within the set.   
top
 

Budget_Fringe_Rate_TableReferenceEnumeration

part of: Budget_Fringe_Rate_TableObjectID
Base Type
string
top