Service Directory > v31.2 > Financial_Management > Import_Currency_Conversion_Rates
 

Operation: Import_Currency_Conversion_Rates

This operation will add or update Currency Conversion Rates. Currency Conversion Rate data includes the Effective Timestamp, the From and Target Currencies, the Rate Type, and the Currency Rate. The set of Effective Timestamp, Source and Target Currencies and the Rate Type values must be unique and constitute a rate in effect at a point in time. This is a background process that will launch a job to save all rate data and will need to be monitored/checked for completion and results. As of version 28.0, Inverse rates can be created when specified in the request. As of version 30.0, cross rates can be created when specified in the request. Also introduced in v30.0 is functionality to NOT create duplicate if the input file contains duplicates and the first rate present is the rate that is retained.


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

Container that holds the add only process directive and all rates to be loaded.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Calculate_Inverse_Rate  boolean  [0..1]  Specifies whether the inverse rate of this rate should be derived from this rate.   
Calculate_Cross_Rates  boolean  [0..1]  When enabled, Workday derives cross rates using the anchor currency.   
Cross_Rates_Anchor_Currency_Reference  CurrencyObject  [0..1]  The currency Workday uses to derive the cross rate. 
Validation Description
If Calculate Cross Rates is disabled, leave the anchor currency field empty.   
If Calculate Cross Rates is enabled, select an anchor currency.   
 
Currency_Conversion_Rate_Data  Currency_Conversion_Rate__HV__Data  [0..*]  Contains the complete set of currency conversion rates to be loaded   
top
 

Response Element: Put_Import_Process_Response

Put Import Process Response element
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Import_Process_Reference  Web_Service_Background_Process_RuntimeObject  [0..1]  Web Service Background Process Runtime element   
Header_Instance_Reference  InstanceObject  [0..1]  Header Instance element   
top
 

CurrencyObject

part of: Import_Currency_Conversion_Rates_Request, Currency_Conversion_Rate__HV__Data, Currency_Conversion_Rate__HV__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
 

Currency_Conversion_Rate__HV__Data

part of: Import_Currency_Conversion_Rates_Request
Contains the complete set of currency conversion rates to be loaded
 
Parameter name Type/Value Cardinality Description Validations
Effective_Timestamp  dateTime  [1..1]  Data containing detail rate attributes.   
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   
top
 

Currency_Rate_TypeObject

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

Web_Service_Background_Process_RuntimeObject

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

Web_Service_Background_Process_RuntimeObjectID

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

InstanceObject

part of: Put_Import_Process_Response
 
Parameter name Type/Value Cardinality Description Validations
@Descriptor  string  [1..1]     
ID  Instance_ID  [0..*]     
top
 

Instance_ID

part of: InstanceObject
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@parent_id  string  [1..1]     
@parent_type  string  [1..1]     
@type  string  [1..1]     
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Currency_Rate_TypeReferenceEnumeration

part of: Currency_Rate_TypeObjectID
Base Type
string
top
 

Web_Service_Background_Process_RuntimeReferenceEnumeration

part of: Web_Service_Background_Process_RuntimeObjectID
Base Type
string
top