Service Directory > v32.1 > Cash_Management > Put_Payment_Election_Option
 

Operation: Put_Payment_Election_Option

Web service to create a new Payment Election Option or updates an existing Payment Election Option by Reference ID. Includes country and currency overrides for each payment election rule.


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

Submit Payment Election Option Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Add_Only  boolean  [1..1]  Add Only   
Payment_Election_Option_Reference  Payment_Election_OptionObject  [0..1]  Reference to an unique Payment Election Option   
Payment_Election_Option_Data  Payment_Election_Option_Data  [0..1]  Container element for Payment Election Options 
Validation Description
This role is not eligible for Payment Election Options.   
 
Validation Description
The Web Service is set to Add Only; Payment Election Option for this role cannot be resubmitted.   
top
 

Response Element: Put_Payment_Election_Option_Response

Payment Election Option References
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payment_Election_Option_Reference  Payment_Election_OptionObject  [0..1]  Payment Election Option References   
top
 

Payment_Election_OptionObject

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

Payment_Election_OptionObjectID

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

Payment_Election_Option_Data

part of: Put_Payment_Election_Option_Request
Container element for Payment Election Options
 
Parameter name Type/Value Cardinality Description Validations
Role_Reference  Payment_Election_EnrollableObject  [1..1]  Role Reference will identify for whom the payment election is created for as well as what role. The ID consists of a type attribute, which should be set to "Employee_ID", "Contingent_Worker_ID", or "Student_ID", and a value attribute, such as "04345”.   
Default_Country_Reference  CountryObject  [0..1]  Country Reference is a unique reference to a Country   
Default_Currency_Reference  CurrencyObject  [0..1]  Currency Reference is a unique reference to a Currency   
Pay_Type_Payment_Election_Option_Data  Pay_Type_Payment_Election_Option_Data  [0..*]  Container element for Pay Type Payment Election Option 
Validation Description
This role is not eligible for [payment election rule].   
 
Validation Description
This role is not eligible for Payment Election Options.   
top
 

Payment_Election_EnrollableObject

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

Payment_Election_EnrollableObjectID

part of: Payment_Election_EnrollableObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Academic_Affiliate_ID, Academic_Person_ID, Applicant_ID, Contingent_Worker_ID, Employee_ID, External_Committee_Member_ID, Student_ID, Student_Proxy_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
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_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
 

CurrencyObject

part of: Payment_Election_Option_Data, Pay_Type_Payment_Election_Option_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  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
 

Pay_Type_Payment_Election_Option_Data

part of: Payment_Election_Option_Data
Container element for Pay Type Payment Election Option
 
Parameter name Type/Value Cardinality Description Validations
Payment_Election_Rule_Reference  Payment_Election_RuleObject  [1..1]  Unique reference to Payment Election Rule   
Pay_Type_Payment_Election_Option_Line_Replacement_Data  Pay_Type_Payment_Election_Option_Line_Data  [0..*]  Container element for Pay Type Payment Election Option Line   
Validation Description
This role is not eligible for [payment election rule].   
top
 

Payment_Election_RuleObject

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

Payment_Election_RuleObjectID

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

Pay_Type_Payment_Election_Option_Line_Data

part of: Pay_Type_Payment_Election_Option_Data
Container element for Pay Type Payment Election Option Line
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [1..1]  Country Reference is a unique reference to a Country   
Currency_Reference  CurrencyObject  [1..1]  Currency Reference is a unique reference to a Currency   
Payment_Type_Reference  Payment_TypeObject  [1..*]  Reference to an existing Payment Type 
Validation Description
The pay type is not valid for this payment election rule.   
 
top
 

Payment_TypeObject

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

Payment_TypeObjectID

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

Payment_Election_OptionReferenceEnumeration

part of: Payment_Election_OptionObjectID
Base Type
string
top
 

Payment_Election_EnrollableReferenceEnumeration

part of: Payment_Election_EnrollableObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Payment_Election_RuleReferenceEnumeration

part of: Payment_Election_RuleObjectID
Base Type
string
top
 

Payment_TypeReferenceEnumeration

part of: Payment_TypeObjectID
Base Type
string
top