Service Directory > v31.2 > Payroll > Get_Withholding_Order_Local_Minimum_Wage_Rate
 

Operation: Get_Withholding_Order_Local_Minimum_Wage_Rate

This web service will return Withholding Order Local Minimum Wage(s) for either a company or ~workers~.


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

Get Withholding Order Local Minimum Wage Rate Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Withholding_Order_Local_Minimum_Wage_Rate_Request  [0..1]  Withholding Order Local Minimum Wage Rate Request Criteria 
Validation Description
Either a Company Reference ID or a Worker Reference ID must be provided.   
 
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. 
 
top
 

Response Element: Get_Withholding_Order_Local_Minimum_Wage_Rate_Response

Get Withholding Order Local Minimum Wage Rate Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Withholding_Order_Local_Minimum_Wage_Rate_Request  [0..1]  Withholding Order Local Minimum Wage Rate Request 
Validation Description
Either a Company Reference ID or a Worker Reference ID must be provided.   
 
Request_Filter  Response_Filter  [0..1]  Response Filter 
Validation Description
Page Number cannot be zero.  Page number cannot be zero. 
 
Response_Results  Response_Results  [0..1]  Response Result   
Response_Data  Get_Withholding_Order_Local_Minimum_Wage_Response_Data  [0..1]  Withholding Order Local Minimum Wage Response Data   
top
 

Withholding_Order_Local_Minimum_Wage_Rate_Request

part of: Get_Withholding_Order_Local_Minimum_Wage_Rate_Request, Get_Withholding_Order_Local_Minimum_Wage_Rate_Response
Withholding Order Local Minimum Wage Rate Request
 
Parameter name Type/Value Cardinality Description Validations
Company_Reference [Choice]   CompanyObject  [0..*]  Company Reference   
Worker_Reference [Choice]   WorkerObject  [0..*]  Worker Reference   
Validation Description
Either a Company Reference ID or a Worker Reference ID must be provided.   
top
 

CompanyObject

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

CompanyObjectID

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

Response_Filter

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

Response_Results

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

Get_Withholding_Order_Local_Minimum_Wage_Response_Data

part of: Get_Withholding_Order_Local_Minimum_Wage_Rate_Response
Get Withholding Order Local Minimum Wage Rate Response
 
Parameter name Type/Value Cardinality Description Validations
Withholding_Order_Local_Minimum_Wage_Data  Get_Withholding_Order_Local_Minimum_Wage_Data  [0..*]  Withholding Order Local Minimum Wage Data   
top
 

Get_Withholding_Order_Local_Minimum_Wage_Data

part of: Get_Withholding_Order_Local_Minimum_Wage_Response_Data
Get Withholding Order Local Minimum Wage Response Data
 
Parameter name Type/Value Cardinality Description Validations
Local_Minimum_Wage_Reference  Unique_IdentifierObject  [0..1]  Local Minimum Wage Reference   
Worker_Reference  WorkerObject  [0..1]  Worker Reference   
Company_Reference  CompanyObject  [0..1]  Company Reference   
Withholding_Order_Reference  Withholding_OrderObject  [0..1]  Withholding Order Reference   
Effective_Date  date  [0..1]  Effective Date   
Local_Minimum_Wage_Rate  decimal (26, 6) >0   [0..1]  Local Minimum Wage Rate   
Comment  string  [0..1]  Comment   
top
 

Unique_IdentifierObject

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

Withholding_OrderObject

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

Withholding_OrderObjectID

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

CompanyReferenceEnumeration

part of: CompanyObjectID
Base Type
string
top
 

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Unique_IdentifierReferenceEnumeration

part of: Unique_IdentifierObjectID
Base Type
string
top
 

Withholding_OrderReferenceEnumeration

part of: Withholding_OrderObjectID
Base Type
string
top