Service Directory > v31.2 > Compensation > Put_Previous_System_Compensation_History
 

Operation: Put_Previous_System_Compensation_History

This operation will load previous system compensation history for a given employee. The operation allows free-form text entry indication of changes to a workers compensation before the implementation in the Workday system.


@ - 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_Previous_System_Compensation_History_Request

Contains the data for adding, updating or deleting a previous system compensation history entry for a worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Previous_System_Compensation_History_Data  Previous_System_Compensation_History  [1..1]  Contains the data for adding, updating or deleting a previous system compensation history entry for a worker.   
top
 

Response Element: Put_Previous_System_Compensation_History_Response

Response for Put Previous System Compensation History. Returns the worker.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Worker_Reference  WorkerObject  [0..1]  A reference to the ID of the worker. The ID consists of a type attribute, which should be set to "Employee_ID" or "Contingent_Worker_ID", and a value attribute, such as "04345". If Skip Non Existing Instances value is set to true. When a reference id value that does not meet the entry date criteria is passed, the non existent reference id will be ignored.   
top
 

Previous_System_Compensation_History

part of: Put_Previous_System_Compensation_History_Request
Contains the data for adding, updating or deleting a previous system compensation history entry for a worker.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [1..1]  Unique Identifier for a worker (Employee or Contingent Worker).   
Previous_System_Job_History  Previous_System_Compensation_History_Data  [1..*]  Container for defining whether a previous system compensation history entry is being added, updated or deleted. 
Validation Description
Add Only is True but the reference ID is already in use. Verify that you are sending the correct ID - or set Add Only to false if you want to update the existing entry. ID: [ID] In Use on: [Used]   
Previous System Compensation History Detail Data element is required (unless deleting an entry).   
 
top
 

WorkerObject

part of: Previous_System_Compensation_History, Put_Previous_System_Compensation_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  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
 

Previous_System_Compensation_History_Data

part of: Previous_System_Compensation_History
Container for defining whether a previous system compensation history entry is being added, updated or deleted.
 
Parameter name Type/Value Cardinality Description Validations
@Add_Only  boolean  [1..1]  Add Only Flag. Indicates that the service is an add only, not an update.   
@Delete  boolean  [1..1]  Flag indicating that the referenced data should be deleted. 
Validation Description
Add Only and Delete cannot both be true.   
 
Previous_System_Compensation_History_Reference  Compensation_Previous_System_HistoryObject  [0..1]  Unique identifier for a previous system compensation entry. Required if you are deleting or updating an existing entry. Leave blank on an Add. 
Validation Description
The Previous System Compensation History Reference submitted is in use for a different worker. Previous System Compensation History Reference: [Comp] Worker Submitted: [Worker] Worker in use: [OtherWorker]   
Previous System Compensation History Reference is required is Delete flag is True.   
 
Previous_System_Compensation_History_Detail_Data  Previous_System_Compensation_History_Detail_Data  [0..1]  Container for the detailed data for a previous system compensation history entry.   
Validation Description
Add Only is True but the reference ID is already in use. Verify that you are sending the correct ID - or set Add Only to false if you want to update the existing entry. ID: [ID] In Use on: [Used]   
Previous System Compensation History Detail Data element is required (unless deleting an entry).   
top
 

Compensation_Previous_System_HistoryObject

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

Compensation_Previous_System_HistoryObjectID

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

Previous_System_Compensation_History_Detail_Data

part of: Previous_System_Compensation_History_Data
Container for the detailed data for a previous system compensation history entry.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  Unique identifier for a Previous System Compensation History entry. This can be entered here on an add to set the reference id to a customer determined value or left blank and a default value will be saved. If you are updating an existing entry, entering a value here will change the reference id.   
Worker_History_Name  string  [0..1]  Name to identify the Previous System Compensation History. This does not have to be unique. During an update, if no value is sent then the existing value will be kept. Required on an Add. 
Validation Description
Worker History Name is required.   
 
Action_Date  date  [0..1]  Date of the Previous System Compensation entry. During an update, if no value is sent, then the existing date will be kept. Required on an Add. 
Validation Description
Action Date is required.   
 
Reason  string  [0..1]  Reason for the Previous System Compensation Entry. During an update, if no value is sent then the existing value will be kept. Required on an Add. 
Validation Description
The Reason is required.   
 
Amount  decimal (26, 6) >0   [0..1]  Amount of the Compensation for the Previous System Compensation Entry. During an update, if no value is sent then the existing value will be kept.   
Currency_Reference  CurrencyObject  [0..1]  Reference to the Currency.   
Frequency_Reference  FrequencyObject  [0..1]  Reference to a Frequency.   
Amount_Change  decimal (26, 6)   [0..1]  Amount of the compensation change for the Previous System Compensation Entry. During an update, if no value is sent then the existing value will be kept.   
Description  string  [0..1]  Free Form Description for the Previous System Compensation Entry. During an update, if no valie is sent then the existing value will be kept.   
top
 

CurrencyObject

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

FrequencyObject

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

FrequencyObjectID

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

Compensation_Previous_System_HistoryReferenceEnumeration

part of: Compensation_Previous_System_HistoryObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top