Service Directory > v31.2 > Compensation > Get_Future_Payment_Plan_Assignments
 

Operation: Get_Future_Payment_Plan_Assignments

This operation allows the retrieval of future payment plan assignments for one or more employees. You must have access to the Worker:Compensation by Organization domain.


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

Request element to get future payment plan assignments. If no criteria are specified then all assignments active for today will be returned, grouped by employee.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Future_Payment_Plan_Assignment_Request_Criteria  [0..1]  Future Payment Plan Assignment Request Criteria contains a set of zero or more Employees for whom Future Payment Plan Assignments are requested.   
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_Future_Payment_Plan_Assignments_Response

Get Future Payment Plan Assignments Response element containing retrieved Future Payment Plan Assignments and associated web service request related criteria.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_Criteria  Future_Payment_Plan_Assignment_Request_Criteria  [0..1]  Future Payment Plan Assignment Request Criteria contains a set of zero or more Employees for whom Future Payment Plan Assignments are requested.   
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_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  Future_Payment_Plan_Assignment_Response_Data  [0..1]  Contains future payment plan assignment information based on Request Criteria.   
top
 

Future_Payment_Plan_Assignment_Request_Criteria

part of: Get_Future_Payment_Plan_Assignments_Request, Get_Future_Payment_Plan_Assignments_Response
Future Payment Plan Assignment Request Criteria contains a set of zero or more Employees for whom Future Payment Plan Assignments are requested.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [0..*]  Optional set of employees for whom future payment plan assignments should be retrieved. Assignments will be grouped by position for employees that have more than one active position.   
Position_Reference  Position_ElementObject  [0..*]  Optional set of positions for whom future payment plan assignments should be retrieved.   
top
 

WorkerObject

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

Response_Filter

part of: Get_Future_Payment_Plan_Assignments_Request, Get_Future_Payment_Plan_Assignments_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_Future_Payment_Plan_Assignments_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
 

Future_Payment_Plan_Assignment_Response_Data

part of: Get_Future_Payment_Plan_Assignments_Response
Contains future payment plan assignment information based on Request Criteria.
 
Parameter name Type/Value Cardinality Description Validations
Position_Future_Payment_Plan_Assignment  Position_Future_Payment_Plan_Assignments  [0..*]  Groups an Employee's Future Payment Plan Assignments.   
top
 

Position_Future_Payment_Plan_Assignments

part of: Future_Payment_Plan_Assignment_Response_Data
Groups an Employee's Future Payment Plan Assignments.
 
Parameter name Type/Value Cardinality Description Validations
Position_Future_Payment_Plan_Assignment_Data  Position_Future_Payment_Plan_Assignment_Data  [0..*]  Future payment plan assignments for a position effective for specific date.   
top
 

Position_Future_Payment_Plan_Assignment_Data

part of: Position_Future_Payment_Plan_Assignments
Future payment plan assignments for a position effective for specific date.
 
Parameter name Type/Value Cardinality Description Validations
Employee_Reference  WorkerObject  [1..1]  The employee to whom the set of future payment plan assignments are assigned to or will be assigned to.   
Position_Reference  Position_ElementObject  [0..1]  The position to whom the set of future payment plan assignments are assigned to or will be assigned to. 
Validation Description
Position submitted is not filled as of the effective date.   
The employee you have selected has more than one job. You must supply the job to which this operation applies.   
The job is not valid for the employee.   
 
Assignment_Date  date  [0..1]  Assignment date for the future payment plan assignment.   
Future_Payment_Plan_Assignment_Data  Future_Payment_Plan_Assignment_Data  [0..*]  Future payment plan assignment data submitted by the put future payment plan assignment request. 
Validation Description
Individual Target Amount has to be greater than zero. If you do not wish to use Individual Target Amount, leave the field blank.   
 
top
 

Future_Payment_Plan_Assignment_Data

part of: Position_Future_Payment_Plan_Assignment_Data
Future payment plan assignment data submitted by the put future payment plan assignment request.
 
Parameter name Type/Value Cardinality Description Validations
Compensation_Plan_Reference  Future_Payment_PlanObject  [0..1]  Compensation Plan Reference   
Individual_Target_Amount  decimal (26, 6)   [0..1]  Individual Target Amount   
Individual_Target_Currency_Reference  CurrencyObject  [0..1]  Individual Target Currency Reference   
Individual_Target_Payment_Date  date  [0..1]  Individual Target Payment Date   
Comment  string  [0..1]  Comment   
Validation Description
Individual Target Amount has to be greater than zero. If you do not wish to use Individual Target Amount, leave the field blank.   
top
 

Future_Payment_PlanObject

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

Future_Payment_PlanObjectID

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

CurrencyObject

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

WorkerReferenceEnumeration

part of: WorkerObjectID
Base Type
string
top
 

Position_ElementReferenceEnumeration

part of: Position_ElementObjectID
Base Type
string
top
 

Future_Payment_PlanReferenceEnumeration

part of: Future_Payment_PlanObjectID
Base Type
string
top
 

CurrencyReferenceEnumeration

part of: CurrencyObjectID
Base Type
string
top