Service Directory > v32.1 > Cash_Management > Submit_Payment_Election_Enrollment
 

Operation: Submit_Payment_Election_Enrollment

Replaces current payment elections with new elections.


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

Submit Payment Election Enrollment Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
@Retain_Unused_Worker_Bank_Accounts  boolean  [1..1]  While True, the request will not remove any existing and unused Worker Bank Accounts in the most recently Completed Enrollment (not including In-Progress Enrollments). If the Worker Bank Account is currently used but is not referenced in the incoming request, then the Worker Bank Account will be removed regardless of this attribute. While False, the request will remove all Worker Bank Accounts not assigned to a Payment Election.   
Business_Process_Parameters  Financials_Business_Process_Parameters  [0..1]  Contains data for business processing   
Payment_Election_Enrollment_Data  Payment_Election_Enrollment_for_Worker_Data  [0..1]  Container element for Payment Election Enrollments 
Validation Description
Critical Custom Validations Exist   
Validation Description
Multiple elections groups for the same election rule found.   
[payment election rule] is not a valid Payment Election Rule for the targeted user.   
 
top
 

Response Element: Put_Payment_Election_Enrollment_Response

Put Payment Election Enrollment Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payment_Election_Enrollment_Reference  Unique_IdentifierObject  [0..1]  Reference to the Payment Election Enrollment that was submitted.   
Exceptions_Response_Data  Application_Instance_Related_Exceptions_Data  [0..*]  Exceptions Response Data   
top
 

Financials_Business_Process_Parameters

part of: Submit_Payment_Election_Enrollment_Request
Contains data for business processing
 
Parameter name Type/Value Cardinality Description Validations
Auto_Complete  boolean  [0..1]  When set to "true" or "1", the business process is automatically processed. This means that all approvals will be automatically approved in the system, all reviews and to-do's will be automatically by-passed, and all notifications will be automatically suppressed.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures the Comment for the Business Process.   
top
 

Business_Process_Comment_Data

part of: Financials_Business_Process_Parameters
Captures a comment for the Business Process.
 
Parameter name Type/Value Cardinality Description Validations
Comment  string  [0..1]  Free form comment regarding the business process. 
Validation Description
This Business Process has been configured to disable comment. Please remove the comment or change the setting in the Business Process Policy or tenant setup.   
 
Worker_Reference  WorkerObject  [0..1]  Default the Person making the comment to the processing person if not submitted via the web service.   
top
 

WorkerObject

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

WorkerObjectID

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

part of: Submit_Payment_Election_Enrollment_Request
Container element for Payment Election Enrollments
 
Parameter name Type/Value Cardinality Description Validations
Role_ID_Reference  Payment_Election_EnrollableObject  [1..1]  Role ID 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”.   
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_Election_Rule_Group_Data  Payment_Election_Rule_Group_Data  [0..*]  Container element for Payment Election Rule 
Validation Description
You have exceeded the allowed number of elections for this pay type.   
Mixture of Payment Types not allowed for this payment rule.   
You may only have one election with payment type of Check.   
Payment Order must be sequential. ex. 1, 2, 3, etc.   
Only one election can have a balance distribution.   
The sum of the elections being distributed via percentage exceeds 100%.   
A specific Account can only be used in one election for each election rule   
You have a receivable balance due to a negative reimbursable expense report. Please pay the balance before changing the reimbursement currency.   
You must select the Balance option for the last election or the percentages must add up to 100%.   
 
Validation Description
Multiple elections groups for the same election rule found.   
[payment election rule] is not a valid Payment Election Rule for the targeted user.   
top
 

Payment_Election_EnrollableObject

part of: Payment_Election_Enrollment_for_Worker_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_Data, Payment_Election_Enrollment_for_Worker_Data, Worker_Bank_Account_WWS_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_Data, Payment_Election_Enrollment_for_Worker_Data, Worker_Bank_Account_WWS_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
 

Payment_Election_Rule_Group_Data

part of: Payment_Election_Enrollment_for_Worker_Data
Container element for Payment Election Rule
 
