Service Directory > v31.2 > Payroll > Get_Payroll_Limit_Overrides
 

Operation: Get_Payroll_Limit_Overrides

This web service will return Payroll Limit Override from either Payroll Limit Override Reference, or Worker Reference/Pay Component/Start Date/End Date filter criteria.


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

Element to hold all Payroll Limit Override Request Information
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Limit_Override_Request_References  [0..1]  Element to hold all Payroll Limit Override Reference Response.   
Request_Criteria [Choice]   Payroll_Limit_Override_Request_Criteria  [0..1]  Element to hold all criteria used to select Payroll Limit Override.   
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  Payroll_Limit_Override_Response_Group  [0..1]  Element to hold all information about the Payroll Limit Override Response Group   
top
 

Response Element: Get_Payroll_Limit_Overrides_Response

Element to hold the Payroll Limit Override Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Limit_Override_Request_References  [0..1]  Element to hold all Payroll Limit Override Reference Response.   
Request_Criteria  Payroll_Limit_Override_Request_Criteria  [0..1]  Element to hold all criteria used to select Payroll Limit Override.   
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  Payroll_Limit_Override_Response_Group  [0..1]  Element to hold all information about the Payroll Limit Override Response Group   
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  Payroll_Limit_Override_Response_Data  [0..1]  Element to hold all data to Respond about Payroll Limit Override.   
top
 

Payroll_Limit_Override_Request_References

part of: Get_Payroll_Limit_Overrides_Request, Get_Payroll_Limit_Overrides_Response
Element to hold all Payroll Limit Override Reference Response.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Limit_Override_Reference  Payroll_Limit_OverrideObject  [1..*]  If specified, only return the limit override for specified Payroll Limit Override Reference   
top
 

Payroll_Limit_OverrideObject

part of: Payroll_Limit_Override_Request_References, Payroll_Limit_Override
 
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_Request_Criteria

part of: Get_Payroll_Limit_Overrides_Request, Get_Payroll_Limit_Overrides_Response
Element to hold all criteria used to select Payroll Limit Override.
 
Parameter name Type/Value Cardinality Description Validations
Worker_Reference  WorkerObject  [0..*]  If specified, only return the limit override for specified Employees   
Pay_Component_Reference  Limit_InterfaceObject  [0..*]  If specified, only return the limit override for specified Pay Component References   
Period_Start_Date  date  [0..1]  "If specified, only return the limit override that are in effect on/after the specified Start Date. Start Date specified >= Start Period (Start Date), AND Start Date specified <= End Period (Start Date) …. If End Period exists"   
Period_End_Date  date  [0..1]  "If specified, only return the limit override that are in effect on/before the specified End Date. End Date specified <= Start Period (Start Date), AND End Date specified >= End Period (Start Date) …. If End Period exists"   
top
 

WorkerObject

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

Limit_InterfaceObject

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

Limit_InterfaceObjectID

part of: Limit_InterfaceObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, Absence_Plan_ID, Accrual_Code, Deduction_Code, Earning_Code, Pay_Accumulation_Code, Pay_Component_Related_Calculation_Code, Time_Off_Code, Workday_Absence_Code, Workday_Absence_Plan_ID, Workday_Accrual_Code, Workday_Deduction_Code, Workday_Earning_Code, Workday_Pay_Accumulation_Code, Workday_Pay_Component_Related_Calculation_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
 

Response_Filter

part of: Get_Payroll_Limit_Overrides_Request, Get_Payroll_Limit_Overrides_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
 

Payroll_Limit_Override_Response_Group

part of: Get_Payroll_Limit_Overrides_Request, Get_Payroll_Limit_Overrides_Response
Element to hold all information about the Payroll Limit Override Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference Boolean   
top
 

Response_Results

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

Payroll_Limit_Override_Response_Data

part of: Get_Payroll_Limit_Overrides_Response
Element to hold all data to Respond about Payroll Limit Override.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Limit_Override  Payroll_Limit_Override  [0..*]  Element to hold all information about Payroll Limit Override.   
top
 

Payroll_Limit_Override

part of: Payroll_Limit_Override_Response_Data
Element to hold all information about Payroll Limit Override.
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Limit_Override_Reference  Payroll_Limit_OverrideObject  [0..1]  Payroll Limit Override Reference of the Payroll Limit Override   
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
 

Payroll_Limit_Override_Data

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

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
 

Limit_InterfaceReferenceEnumeration

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