Service Directory > v32.1 > Compensation > Create_Severance_Worksheet
 

Operation: Create_Severance_Worksheet

This operation allows the launching of an employee severance worksheet via the Severance Worksheet 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: Create_Severance_Worksheet_Request

Launch Employee Severance Worksheet Request
 
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.   
Employee_Severance_Worksheet_Data  Employee_Severance_Worksheet_Data  [1..1]  Employee Severance Worksheet Data 
Validation Description
Severance Package is not valid, as of effective date on the Severance Worksheet.   
Last Day Worked must be equal or earlier than Target Termination Date.   
Pay Thru Date must be equal or later than Target Termination Date.   
The Package Signed date and/or the Package declined date must be greater than or equal to the Package Delivery date: [date]   
The Package Due date must be greater than or equal to Package Delivered date: [date]   
The Revocation Cutoff Date must be greater than or equal to [date]   
This employee already has a completed severance worksheet in use. Either rescind the completed severance worksheet or clear the Send to Payroll check box on this one.   
Worker is terminated on [TerminationDate]. Please set Severance Worksheet Effective Date to this date.   
The Target Termination Date in the severance worksheet must match the Termination Date ([date]) in the termination event.   
The Last Day of Work in the severance worksheet must match the Last Day of Work ([date]) in the termination event.   
The Regrettable field in the severance worksheet must match the Regrettable field ([value]) in the termination event.   
The Reason for Termination in the severance worksheet must match the Reason for Termination ([reason]) in the termination event.   
Employee is not eligible for payments per the Severance Package and its assigned Matrices.   
 
top
 

Response Element: Create_Severance_Worksheet_Response

Launch Employee Severance Worksheet Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Employee_Severance_Worksheet_Event_Reference  Employee_Severance_Worksheet_EventObject  [0..1]  The Employee Severance Worksheet Event Reference   
top
 

Business_Process_Parameters

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

Employee_Severance_Worksheet_Data

part of: Create_Severance_Worksheet_Request
Employee Severance Worksheet Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [1..1]  Severance Worksheet Effective Date   
Severance_Package_Reference  Severance_PackageObject  [1..1]  This is the Severance Package which will be used in the Employee Severance Worksheet. Only Severance Packages with an effective date on or before the effective date of the Employee Severance Worksheet are valid.   
Employee_Reference  EmployeeObject  [1..1]  The Employee for the Severance Worksheet. The Employee must have a match in the eligibility rules defined on the Severance Matrix or Severance Notice, which have been specified on the Severance Package. Also, the Employee must be active and NOT have a Severance Worksheet in-progress or completed.   
Termination_Date  date  [1..1]  The date which the employee will be terminated.   
Last_Day_of_Work  date  [0..1]  Date of last day of work for the employee   
Pay_Through_Date  date  [0..1]  Date through which the employee will continue to be paid. Workday calculates the Pay Through Date from the severance matrix. Updating the Pay Through Date affects length of payment for severance and post-termination compensation.   
Reason_for_Severance_Reference  Event_Classification_SubcategoryObject  [1..1]  Reason for employee's severance.   
Reason_for_Termination_Reference  Event_Classification_SubcategoryObject  [0..1]  Reference for Termination Reason   
Regrettable_Reference  Common_Yes_NoObject  [0..1]  Boolean indicating if Termination of Employee is Regrettable.   
Send_to_Payroll  boolean  [0..1]  If selected, instructs Workday to use the information in the Severance Worksheet to populate the details of the employee's Termination process.   
Notified_Employee_Date  date  [0..1]  Date employee was notified of Termination and Severance Package. 
Validation Description
Select a Notified Employee date that is on or before the termination date [date].   
Select a Notified Employee date that is on or before the Notify By date: [date]   
 
Severance_Response_Due_Date  date  [0..1]  Date Response to Severance Is Due   
Worksheet_Delivered_Date  date  [0..1]  Date Severance Worksheet was delivered to employee. 
Validation Description
Select a Package Delivery date that is on or after [date], the date the Employee was notified.   
 