Parameter name Type/Value Cardinality Description Validations
Payment_Election_Rule_Reference  Payment_Election_RuleObject  [1..1]  Unique reference to Payment Election Rule   
Payment_Election_Data  Payment_Election_Data  [1..*]  Container element for each Payment Election 
Validation Description
Enter the value as a decimal. For example, 75% would be entered as 0.75.   
This Payment Election Rule does not allow Percentage Distributions.   
This Payment Election Rule does not allow Amount Distributions.   
The Payment Type used is not allowed for this Payment Election Rule.   
Worker Bank Account Data is required.   
Two different Payment Election Rules cannot be defined for a single Payment Election.   
[payment election rule] is not a valid Payment Election Rule for the targeted user.   
 
Validation Description
You have exceeded the allowed number of elections for this pay type.   
Mixture of Payment Types not allowed for this payment rule.   
You may only have one election with payment type of Check.   
Payment Order must be sequential. ex. 1, 2, 3, etc.   
Only one election can have a balance distribution.   
The sum of the elections being distributed via percentage exceeds 100%.   
A specific Account can only be used in one election for each election rule   
You have a receivable balance due to a negative reimbursable expense report. Please pay the balance before changing the reimbursement currency.   
You must select the Balance option for the last election or the percentages must add up to 100%.   
top
 

Payment_Election_RuleObject

part of: Payment_Election_Data, Payment_Election_Rule_Group_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
 

Payment_Election_Data

part of: Payment_Election_Rule_Group_Data
Container element for each Payment Election
 
Parameter name Type/Value Cardinality Description Validations
Order  decimal (6, 0) >0   [1..1]  Order Priority   
Payment_Election_Rule_Reference  Payment_Election_RuleObject  [1..1]  Unique reference to Payment Election Rule   
Country_Reference  CountryObject  [1..1]  The Country for the Payment Election   
Currency_Reference  CurrencyObject  [1..1]  The Currency for the Payment Election   
Payment_Type_Reference  Payment_TypeObject  [1..1]  Unique reference to Payment Type   
Worker_Bank_Account_Data  Worker_Bank_Account_WWS_Data  [0..1]  Container element for Bank Account information 
Validation Description
Invalid IBAN number.   
Bank Format Error: [error_msg]   
Bank Account Format Error: [error_msg]   
Branch ID Format Error: [error_msg]   
Invalid Account Type. Valid Values are: SA for Savings DDA for Checking   
IBAN is required for this country.   
Routing Transit or Institution Number is required for this country.   
Financial Account Number is required for this country.   
Roll number is required for this country.   
Check Digit is required for this country.   
Bank Account Name is required for this country.   
Branch name is required for this country.   
Branch ID is required for this country.   
Country field is required for this bank account   
SWIFT BIC is required for this Country   
[digit_format_error_msg]   
Either Account Type Code or Account Type Reference should be provided, but not both.   
The check sum validation failed for the entered Routing Transit Number. Please verify it against the Routing Transit Number provided by your financial institution.   
Bank Name is required for this Country   
Bank Format Error: [error_msg]   
Bank Account Type is required.   
 
Distribution_Amount [Choice]   decimal (26, 6) >0   [1..1]  Distribution Amount   
Distribution_Percentage [Choice]   decimal (9, 6) >0   [1..1]  Distribution Percentage   
Distribution_Balance [Choice]   boolean  [1..1]  Boolean signifying whether the Balance should be used for this Payment election.   
Validation Description
Enter the value as a decimal. For example, 75% would be entered as 0.75.   
This Payment Election Rule does not allow Percentage Distributions.   
This Payment Election Rule does not allow Amount Distributions.   
The Payment Type used is not allowed for this Payment Election Rule.   
Worker Bank Account Data is required.   
Two different Payment Election Rules cannot be defined for a single Payment Election.   
[payment election rule] is not a valid Payment Election Rule for the targeted user.   
top
 

Payment_TypeObject

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

