Service Directory > v31.2 > Financial_Management > Get_Currency_Conversion_Rates
 

Operation: Get_Currency_Conversion_Rates

This service operation will get Currency Conversion Rates for the specified criteria. Currency Conversion Rate data includes the Effective Timestamp, the From and Target Currencies, the Rate Type, and the Currency Rate. The request criteria can be for a single transaction based on Reference, or all transactions can be retrieved if no criteria is specified.


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

Contains request reference, criteria, filter and response group for getting Currency Conversion Rate data
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Currency_Conversion_Rate_Request_References  [0..1]  Get Currency Conversion Rates Request References   
Request_Criteria [Choice]   Currency_Conversion_Rate_Request_Criteria  [0..1]  Get Currency Conversion Rates Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Currency Conversion Rates Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Currency_Conversion_Rate_Response_Group  [0..1]  Get Currency Conversion Rates Response Group   
top
 

Response Element: Get_Currency_Conversion_Rates_Response

Element containing Currency Conversion Rate 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  Currency_Conversion_Rate_Request_References  [0..1]  Get Currency Conversion Rates Request References   
Request_Criteria  Currency_Conversion_Rate_Request_Criteria  [0..1]  Get Currency Conversion Rates Request Criteria   
Response_Filter  Response_Filter  [0..1]  Get Currency Conversion Rates Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Group  Currency_Conversion_Rate_Response_Group  [0..1]  Get Currency Conversion Rates Response Group   
Response_Results  Response_Results  [0..1]  Get Currency Conversion Rates Response Results   
Response_Data  Currency_Conversion_Rate_Response_Data  [0..1]  Get Currency Conversion Rates Response Data   
top
 

Currency_Conversion_Rate_Request_References

part of: Get_Currency_Conversion_Rates_Request, Get_Currency_Conversion_Rates_Response
Element containing reference instances for a Currency Conversion Rate
 
Parameter name Type/Value Cardinality Description Validations
Currency_Conversion_Rate_Reference  Currency_Conversion_RateObject  [1..*]  Reference to an existing Currency Conversion Rate   
top
 

Currency_Conversion_RateObject

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

Currency_Conversion_RateObjectID

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

Currency_Conversion_Rate_Request_Criteria

part of: Get_Currency_Conversion_Rates_Request, Get_Currency_Conversion_Rates_Response
Element containing Currency Conversion Rate request criteria
 
Parameter name Type/Value Cardinality Description Validations
Effective_Timestamp  dateTime  [1..1]  Timestamp criteria for selected currency rates   
Source_Currencies_Reference  CurrencyObject  [0..*]  The set of "From" currencies that will be checked   
Target_Currencies_Reference  CurrencyObject  [0..*]  The set of "To" currencies that will be checked   
Currency_Rate_Type_Reference  Currency_Rate_TypeObject  [0..1]  The type of currency rate selected for the set of currency rates to return   
top
 

CurrencyObject

part of: Currency_Conversion_Rate_Data, Currency_Conversion_Rate_Data, Currency_Conversion_Rate_Request_Criteria, Currency_Conversion_Rate_Request_Criteria
 
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
 

Currency_Rate_TypeObject

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

Currency_Rate_TypeObjectID

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

Response_Filter

part of: Get_Currency_Conversion_Rates_Request, Get_Currency_Conversion_Rates_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
 

Currency_Conversion_Rate_Response_Group

part of: Get_Currency_Conversion_Rates_Request, Get_Currency_Conversion_Rates_Response
Element containing Currency Conversion Rate response grouping options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Currency_Conversion_Rate_Response_Data

part of: Get_Currency_Conversion_Rates_Response
Wrapper Element that includes Currency Conversion Rate Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Currency_Conversion_Rate  Currency_Conversion_Rate  [0..*]  Element containing Currency Conversion Rate data   
top
 

Currency_Conversion_Rate

part of: Currency_Conversion_Rate_Response_Data
Wrapper Element that includes Currency Conversion Rate Instance and Data
 
Parameter name Type/Value Cardinality Description Validations
Currency_Conversion_Rate_Reference  Currency_Conversion_RateObject  [0..1]  Reference to an existing Currency Conversion Rate   
Currency_Conversion_Rate_Data  Currency_Conversion_Rate_Data  [0..*]  Currency Conversion Rate Data   
top
 

Currency_Conversion_Rate_Data

part of: Currency_Conversion_Rate
Element containing Currency Conversion Rate reference for update and all Currency Conversion Rate data items
 
Parameter name Type/Value Cardinality Description Validations
Effective_Timestamp  dateTime  [1..1]  The Effective Date must be in a date format, example: 2011-01-01, or date and time format. Example: 2011-01-01T15:30:00. A time containing seconds is valid, however, seconds are dropped when saving the time-stamp as the Effective Date precision is in minutes.   
From_Currency_Reference  CurrencyObject  [1..1]  Reference to an existing Currency Rate for the purposes of setting the conversion From Currency   
Target_Currency_Reference  CurrencyObject  [1..1]  Reference to an existing Currency Rate for the purposes of setting the conversion Target Currency   
Currency_Rate_Type_Reference  Currency_Rate_TypeObject  [1..1]  Reference to an existing Currency Rate Type   
Currency_Rate  decimal (18, 6) >0   [1..1]  Numeric attribute specifying the Currency Rate   
Calculate_Inverse_Rate  boolean  [0..1]  Specifies whether the inverse rate of this rate should be derived from this rate.   
top
 

Currency_Conversion_RateReferenceEnumeration

part of: Currency_Conversion_RateObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Currency_Rate_TypeReferenceEnumeration

part of: Currency_Rate_TypeObjectID
Base Type
string
top