Service Directory > v25.1 > Payroll_GBR > Put_Payroll_SSP_History
 

Operation: Put_Payroll_SSP_History

Provides the ability to load Payroll SSP History for a ~worker~.


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

Put Payroll SSP History Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_SSP_History_Reference  Unique_IdentifierObject  [0..1]  Payroll SSP History Reference   
Payroll_SSP_History_Data  Payroll_SSP_History_Data  [1..1]  Payroll SSP History Data 
Validation Description
First Day of SSP must be less than or equal to Last PIW Start Date.   
Total Number of SSP Days Taken must be zero, if Total Number of SSP Weeks Taken is 28.   
Number of SSP Days Taken must be less than or equal to 7.   
Number of SSP Weeks Taken must be less than or equal to 28.   
Total Number of Payment Days for SSP must be less than or equal to 196.   
Total Number of Waiting Days must be less than or equal to 3.   
Last PIW End Date must be at least 3 days later than Last PIW Start Date.   
Last PIW End Date is required if SSP Absence History is selected.   
Last PIW Start Date is required if SSP Absence History is selected.   
 
top
 

Response Element: Put_Payroll_SSP_History_Response

Put Payroll SSP History Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_SSP_History_Reference  Unique_IdentifierObject  [1..1]  Payroll SSP History Reference   
top
 

Unique_IdentifierObject

part of: Put_Payroll_SSP_History_Request, Put_Payroll_SSP_History_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
 

Payroll_SSP_History_Data

part of: Put_Payroll_SSP_History_Request
Payroll SSP History Data
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Worker Reference   
Average_Weekly_Earnings  decimal (14, 2) >0   [0..1]  Average Weekly Earnings   
SSP_Absence_History  boolean  [0..1]  SSP Absence History   
Last_PIW_Start_Date  date  [0..1]  Last PIW Start Date   
Last_PIW_End_Date  date  [0..1]  Last PIW End Date   
Total_Number_of_Waiting_Days  decimal (12, 0) >0   [0..1]  Total Number of Waiting Days   
Total_Number_of_Payment_Days_for_SSP  decimal (12, 0) >0   [0..1]  Total Number of Payment Days for SSP   
Number_of_SSP_Weeks_Taken  decimal (6, 0) >0   [0..1]  Number of SSP Weeks Taken   
Number_of_SSP_Days_Taken  decimal (6, 0) >0   [0..1]  Number of SSP Days Taken   
First_Day_of_SSP  date  [0..1]  First Day of SSP   
Validation Description
First Day of SSP must be less than or equal to Last PIW Start Date.   
Total Number of SSP Days Taken must be zero, if Total Number of SSP Weeks Taken is 28.   
Number of SSP Days Taken must be less than or equal to 7.   
Number of SSP Weeks Taken must be less than or equal to 28.   
Total Number of Payment Days for SSP must be less than or equal to 196.   
Total Number of Waiting Days must be less than or equal to 3.   
Last PIW End Date must be at least 3 days later than Last PIW Start Date.   
Last PIW End Date is required if SSP Absence History is selected.   
Last PIW Start Date is required if SSP Absence History is selected.   
top
 

WorkerObject

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

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top