Service Directory > v31.2 > Compensation > Request_One-Time_Payment
 

Operation: Request_One-Time_Payment

This operation allows the requesting of a one-time payment for an employee via the Request One-Time Payment business process.


@ - 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: Request_One-Time_Payment_Request

This web service operation is designed to pay an employee a one-time payment such as a signing bonus using the Request One-Time Payment business process.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Business_Process_Parameters  Business_Process_Parameters  [0..1]  Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.   
One-Time_Payment_Data  Request_One-Time_Payment_Data  [1..1]  Wrapper element for the Request One-Time Payment business process. 
Validation Description
Multiple One-Time Payment is not enabled. Please enable Multiple One-Time Payment in HCM Tenant Setup - Compensation.   
 
top
 

Response Element: Request_One-Time_Payment_Response

Response element containing the reference for the one time payment.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
One-Time_Payment_Event_Reference  Unique_IdentifierObject  [0..1]  Event ID of the Request One-Time Payment Event.   
top
 

Business_Process_Parameters

part of: Request_One-Time_Payment_Request
Container for the processing options for a business process. If no options are submitted (or the options are submitted as 'false') then the business process is simply initiated as if it where submitted on-line with approvals, reviews, notifications and to-do's in place. If the Initiator is an Integration System User, any validations you configured on the Initiation step are ignored.
 
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.   
Run_Now  boolean  [0..1]  Indicates the transaction should process to completion before the response is generated. Note: All < v12 operations will process with Run_Now = True for backwards compatibility but please review this setting in your environment for performance conditions.   
Comment_Data  Business_Process_Comment_Data  [0..1]  Captures a comment for the Business Process.   
Business_Process_Attachment_Data  Business_Process_Attachment_Data  [0..*]  Element for the attachments pertaining to a Event entered through a web service. 
Validation Description
This Business Process Type has been configured to not accept Event Attachments.   
 
top
 

Business_Process_Comment_Data

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

Business_Process_Attachment_Data

part of: Business_Process_Parameters
Element for the attachments pertaining to a Event entered through a web service.
 
Parameter name Type/Value Cardinality Description Validations
File_Name  string (255)   [1..1]  Filename for the attachment.   
Event_Attachment_Description  string  [0..1]  Free form text comment about the attachment.   
Event_Attachment_Category_Reference  Event_Attachment_CategoryObject  [0..1]  Category of attachment. 
Validation Description
This Business Process Type has been configured to not accept Attachment Categories.   
 
File  base64Binary  [0..1]  Binary file contents.   
Content_Type  string (80)   [0..1]  Text attribute identifying Content Type of the Attachment.   
top
 

Event_Attachment_CategoryObject

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

Event_Attachment_CategoryObjectID

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

Request_One-Time_Payment_Data

part of: Request_One-Time_Payment_Request
Wrapper element for the Request One-Time Payment business process.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  EmployeeObject  [1..1]  Employee to receive the one-time payment.   
Position_Reference  Position_ElementObject  [0..1]  Employee's current position. Used in multiple-job scenarios. 
Validation Description
Position submitted is not filled as of the effective date.   
The employee you have selected has more than one job. You must supply the job to which this operation applies.   
The job is not valid for the employee.   
 
Effective_Date  date  [1..1]  Date the one-time payment for the employee is effective. 
Validation Description
Compensation Change cannot take place before Employee Hire Date.   
 
Employee_Visibility_Date  date  [0..1]  Date the employee can view the one-time payment event. Employee Visibility Date must be enabled in the HCM tenant settings. 
Validation Description
The Employee Visibility Date must be on or after the Effective Date.   
The Employee Visibility Date has been set to a value, but the Employee Visibility Feature has not been activated in the HCM Tenant settings. Please leave the date blank or activate the feature in the tenant level settings.   
 
Reason_Reference  Event_Classification_SubcategoryObject  [0..1]  Reason for the one-time payment. Use format: General_Event_Subcategory_ID.   
One-Time_Payment_Sub_Data  One-Time_Payment_Data  [1..*]  One-Time Payment Sub Data 
Validation Description
Scheduled Payment Date cannot take place before the Effective Date.   
The coverage period End Date must be on or after Start Date.   
Coverage Start Date and Coverage End Date can not be entered for a One-Time Payment Plan that does not have Coverage Dates enabled.   
If specifying a Coverage Date range, then both dates must be specified.   
Scheduled Payment Date must be equal to Event Effective Date when Multiple One-Time Payment is not enabled in Edit Tenant Setup - HCM.   
 
Validation Description
Multiple One-Time Payment is not enabled. Please enable Multiple One-Time Payment in HCM Tenant Setup - Compensation.   
top
 

EmployeeObject

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

EmployeeObjectID

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

Position_ElementObject

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

Position_ElementObjectID

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

Event_Classification_SubcategoryObject

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

Event_Classification_SubcategoryObjectID