Worksheet_Signed_Date  date  [0..1]  Date Severance Worksheet is Signed by Employee   
Worksheet_Declined_Date  date  [0..1]  Date Severance Worksheet is Declined by Employee   
Revocation_Cutoff_Date  date  [0..1]  Last day employee has to revoke their signature on the Severance Package. 
Validation Description
Revocation Cutoff Date is only available if Signed or Declined dates are entered.   
 
Severance_Pay_Component_Data  Severance_Pay_Component_Data  [0..*]  Subedit to enter Severance Pay Component Information. Fields entered here will override default amounts. 
Validation Description
Severance Pay Component Salary Plan is allowed only when Severance Package Component Type is Entered.   
Severance Pay Component Pay Rate is allowed only when Severance Package Component Type is Entered.   
Override Pay Rate is allowed only when Severance Package Component Type is Entered.   
Only one of each Pay Component Type allowed on a Worksheet.   
Severance Pay Component Assignment Duration is allowed only when Severance Package Component Type is Entered.   
Severance Pay Component Total is allowed only when Severance Package Component Type is Entered.   
Override Duration is allowed only when Severance Package Component Type is Entered.   
Severance Pay Component Comment is allowed only when Severance Package Component Type is Entered.   
 
Severance_Package_Component_Data  Severance_Package_Component_Data  [0..*]  Subelement for entering a severance component type along with eligibility and a comment 
Validation Description
Only allowed if Component type entered   
Only allowed if Component type entered   
Select a different Severance Component Type. Only one of each type allowed per worksheet.   
 
Pay_Range_Currency_Reference  CurrencyObject  [0..1]  Currency used for amounts on pay component subedits.   
Validation Description
Severance Package is not valid, as of effective date on the Severance Worksheet.   
Last Day Worked must be equal or earlier than Target Termination Date.   
Pay Thru Date must be equal or later than Target Termination Date.   
The Package Signed date and/or the Package declined date must be greater than or equal to the Package Delivery date: [date]   
The Package Due date must be greater than or equal to Package Delivered date: [date]   
The Revocation Cutoff Date must be greater than or equal to [date]   
This employee already has a completed severance worksheet in use. Either rescind the completed severance worksheet or clear the Send to Payroll check box on this one.   
Worker is terminated on [TerminationDate]. Please set Severance Worksheet Effective Date to this date.   
The Target Termination Date in the severance worksheet must match the Termination Date ([date]) in the termination event.   
The Last Day of Work in the severance worksheet must match the Last Day of Work ([date]) in the termination event.   
The Regrettable field in the severance worksheet must match the Regrettable field ([value]) in the termination event.   
The Reason for Termination in the severance worksheet must match the Reason for Termination ([reason]) in the termination event.   
Employee is not eligible for payments per the Severance Package and its assigned Matrices.   
top
 

Severance_PackageObject

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

Severance_PackageObjectID

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

EmployeeObject

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

Event_Classification_SubcategoryObject

part of: Employee_Severance_Worksheet_Data, Employee_Severance_Worksheet_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
 

Common_Yes_NoObject

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

Common_Yes_NoObjectID

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

Severance_Pay_Component_Data

part of: Employee_Severance_Worksheet_Data
Subedit to enter Severance Pay Component Information. Fields entered here will override default amounts.
 
Parameter name Type/Value Cardinality Description Validations
Severance_Package_Component_Type_Reference  Severance_Package_Component_TypeObject  [0..1]  Reference for a Severance Package Component Type. 
Validation Description
Currently only support Bonus Payout, In Lieu of Notice Pay, Ongoing Severance Pay, and Severance Payout   
Only valid components defined on package should be added.   
 
Duration  decimal (20, 0) >0   [0..1]  Number of weeks for the assignment of the severance pay component 
Validation Description
[ongoing severance duration limits validation text]   
Duration only enterable if type is Ongoing Severance Pay and Override Duration is True   
 
Override_Duration  boolean  [0..1]  Boolean to indicate if you want override the duration amount or use the default duration instead based on the package 
Validation Description
Override Duration only applicable if type is Ongoing Severance Pay   
 
