Service Directory > v31.2 > Resource_Management > Get_Expense_Rate_Tables
 

Operation: Get_Expense_Rate_Tables

This web service operation will retrieve instances of Expense Rate Tables. This contains Name, Type, Default Currency, Expense Item Type for evaluation and Rate Table Lines. Each Rate Table Line contains a reference to a Condition Rule, Behavior Spend Data, and Graduated Expense Data. On the web service request, you can specify a specific reference to a Expense Rate Tables to return.


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

Contains request reference, criteria, filter and response group for getting Expense Rate Table data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Expense_Rate_Table_Request_References  [0..1]  Element containing reference instances for Expense Rate Table   
Request_Criteria [Choice]   Expense_Rate_Table_Request_Criteria  [0..1]  Element containing Expense Rate Table 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  Expense_Rate_Table_Response_Group  [0..1]  Element containing Expense Rate Table response grouping options   
top
 

Response Element: Get_Expense_Rate_Tables_Response

Element containing Expense Rate Table response elements including received criteria, references, data based on criteria and grouping, results filter and result summary
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Expense_Rate_Table_Request_References  [0..1]  Element containing reference instances for Expense Rate Table   
Request_Criteria  Expense_Rate_Table_Request_Criteria  [0..1]  Element containing Expense Rate Table 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  Expense_Rate_Table_Response_Group  [0..1]  Element containing Expense Rate Table response grouping options   
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  Expense_Rate_Table_Response_Data  [0..1]  Wrapper Element that includes Expense Policy Group Instance and Data   
top
 

Expense_Rate_Table_Request_References

part of: Get_Expense_Rate_Tables_Request, Get_Expense_Rate_Tables_Response
Element containing reference instances for Expense Rate Table
 
Parameter name Type/Value Cardinality Description Validations
Expense_Rate_Table_Reference  Expense_Rate_TableObject  [1..*]  Reference to an existing Expense Rate Table   
top
 

Expense_Rate_TableObject

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

Expense_Rate_TableObjectID

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

Expense_Rate_Table_Request_Criteria

part of: Get_Expense_Rate_Tables_Request, Get_Expense_Rate_Tables_Response
Element containing Expense Rate Table request criteria
 
Parameter name Type/Value Cardinality Description Validations
Expense_Rate_Table_Effective_Date  date  [0..1]  Effective Date   
top
 

Response_Filter

part of: Get_Expense_Rate_Tables_Request, Get_Expense_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
 

Expense_Rate_Table_Response_Group

part of: Get_Expense_Rate_Tables_Request, Get_Expense_Rate_Tables_Response
Element containing Expense Rate Table response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Expense_Rate_Table_Response_Data

part of: Get_Expense_Rate_Tables_Response
Wrapper Element that includes Expense Policy Group Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Expense_Rate_Table  Expense_Rate_Table  [0..*]  Wrapper Element that includes Expense Rate Table Instance and Data   
top
 

Expense_Rate_Table

part of: Expense_Rate_Table_Response_Data
Wrapper Element that includes Expense Rate Table Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Expense_Rate_Table_Reference  Expense_Rate_TableObject  [0..1]  Expense Rate Table Reference   
Expense_Rate_Table_Data  Expense_Rate_Table_Data  [0..1]  Element containing all Expense Rate Table data 
Validation Description
Currency is required for Expense Rate Table with table type of Amount, Graduated Amount, or Maximum Amount. Currency is not used in Expense Rate Table with table type of Graduated Percent.  Currency is required for Expense Rate Table with table type of Amount, Graduated Amount, or Maximum Amount. Currency is not used in Expense Rate Table with table type of Graduated Percent. 
Expense Item Attribute Type is not used by Expense Rate Table with table type of Maximum.  Expense Item Attribute Type is not used by Expense Rate Table with table type of Maximum. 
This expense rate table has existing criteria. Create a new expense rate table or edit the original expense rate table if you need to change the criteria.  This expense rate table has existing criteria. Create a new expense rate table or edit the original expense rate table if you need to change the criteria. 
 
top
 

Expense_Rate_Table_Data

part of: Expense_Rate_Table
Element containing all Expense Rate Table data
 
