Service Directory > v32.1 > Compensation > Retrieve_Severance_Worksheet
 

Operation: Retrieve_Severance_Worksheet

Returns an Employee Severance Worksheet


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

Request for getting back Employee Severance Worksheets
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Employee_Severance_Worksheet_Event_Request_References  [0..1]  Reference for Employee Severance Worksheet that you want returned.   
Request_Criteria [Choice]   Employee_Severance_Worksheet_Event_Request_Criteria  [0..1]  Request criteria to filter Employee Severance Worksheets returned   
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  Employee_Severance_Worksheet_Event_Response_Group  [0..1]  Response group for Employee Severance Worksheet Event.   
top
 

Response Element: Retrieve_Severance_Worksheets_Response

Response element for Retrieve Employee Severance Worksheet Events
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Employee_Severance_Worksheet_Event_Request_References  [0..1]  Reference for Employee Severance Worksheet Event   
Request_Criteria  Employee_Severance_Worksheet_Event_Request_Criteria  [0..1]  Request Criteria to filter Employee Severance Worksheet Event results   
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  Employee_Severance_Worksheet_Event_Response_Group  [0..1]  Response Group for Employee Severance Worksheet Event   
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  Employee_Severance_Worksheet_Event_Response_Data  [0..1]  Response element for Retrieve Employee Severance Worksheet Events   
top
 

Employee_Severance_Worksheet_Event_Request_References

part of: Retrieve_Severance_Worksheets_Request, Retrieve_Severance_Worksheets_Response
Reference for Employee Severance Worksheet Event
 
Parameter name Type/Value Cardinality Description Validations
Employee_Severance_Worksheet_Event_Reference  Employee_Severance_Worksheet_EventObject  [1..*]  Reference for Employee Severance Worksheet Event   
top
 

Employee_Severance_Worksheet_EventObject

part of: Employee_Severance_Worksheet_Event_Request_References, Employee_Severance_Worksheet_Event
 
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
 

Employee_Severance_Worksheet_Event_Request_Criteria

part of: Retrieve_Severance_Worksheets_Request, Retrieve_Severance_Worksheets_Response
Request Criteria to filter Employee Severance Worksheet Event results
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Retrieve_Severance_Worksheets_Request, Retrieve_Severance_Worksheets_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
 

Employee_Severance_Worksheet_Event_Response_Group

part of: Retrieve_Severance_Worksheets_Request, Retrieve_Severance_Worksheets_Response
Response Group for Employee Severance Worksheet Event
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Boolean to determine if to include reference to Employee Severance Worksheet Event   
top
 

Response_Results

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

Employee_Severance_Worksheet_Event_Response_Data

part of: Retrieve_Severance_Worksheets_Response
Response element for Retrieve Employee Severance Worksheet Events
 
Parameter name Type/Value Cardinality Description Validations
Employee_Severance_Worksheet  Employee_Severance_Worksheet_Event  [0..*]  Data for Retrieve Employee Severance Worksheet Response   
top
 

Employee_Severance_Worksheet_Event

part of: Employee_Severance_Worksheet_Event_Response_Data
Contains reference to Employee Severance Worksheet Event and Employee Severance Worksheet Event Data
 
Parameter name Type/Value Cardinality Description Validations
Employee_Severance_Worksheet_Event_Reference  Employee_Severance_Worksheet_EventObject  [0..1]  Employee Severance Worksheet Event Reference   
Employee_Severance_Worksheet_Data  Employee_Severance_Worksheet_Event_Data  [0..*]  Data for Employee Severance Worksheet Event   
top
 

Employee_Severance_Worksheet_Event_Data

part of: Employee_Severance_Worksheet_Event
Employee Severance Worksheet Event Data
 
Parameter name Type/Value Cardinality Description Validations
Effective_Date  date  [0..1]  Severance Package effective date   
Severance_Package_Reference  Severance_PackageObject  [0..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 are valid.   
Employee_Reference  WorkerObject  [0..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  [0..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.   
Reason_for_Severance_Reference  Event_Classification_SubcategoryObject  [0..1]  The reason for the employee's severance   
Reason_for_Termination_Reference  Event_Classification_SubcategoryObject  [0..1]  Reference for Termination Reason   
Regrettable_Reference  Common_Yes_NoObject  [0..1]  Reference for Regrettable Yes/No/Null   
Send_to_Payroll  boolean  [0..1]  Boolean indicating if to use this Severance Worksheet for the Termination   
Notified_Employee_Date  date  [0..1]  Date to Notify Employee of Termination   
Severance_Response_Date_  date  [0..1]  Date Response to Severance Is Due   
Worksheet_Delivered_Date  date  [0..1]  Date Severance Worksheet is to be Delivered   
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]  Cutoff Date for Severance Worksheet Revocation   
Employee_Severance_Package_Pay_Component_Data  Employee_Severance_Package_Pay_Component_Data  [0..*]  Subelement for entering a severance component type along with eligibility and a comment   
Severance_Package_Component  Severance_Package_Component_Data  [0..*]  Element to input data for a severance package component on a worksheet. Fields for a component type, eligibility, and 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.   
 
top
 

Severance_PackageObject

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

WorkerObject

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

Event_Classification_SubcategoryObject

part of: Employee_Severance_Worksheet_Event_Data, Employee_Severance_Worksheet_Event_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_Event_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
 

Employee_Severance_Package_Pay_Component_Data

part of: Employee_Severance_Worksheet_Event_Data
Subelement for entering a severance component type along with eligibility and a comment
 
Parameter name Type/Value Cardinality Description Validations
Employee_Severance_Package_Pay_Component_Reference  Severance_Package_Component_TypeObject  [0..1]  Reference for a Severance Package Component Type.   
Assignment_Duration  decimal (20, 0) >0   [0..1]  Number of weeks for the assignment of the severance pay component   
Pay_Rate  decimal (26, 6)   [0..1]  An amount to be paid weekly for ongoing severance.   
Total  decimal (26, 6)   [0..1]  Total Amount for a Severance Pay Component.   
Plan_Reference  Salary_PlanObject  [0..1]  Reference to a salary plan used for Ongoing Severance Pay.   
Comments  string  [0..1]  Comment for a Severance Pay Component.   
top
 

Severance_Package_Component_TypeObject

part of: Severance_Package_Component_Data, Employee_Severance_Package_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: Employee_Severance_Package_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
 

Severance_Package_Component_Data

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

part of: Employee_Severance_Worksheet_EventObjectID
Base Type
string
top
 

Severance_PackageReferenceEnumeration

part of: Severance_PackageObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

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