Pay_Rate  decimal (26, 6)   [0..1]  An amount to be paid weekly for ongoing severance. 
Validation Description
Pay Rate only enterable if Type is Ongoing Severance Pay and a Salary Plan from Severance Package is entered and Override Pay Rate is True.   
For Ongoing Severance, the Pay Rate cannot be set to 0 if Override is set to Yes. To calculate an Ongoing Severance Pay with a Total of 0 override the Duration to be 0.   
 
Override_Pay_Rate  boolean  [0..1]  Boolean to indicate if you want to override the pay rate amount or use the default amount instead 
Validation Description
Cannot set Override Pay Rate to True if No Salary Plan is selected.   
Pay Rate is Blank is only applicable if Type is Ongoing Severance Pay   
 
Total  decimal (26, 6)   [0..1]  Total Amount for a Severance Pay Component. 
Validation Description
Pay Component Type must be either Bonus Payout, In Lieu of Notice Pay, or Severance Payout   
 
Severance_Salary_Plan_Reference  Salary_PlanObject  [0..1]  Reference to a salary plan used for Ongoing Severance Pay. 
Validation Description
Only Valid if type is Ongoing Severance pay and Plan is in Package   
 
Severance_Component_Comment  string  [0..1]  Comment for a Severance Pay Component.   
Currency_Reference  CurrencyObject  [0..1]  Currency used for amounts on pay component subedits.   
Validation Description
Severance Pay Component Salary Plan is allowed only when Severance Package Component Type is Entered.   
Severance Pay Component Pay Rate is allowed only when Severance Package Component Type is Entered.   
Override Pay Rate is allowed only when Severance Package Component Type is Entered.   
Only one of each Pay Component Type allowed on a Worksheet.   
Severance Pay Component Assignment Duration is allowed only when Severance Package Component Type is Entered.   
Severance Pay Component Total is allowed only when Severance Package Component Type is Entered.   
Override Duration is allowed only when Severance Package Component Type is Entered.   
Severance Pay Component Comment is allowed only when Severance Package Component Type is Entered.   
top
 

Severance_Package_Component_TypeObject

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

Severance_Package_Component_TypeObjectID

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

Salary_PlanObject

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

Salary_PlanObjectID

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

Severance_Package_Component_Data

part of: Employee_Severance_Worksheet_Data
Element to input data for a severance package component on a worksheet. Fields for a component type, eligibility, and comment
 
Parameter name Type/Value Cardinality Description Validations
Severance_Package_Component_Type_Reference  Severance_Package_Component_TypeObject  [0..1]  Reference to a severance package component type. The component type must be included in the selected severance package. 
Validation Description
Only valid components defined on package should be added.   
 
Eligible  boolean  [0..1]  Boolean indicating if employee is eligible for component or not.   
Comments  string  [0..1]  Comment to attach to severance package component for employee.   
Validation Description
Only allowed if Component type entered   
Only allowed if Component type entered   
Select a different Severance Component Type. Only one of each type allowed per worksheet.   
top
 

Employee_Severance_Worksheet_EventObject

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

Employee_Severance_Worksheet_EventObjectID

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Event_Attachment_CategoryReferenceEnumeration

part of: Event_Attachment_CategoryObjectID
Base Type
string
top
 

Severance_PackageReferenceEnumeration

part of: Severance_PackageObjectID
Base Type
string
top
 

EmployeeReferenceEnumeration

part of: EmployeeObjectID
Base Type
string
top
 

Event_Classification_SubcategoryReferenceEnumeration

part of: Event_Classification_SubcategoryObjectID
Base Type
string
top
 

Common_Yes_NoReferenceEnumeration

part of: Common_Yes_NoObjectID
Base Type
string
top
 

Severance_Package_Component_TypeReferenceEnumeration

part of: Severance_Package_Component_TypeObjectID
Base Type
string
top
 

Salary_PlanReferenceEnumeration

part of: Salary_PlanObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

Employee_Severance_Worksheet_EventReferenceEnumeration

part of: Employee_Severance_Worksheet_EventObjectID
Base Type
string
top