Parameter name Type/Value Cardinality Description Validations
Expense_Rate_Table_ID  string  [0..1]  Expense Rate Table ID. This is the Expense Rate Table unique identifier   
Expense_Rate_Table_Name  string  [0..1]  Free form text for a meaningful Expense Rate Table Name   
Expense_Rate_Table_Type_Reference  Expense_Rate_Table_TypeObject  [1..1]  Reference to an existing Expense Rate Table Type. This will determine the usage of the expense rate table, as well as how it is evaluated on the calculation of the fixed/maximum amount of an expense item   
Currency_Reference  CurrencyObject  [0..1]  Reference to an existing Currency   
Expense_Item_Attribute_Type_Reference  Expense_Item_Attribute_TypeObject  [0..1]  Reference to an existing Expense Item Attribute Type. The expense item attribute will be evaluated by the range of a graduated expense rate and/or is a variable in the calculation of the fixed amount of an expense item   
Expense_Rate_Table_Effective_Date  date  [0..1]  Effective Date   
Expense_Rate_Table_Line_Replacement_Data  Expense_Rate_Table_Line_Data  [1..*]  Element containing all Expense Rate Table Line data 
Validation Description
"[rule]" is not an Expense Rate Table Rule and cannot be used on an Expense Rate Table.  Expense Rate Table specifically use Expense Rate Table Rules and not any type of Condition Rule. 
Only one criteria for each type is allowed for each expense rate table line.  Only one criteria for each type is allowed for each expense rate table line. 
Expense Rate Table with table type of Amount or Maximum can only have one Graduated Expense Rate per Expense Rate Table Line.  Expense Rate Table with table type of Amount or Maximum can only have one Graduated Expense Rate per Expense Rate Table Line. 
 
Validation Description
Currency is required for Expense Rate Table with table type of Amount, Graduated Amount, or Maximum Amount. Currency is not used in Expense Rate Table with table type of Graduated Percent.  Currency is required for Expense Rate Table with table type of Amount, Graduated Amount, or Maximum Amount. Currency is not used in Expense Rate Table with table type of Graduated Percent. 
Expense Item Attribute Type is not used by Expense Rate Table with table type of Maximum.  Expense Item Attribute Type is not used by Expense Rate Table with table type of Maximum. 
This expense rate table has existing criteria. Create a new expense rate table or edit the original expense rate table if you need to change the criteria.  This expense rate table has existing criteria. Create a new expense rate table or edit the original expense rate table if you need to change the criteria. 
top
 

Expense_Rate_Table_TypeObject

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

Expense_Rate_Table_TypeObjectID

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

Expense_Item_Attribute_TypeObject

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

Expense_Item_Attribute_TypeObjectID

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

Expense_Rate_Table_Line_Data

part of: Expense_Rate_Table_Data
Element containing all Expense Rate Table Line data
 
Parameter name Type/Value Cardinality Description Validations
Expense_Rate_Table_Rule_Reference [Choice]   Condition_RuleObject  [0..1]  Reference to an existing Expense Rate Table Rule   
Criteria_Reference [Choice]   Behavior_Spend_DataObject  [0..*]  Reference to existing Spend Data   
Graduated_Expense_Rate_Data  Graduated_Expense_Rate_Data  [1..*]  Element containing all Graduated Expense Rate data 
Validation Description
Currency is not used in Expense Rate Table with table type of Graduated Percent.  Currency is not used in Expense Rate Table with table type of Graduated Percent. 
Maximum Value is not used in Expense Rate Table with table type of Amount.  Maximum Value is not used in Expense Rate Table with table type of Amount. 
Average Value is used in Expense Rate Table with table type of Maximum.  Average Value is used in Expense Rate Table with table type of Maximum. 
Minimum Value is not used in Expense Rate Table with table type of Amount.  Minimum Value is not used in Expense Rate Table with table type of Amount. 
Expense Rate is not used in Expense Rate Table with table type of Maximum.  Expense Rate is not used in Expense Rate Table with table type of Maximum. 
Maximum Value is required for Expense Rate Table with table type Maximum or Graduated Amount  Maximum Value is required for Expense Rate Table with table type Maximum or Graduated Amount 
Expense Rate is required for Expense Rate Table with table type Amount, Graduated Amount, or Graduated Percent  Expense Rate is required for Expense Rate Table with table type Amount, Graduated Amount, or Graduated Percent 
 
