Service Directory > v31.2 > Payroll > Put_Payroll_Limit_Override
 

Operation: Put_Payroll_Limit_Override

This web service is for adding or updating Payroll Limit Override for 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_Limit_Override_Request

Element to hold all Payroll Limit Override Request Information for Put.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Limit_Override_Reference  Payroll_Limit_OverrideObject  [0..1]  Payroll Limit Override ID (used as a lookup ID to perform an update).   
Payroll_Limit_Override_Data  Payroll_Limit_Override_Data  [0..1]  Element to hold all information about the Payroll Limit Override Data for Put or Get. 
Validation Description
End Date must be >= Start Date.   
Overlapping limit overrides cannot exist for the same Worker, Pay Component (i.e. overlapping dates within specified Start Date/End Date), and Position.   
Limit Override Value not allowed when Use Limit Override is False.   
More than one row has the same Pay Component, Start Period, and Position.   
Position has to be one of the positions filled by the Worker.   
Limit Interfaces not all valid for Payroll Limit Override.   
 
top
 

Response Element: Put_Payroll_Limit_Override_Response

Put Payroll Limit Override Reponse Element.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Payroll_Limit_Override_Reference  Payroll_Limit_OverrideObject  [0..1]  The Payroll Limit Override instance that is created as of the Put.   
top
 

Payroll_Limit_OverrideObject

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

Payroll_Limit_OverrideObjectID

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

Payroll_Limit_Override_Data

part of: Put_Payroll_Limit_Override_Request
Element to hold all information about the Payroll Limit Override Data for Put or Get.
 
Parameter name Type/Value Cardinality Description Validations
ID  string  [0..1]  ID of Payroll Limit Override.   
Worker_Reference  WorkerObject  [1..1]  Worker the Payroll Limit Override is for   
Position_Reference  Position_ElementObject  [0..1]  Position the Payroll Limit Override is for. 
Validation Description
Position must be submitted. If you submitted only a Worker reference, then this worker has more than one position you have access to. If you submitted a Position Management Position ID, and more than one worker is filling that position (it has been overlapped) - please submit the worker reference as well so we can identify which worker to process.   
Position submitted is not filled as of the effective date.   
Position is not valid for this Worker as of the effective date. Worker: [worker] Position: [position] Date: [date]   
 
Limit_Interface_Data  Limit_Interface_Data  [1..*]  Limit Interface the Payroll Limit Override is for.   
Period_Start_Date  date  [1..1]  Start Period will be derived from the Period that the specified Start Date falls within (for the 'regular' run category for the Pay Group the employee is in as of today).   
Period_End_Date  date  [0..1]  End Period will be derived from the Period that the specified End Date falls within (for the 'regular' run category for the Pay Group the employee is in as of today).   
Use_Limit_Override_Value  boolean  [0..1]  "If specified, the system will use the limit override value. If not specified, the system will ignore the limit completely."   
Limit_Override_Value  decimal (26, 6)   [0..1]  Limit Override Value to be used instead of what is specified on the Pay Component.   
Validation Description
End Date must be >= Start Date.   
Overlapping limit overrides cannot exist for the same Worker, Pay Component (i.e. overlapping dates within specified Start Date/End Date), and Position.   
Limit Override Value not allowed when Use Limit Override is False.   
More than one row has the same Pay Component, Start Period, and Position.   
Position has to be one of the positions filled by the Worker.   
Limit Interfaces not all valid for Payroll Limit Override.   
top
 

WorkerObject

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

Position_ElementObject

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

Limit_Interface_Data

part of: Payroll_Limit_Override_Data
Limit Interface for the Payroll Limit Override
 
Parameter name Type/Value Cardinality Description Validations
Pay_Component_Reference  Pay_ComponentObject  [1..1]  Pay Component comprising the Limit Interface or, if Related Calculation is present, the Pay Component which, together with Related Calculation, comprise a Pay Component Related Calculation as a Limit Interface   
Related_Calculation__All__Reference  Related_Calculation__All_Object  [0..1]  Related Calculation which, if present with Pay Component, comprises a Pay Component Related Calculation as a Limit Interface   
top
 

Pay_ComponentObject

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

Pay_ComponentObjectID

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

Related_Calculation__All_Object

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

Related_Calculation__All_ObjectID

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

Payroll_Limit_OverrideReferenceEnumeration

part of: Payroll_Limit_OverrideObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Pay_ComponentReferenceEnumeration

part of: Pay_ComponentObjectID
Base Type
string
top
 

Related_Calculation__All_ReferenceEnumeration

part of: Related_Calculation__All_ObjectID
Base Type
string
top