Worker_Bank_Account_WWS_Data

part of: Payment_Election_Data
Container element for Bank Account information
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [0..1]  Country Reference is a unique reference to a Country   
Currency_Reference  CurrencyObject  [0..1]  Currency Reference is a unique reference to a Currency   
Bank_Account_Nickname  string  [0..1]  Bank Account Nickname   
Bank_Account_Name  string  [0..1]  Name on the actual Bank Account   
Account_Number  string  [0..1]  Bank Account Number   
Roll_Number  string  [0..1]  In the UK Building Societies use roll numbers instead of (or, these days, sometimes as well as) an account number. It signifies your entry on the "roll of members".   
Account_Type_Code  string  [0..1]  The Account Type Code for this bank account. Valid Values are: SA for Savings DDA for Checking   
Account_Type_Reference  Bank_Account_TypeObject  [0..1]  Reference to the Account Type. Valid reference ID values are SA for Savings, or DDA for Checking.   
Bank_Name  string  [0..1]  Bank Name   
IBAN  string  [0..1]  International Bank Account Number (IBAN)   
Bank_ID_Number  string  [0..1]  Bank ID Number   
BIC  string  [0..1]  Society for Worldwide Interbank Financial Telecommunication (SWIFT) Bank Identification Code (BIC) 
Validation Description
Bank Identification Code (BIC) standard format can be between 8 to 11 characters. Generally, it should not be less than 8 characters or exceed 11 characters.   
Bank Identification Code (BIC) standard format can be between 8 to 11 characters. Generally, it should not be less than 8 characters or exceed 11 characters.   
The Bank Identification Code (BIC) entry is not following a standard format. Please refer to SWIFT guidelines for the format details.   
 
Branch_Name  string  [0..1]  Branch Name   
Branch_ID_Number  string  [0..1]  Branch ID   
Check_Digit  string  [0..1]  Collects the check digit when it is not part of the bank id number   
Validation Description
Invalid IBAN number.   
Bank Format Error: [error_msg]   
Bank Account Format Error: [error_msg]   
Branch ID Format Error: [error_msg]   
Invalid Account Type. Valid Values are: SA for Savings DDA for Checking   
IBAN is required for this country.   
Routing Transit or Institution Number is required for this country.   
Financial Account Number is required for this country.   
Roll number is required for this country.   
Check Digit is required for this country.   
Bank Account Name is required for this country.   
Branch name is required for this country.   
Branch ID is required for this country.   
Country field is required for this bank account   
SWIFT BIC is required for this Country   
[digit_format_error_msg]   
Either Account Type Code or Account Type Reference should be provided, but not both.   
The check sum validation failed for the entered Routing Transit Number. Please verify it against the Routing Transit Number provided by your financial institution.   
Bank Name is required for this Country   
Bank Format Error: [error_msg]   
Bank Account Type is required.   
top
 

Bank_Account_TypeObject

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

Bank_Account_TypeObjectID

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

Unique_IdentifierObject

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

Unique_IdentifierObjectID

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

Application_Instance_Related_Exceptions_Data

part of: Put_Payment_Election_Enrollment_Response
Element containing Exceptions Data
 
Parameter name Type/Value Cardinality Description Validations
Exceptions_Data  Application_Instance_Exceptions_Data  [0..*]  Exceptions Data   
top
 

Application_Instance_Exceptions_Data

part of: Application_Instance_Related_Exceptions_Data
Element containing application related exceptions data
 
Parameter name Type/Value Cardinality Description Validations
Exception_Data  Exception_Data  [0..*]  Exception Data   
top
 

Exception_Data

part of: Application_Instance_Exceptions_Data
Exception (Errors and Warning) associated with the transaction.
 
Parameter name Type/Value Cardinality Description Validations
Classification  string  [0..1]  Exception Classification (Error or Warning)   
Message  string  [0..1]  Exception Detail   
top
 

WorkerReferenceEnumeration

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

Bank_Account_TypeReferenceEnumeration

part of: Bank_Account_TypeObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top