Service Directory > v32.1 > Cash_Management > Get_Payment_Election_Options
 

Operation: Get_Payment_Election_Options

Web service to get the Payment Election Options by Reference IDs, or returns all Payment Election Options if no Reference ID is provided. 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: Get_Payment_Election_Options_Request

Get Payment Election Options Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payment_Election_Option_Request_References  [0..1]  Get Payment Election Option Request References   
Request_Criteria [Choice]   Payment_Election_Option_Request_Criteria  [0..1]  Get Payment Election Option 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  Payment_Election_Option_Response_Group  [0..1]  Get Payment Election Option Request Group   
top
 

Response Element: Get_Payment_Election_Options_Response

Get Payment Election Options Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payment_Election_Option_Request_References  [0..1]  Payment Election Option Request Reference   
Request_Criteria  Payment_Election_Option_Request_Criteria  [0..1]  Payment Election Option 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  Payment_Election_Option_Response_Group  [0..1]  Payment Election Option Response Group   
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  Payment_Election_Option_Response_Data  [0..1]  Get Payment Election Options Response   
top
 

Payment_Election_Option_Request_References

part of: Get_Payment_Election_Options_Request, Get_Payment_Election_Options_Response
Payment Election Option Request Reference
 
Parameter name Type/Value Cardinality Description Validations
Payment_Election_Option_Reference  Payment_Election_OptionObject  [1..*]  Payment Election Option References   
top
 

Payment_Election_OptionObject

part of: Payment_Election_Option_Request_References, Payment_Election_Option
 
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_Request_Criteria

part of: Get_Payment_Election_Options_Request, Get_Payment_Election_Options_Response
Payment Election Option Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Payment_Election_Options_Request, Get_Payment_Election_Options_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
 

Payment_Election_Option_Response_Group

part of: Get_Payment_Election_Options_Request, Get_Payment_Election_Options_Response
Payment Election Option Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Payment_Election_Option_Response_Data

part of: Get_Payment_Election_Options_Response
Get Payment Election Options Response
 
Parameter name Type/Value Cardinality Description Validations
Payment_Election_Option  Payment_Election_Option  [0..*]  Container element for Payment Election Options   
top
 

Payment_Election_Option

part of: Payment_Election_Option_Response_Data
Get Payment Election Options Response
 
Parameter name Type/Value Cardinality Description Validations
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..*]  Container element for Payment Election Options 
Validation Description
This role is not eligible for Payment Election Options.   
 
top
 

Payment_Election_Option_Data

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