Validation Description
"[rule]" is not an Expense Rate Table Rule and cannot be used on an Expense Rate Table.  Expense Rate Table specifically use Expense Rate Table Rules and not any type of Condition Rule. 
Only one criteria for each type is allowed for each expense rate table line.  Only one criteria for each type is allowed for each expense rate table line. 
Expense Rate Table with table type of Amount or Maximum can only have one Graduated Expense Rate per Expense Rate Table Line.  Expense Rate Table with table type of Amount or Maximum can only have one Graduated Expense Rate per Expense Rate Table Line. 
top
 

Condition_RuleObject

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

Condition_RuleObjectID

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

Behavior_Spend_DataObject

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

Behavior_Spend_DataObjectID

part of: Behavior_Spend_DataObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Airline_ID, Airport_ID, Applicant_ID, Car_Rental_Agency_ID, Class_of_Service_Value, Contingent_Worker_ID, Country_Region_ID, Eligibility_ID, Employee_ID, External_Committee_Member_ID, Fuel_Type_ID, Hotel_ID, Invoice_Type_ID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_Code, ISO_3166-2_Code, Spend_Data_ID, Travel_City_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
 

Graduated_Expense_Rate_Data

part of: Expense_Rate_Table_Line_Data
Element containing all Graduated Expense Rate data
 
Parameter name Type/Value Cardinality Description Validations
Minimum_Value  decimal (26, 6)   [0..1]  Minimum Amount for Maximum Expense Rate Tables or Start of Range for Graduated Amount and Percent Expense Rate Tables.   
Average_Value  decimal (18, 6) >0   [0..1]  Average Amount for Maximum Expense Rate Tables.   
Maximum_Value  decimal (26, 6)   [0..1]  Maximum Amount for Maximum Expense Rate Tables or End of Range for Graduated Amount and Percent Expense Rate Tables.   
Rate  decimal (18, 6) >0   [0..1]  Percentage for Percent Expense Rate Tables or Fixed Amount for Amount and Graduated Amount Expense Rate Tables.   
Currency_Reference  CurrencyObject  [0..1]  Reference to an existing Currency. Sets the currency of graduated expense rate.   
Validation Description
Currency is not used in Expense Rate Table with table type of Graduated Percent.  Currency is not used in Expense Rate Table with table type of Graduated Percent. 
Maximum Value is not used in Expense Rate Table with table type of Amount.  Maximum Value is not used in Expense Rate Table with table type of Amount. 
Average Value is used in Expense Rate Table with table type of Maximum.  Average Value is used in Expense Rate Table with table type of Maximum. 
Minimum Value is not used in Expense Rate Table with table type of Amount.  Minimum Value is not used in Expense Rate Table with table type of Amount. 
Expense Rate is not used in Expense Rate Table with table type of Maximum.  Expense Rate is not used in Expense Rate Table with table type of Maximum. 
Maximum Value is required for Expense Rate Table with table type Maximum or Graduated Amount  Maximum Value is required for Expense Rate Table with table type Maximum or Graduated Amount 
Expense Rate is required for Expense Rate Table with table type Amount, Graduated Amount, or Graduated Percent  Expense Rate is required for Expense Rate Table with table type Amount, Graduated Amount, or Graduated Percent 
top
 

Expense_Rate_TableReferenceEnumeration

part of: Expense_Rate_TableObjectID
Base Type
string
top
 

Expense_Rate_Table_TypeReferenceEnumeration

part of: Expense_Rate_Table_TypeObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Expense_Item_Attribute_TypeReferenceEnumeration

part of: Expense_Item_Attribute_TypeObjectID
Base Type
string
top
 

Condition_RuleReferenceEnumeration

part of: Condition_RuleObjectID
Base Type
string
top
 

Behavior_Spend_DataReferenceEnumeration

part of: Behavior_Spend_DataObjectID
Base Type
string
top