part of: Event_Classification_SubcategoryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Benefits_Event_Subcategory_ID, Change_Job_Subcategory_ID, End_Additional_Job_Subcategory_ID, Event_Classification_Subcategory_ID, General_Event_Subcategory_ID, Leave_of_Absence_Type_ID, Termination_Subcategory_ID, Undo_Move_Subcategory_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
 

One-Time_Payment_Data

part of: Request_One-Time_Payment_Data
Data Element that contains the one-time payment information.
 
Parameter name Type/Value Cardinality Description Validations
One_Time_Payment_Plan_Reference  One-Time_Payment_PlanObject  [1..1]  One-time payment plan for the one-time payment. If Multiple One-Time Payments is enabled on the Edit Tenant Setup - HCM task, there can be multiple plans.   
Scheduled_Payment_Date  date  [0..1]  Date the employee will receive the one-time payment. Workday defaults the effective date if a Scheduled Payment Date is not provided. Multiple One-Time Payments must be enabled on the Edit Tenant Setup - HCM task.   
Coverage_Start_Date  date  [0..1]  Start date of the period a FLSA-eligible wage increase applies.   
Coverage_End_Date  date  [0..1]  End date of the period a FLSA-eligible wage increase applies.   
Amount [Choice]   decimal (26, 6)   [0..1]  Amount of the one time payment. Decimal precision of the amount must match the currency. This is mutually exclusive with the percent.   
Percent [Choice]   decimal (18, 6)   [0..1]  Percent of the calculation basis defined on the one-time payment plan. Workday calculates the amount based on this percent. This is mutually exclusive with the amount.   
Currency_Reference  CurrencyObject  [0..1]  Currency for the one-time payment. Defaults to the one-time payment plan currency default if not provided.   
Comment  string  [0..1]  Comment for the one-time payment.   
Do_Not_Pay  boolean  [0..1]  If True, Workday Payroll doesn't process this one-time payment.   
One_Time_Payment_Worktags_Reference  Tenanted_Payroll_WorktagObject  [0..*]  The worktags associated with this one-time payment. If provided, the worktag type must match that of the Worktag Balancing Configuration unless the employee has that organizational assignment. 
Validation Description
Based on the worktag type configuration following worktag types are not valid for taggable type [tt]: [awt]. Please remove all worktags for the invalid worktag types.   
The following Accounting Worktags are required but have not been assigned: [missing].   
Only one worktag for each type is allowed for each document line.   
Select a balancing worktag for Worktags of the following type: [type]   
 
Validation Description
Scheduled Payment Date cannot take place before the Effective Date.   
The coverage period End Date must be on or after Start Date.   
Coverage Start Date and Coverage End Date can not be entered for a One-Time Payment Plan that does not have Coverage Dates enabled.   
If specifying a Coverage Date range, then both dates must be specified.   
Scheduled Payment Date must be equal to Event Effective Date when Multiple One-Time Payment is not enabled in Edit Tenant Setup - HCM.   
top
 

One-Time_Payment_PlanObject

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

One-Time_Payment_PlanObjectID

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

CurrencyObject

part of: One-Time_Payment_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
 

Tenanted_Payroll_WorktagObject

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

Tenanted_Payroll_WorktagObjectID

part of: Tenanted_Payroll_WorktagObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Business_Unit_ID, Company_Reference_ID, Contingent_Worker_ID, Cost_Center_Reference_ID, Custom_Organization_Reference_ID, Custom_Worktag_06_ID, Custom_Worktag_07_ID, Custom_Worktag_08_ID, Custom_Worktag_09_ID, Custom_Worktag_1_ID, Custom_Worktag_10_ID, Custom_Worktag_11_ID, Custom_Worktag_12_ID, Custom_Worktag_13_ID, Custom_Worktag_14_ID, Custom_Worktag_15_ID, Custom_Worktag_2_ID, Custom_Worktag_3_ID, Custom_Worktag_4_ID, Custom_Worktag_5_ID, Employee_ID, FLSA_Workweek_Calendar_Event_ID, Fund_ID, Gift_Reference_ID, Grant_ID, Holiday_Calendar_Event_ID, Job_Profile_ID, Location_ID, Object_Class_ID, Organization_Reference_ID, Payroll_ID, Position_ID, Program_ID, Project_ID, Project_Plan_ID, Region_Reference_ID, Run_Category_ID, Withholding_Order_Case_ID, Workers_Compensation_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".   
@parent_id  string  [1..1]  Contains a unique identifier for an instance of a parent object   
@parent_type  WID, FLSA_Workweek_Calendar_ID, Holiday_Calendar_ID  [1..1]  The unique identifier type of a parent object   
top
 

Unique_IdentifierObject

part of: Request_One-Time_Payment_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
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Event_Classification_SubcategoryReferenceEnumeration

part of: Event_Classification_SubcategoryObjectID
Base Type
string
top
 

One-Time_Payment_PlanReferenceEnumeration

part of: One-Time_Payment_PlanObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Tenanted_Payroll_WorktagReferenceEnumeration

part of: Tenanted_Payroll_WorktagObjectID
Base Type
string
top
 

Base Type
string

top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top