Service Directory > v32.1 > Payroll_Interface > Get_Payroll_Forward_Accrual_Options
 

Operation: Get_Payroll_Forward_Accrual_Options

Retrieves Payroll Forward Accrual Options including Pay Components to Exclude from Forward Accrual Processing.


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

Root element for the Request on the Get operation. Contains references, criteria, filter and response group for specifying which instances to return in the Response.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Payroll_Forward_Accrual_Options_Request_References  [0..1]  Request References for Payroll Forward Accrual Options   
Request_Criteria [Choice]   Payroll_Forward_Accrual_Options_Request_Criteria  [0..1]  Request Criteria for Payroll Forward Accrual Options   
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_Forward_Accrual_Options_Response_Group  [0..1]  Response Group for Payroll Forward Accrual Options   
top
 

Response Element: Get_Payroll_Forward_Accrual_Options_Response

Root element for the Response on the Get operation. Contains the instances returned by the Get operation and their accompanying data.
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Payroll_Forward_Accrual_Options_Request_References  [0..1]  Request References for Payroll Forward Accrual Options   
Request_Criteria  Payroll_Forward_Accrual_Options_Request_Criteria  [0..1]  Request Criteria for Payroll Forward Accrual Options   
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_Forward_Accrual_Options_Response_Group  [0..1]  Response Group for Payroll Forward Accrual Options   
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_Forward_Accrual_Options_Response_Data  [0..1]  Response Data for Payroll Forward Accrual Options   
top
 

Payroll_Forward_Accrual_Options_Request_References

part of: Get_Payroll_Forward_Accrual_Options_Request, Get_Payroll_Forward_Accrual_Options_Response
Request References for Payroll Forward Accrual Options
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Forward_Accrual_Options_Reference  Payroll_Forward_Accrual_OptionsObject  [1..1]  Request References for Payroll Forward Accrual Options instance   
top
 

Payroll_Forward_Accrual_OptionsObject

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

Payroll_Forward_Accrual_OptionsObjectID

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

part of: Get_Payroll_Forward_Accrual_Options_Request, Get_Payroll_Forward_Accrual_Options_Response
Request Criteria for Payroll Forward Accrual Options
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

part of: Get_Payroll_Forward_Accrual_Options_Request, Get_Payroll_Forward_Accrual_Options_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_Forward_Accrual_Options_Response_Group

part of: Get_Payroll_Forward_Accrual_Options_Request, Get_Payroll_Forward_Accrual_Options_Response
Response Group for Payroll Forward Accrual Options
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

part of: Get_Payroll_Forward_Accrual_Options_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_Forward_Accrual_Options_Response_Data

part of: Get_Payroll_Forward_Accrual_Options_Response
Response Data for Payroll Forward Accrual Options
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Forward_Accrual_Options  Payroll_Forward_Accrual_Options_Get_Data  [0..*]  Data for Get Payroll Forward Accrual Options   
top
 

Payroll_Forward_Accrual_Options_Get_Data

part of: Payroll_Forward_Accrual_Options_Response_Data
Response Data for Payroll Forward Accrual Options
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Forward_Accrual_Options_Reference  Payroll_Forward_Accrual_OptionsObject  [0..1]  Payroll Forward Accrual Options instance   
Payroll_Forward_Accrual_Options_Data  Payroll_Forward_Accrual_Options_Data  [0..*]  Data associated with the Payroll Forward Accrual Options instance.   
top
 

Payroll_Forward_Accrual_Options_Data

part of: Payroll_Forward_Accrual_Options_Get_Data
Data Element for Put Request
 
Parameter name Type/Value Cardinality Description Validations
Payroll_Forward_Accrual_Options_ID  string  [0..1]  Unique identifier for Payroll Forward Accrual Options Data   
Employer_Paid_Expenses_to_Exclude_from_Forward_Accruals_Reference  Deduction__All_Object  [0..*]  Set of Employer Paid Expenses to Exclude from Forward Accrual processing   
top
 

Deduction__All_Object

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

Deduction__All_ObjectID

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

Payroll_Forward_Accrual_OptionsReferenceEnumeration

part of: Payroll_Forward_Accrual_OptionsObjectID
Base Type
string
top
 

Deduction__All_ReferenceEnumeration

part of: Deduction__All_ObjectID
Base Type
string
top