Service Directory > v31.2 > Payroll > Get_Period_Schedules
 

Operation: Get_Period_Schedules

Return Period Schedules


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

Get Period Schedules Request
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References [Choice]   Period_Schedule_Request_References  [0..1]  Period Schedule Request References   
Request_Criteria [Choice]   Period_Schedule_Request_Criteria  [0..1]  Period Schedule Request Criteria   
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  Period_Schedule_Response_Group  [0..1]  Period Schedule Response Group   
top
 

Response Element: Get_Period_Schedules_Response

Get Period Schedules Response
 
Parameter name Type/Value Cardinality Description Validations
@version string [0..1] Web Service version  
Request_References  Period_Schedule_Request_References  [0..1]  Period Schedule Request References   
Request_Criteria  Period_Schedule_Request_Criteria  [0..1]  Period Schedule Request Criteria   
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  Period_Schedule_Response_Group  [0..1]  Period Schedule 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  Period_Schedule_Response_Data  [0..1]  Period Schedule Response Data   
top
 

Period_Schedule_Request_References

part of: Get_Period_Schedules_Request, Get_Period_Schedules_Response
Period Schedule Request References
 
Parameter name Type/Value Cardinality Description Validations
Period_Schedule_Reference  Period_ScheduleObject  [1..*]  Period Schedule Request References   
top
 

Period_ScheduleObject

part of: Period_Schedule_Request_References, Period_Schedule, Period_Schedule_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  Period_ScheduleObjectID  [0..*]  Contains a unique identifier for an instance of an object.   
top
 

Period_ScheduleObjectID

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

Period_Schedule_Request_Criteria

part of: Get_Period_Schedules_Request, Get_Period_Schedules_Response
Period Schedule Request Criteria
 
Parameter name Type/Value Cardinality Description Validations
top
 

Response_Filter

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

Period_Schedule_Response_Group

part of: Get_Period_Schedules_Request, Get_Period_Schedules_Response
Period Schedule Response Group
 
Parameter name Type/Value Cardinality Description Validations
Include_Reference  boolean  [0..1]  Include Reference   
top
 

Response_Results

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

Period_Schedule_Response_Data

part of: Get_Period_Schedules_Response
Period Schedule Response Data
 
Parameter name Type/Value Cardinality Description Validations
Period_Schedule  Period_Schedule  [0..*]  Period Schedule   
top
 

Period_Schedule

part of: Period_Schedule_Response_Data
Period Schedule
 
Parameter name Type/Value Cardinality Description Validations
Period_Schedule_Reference  Period_ScheduleObject  [0..1]  Period Schedule Reference   
Period_Schedule_Data  Period_Schedule_Data  [1..1]  Name of Period Schedule. 
Validation Description
Allow Timesheet Changes can only be entered if period schedule usage includes Timesheets.   
Payroll Period Schedule Reference is only applicable for Time Tracking (when Usage Reference = Time Tracking).   
Time Tracking Eligibility Rule Reference is only applicable for Time Tracking (when Usage Reference includes Time Tracking).   
Payment Date Auto-Adjust values are only valid when Period Schedule Usage includes Payroll   
 
top
 

Period_Schedule_Data

part of: Period_Schedule
Name of Period Schedule.
 
Parameter name Type/Value Cardinality Description Validations
Period_Schedule_ID  string  [0..1]  Period Schedule ID   
Period_Schedule_Name  string  [1..1]  Name of Period Schedule.   
Frequency_Reference  FrequencyObject  [1..1]  Frequency Name   
Usage_Reference  Period_Schedule_UsageObject  [0..*]  Period Schedule Usage, valid values include Payroll, Absence and Timesheets   
Payment_Date_Auto-Adjust_Saturday  decimal (6, 0)   [0..1]  Enter one digit number to automatically adjust the payment date if the payment date falls on weekend.   
Payment_Date_Auto-Adjust_Sunday  decimal (6, 0)   [0..1]  Enter one digit number to automatically adjust the payment date if the payment date falls on weekend.   
Allow_Timesheet_Changes  boolean  [0..1]  For the associated Period Schedule, when this field is set to true the user is allowed to change/edit the timesheet after it has been approved.   
Payroll_Period_Schedule_Reference  Period_ScheduleObject  [0..1]  Payroll Period Schedule Reference is for Time Tracking (Usage = Time Tracking). It is used for mapping Time Periods to Payroll Periods.   
Time_Tracking_Eligibility_Rule_Reference  Time_Tracking_Eligibility_RuleObject  [0..*]  Time Tracking Eligibility Rule Reference is for Time Tracking. It determines if a Worker is eligible to use the Period Schedule.   
Period_Data  Period_Data  [0..*]  Period Content Data 
Validation Description
Period with same Start Date, End Date, and Payment Date already exists for this Period Schedule.   
Period End Date should be greater than or equal to Start Date.   
Accrual Date must be after Period Start Date   
Accrual Reversal Date must be after Accrual Date   
For a Forward Accrual, all attributes are required. For No Forward Accrual, no attributes can have a value.   
Payroll GL Accruals can only be entered if period schedule usage includes Payroll.   
Payroll Payment Date can only be entered if period schedule usage includes Payroll. Payroll Payment Date is required if period schedule usage includes Payroll.   
Time Period End Date cannot be greater than Pay Period End Date. Please enter Time Period End Date that is equal to or less than Pay Period End Date.   
Payroll Period Reference is invalid for the Payroll Period Schedule Reference.   
Close date must be within one year of period end date.   
Close Time Entry date must be after Unlock for Adjustments date.   
Close Time Entry date must be after Lock Time Entry date.   
Close Time Entry date must be after Open Time Entry date.   
Unlock for Adjustments date cannot be specified without Lock Time Entry date.   
Open Time Entry date must be before Lock Time Entry date.   
Unlock for Adjustments date must be after Lock Time Entry date.   
 
Validation Description
Allow Timesheet Changes can only be entered if period schedule usage includes Timesheets.   
Payroll Period Schedule Reference is only applicable for Time Tracking (when Usage Reference = Time Tracking).   
Time Tracking Eligibility Rule Reference is only applicable for Time Tracking (when Usage Reference includes Time Tracking).   
Payment Date Auto-Adjust values are only valid when Period Schedule Usage includes Payroll   
top
 

FrequencyObject

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

FrequencyObjectID

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

Period_Schedule_UsageObject

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

Period_Schedule_UsageObjectID

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

Time_Tracking_Eligibility_RuleObject

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

Time_Tracking_Eligibility_RuleObjectID

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

Period_Data

part of: Period_Schedule_Data
Period Content Data
 
Parameter name Type/Value Cardinality Description Validations
Period_Start_Date  date  [1..1]  Period Start Date   
Period_End_Date  date  [1..1]  Period End Date   
Payroll_Payment_Date  date  [0..1]  Payment Date   
Payroll_GL_Accruals  boolean  [0..1]  Create Forward Accrual flag   
Days_to_Accrue  decimal (8, 2) >0   [0..1]  Days to Accrue   
Days_in_Basis  decimal (8, 2) >0   [0..1]  Days in Basis   
Accrual_Date  date  [0..1]  Accrual Date   
Accrual_Reversal_Date  date  [0..1]  Accrual Reversal Date   
Open_Time_Entry  dateTime  [0..1]  Open Time Entry Date. Only applicable for Period Schedule Usage = Time Tracking.   
Lock_Time_Entry  dateTime  [0..1]  Lock Time Entry Date. Only applicable for Period Schedule Usage = Time Tracking.   
Unlock_for_Adjustments  dateTime  [0..1]  Unlock for Adjustments Date. Only applicable for Period Schedule Usage = Time Tracking.   
Close_Time_Entry  dateTime  [0..1]  Close Time Entry Date. Only applicable for Period Schedule Usage = Time Tracking.   
Payroll_Period_Reference  PeriodObject  [0..1]  Payroll Period Reference is used for mapping Time Period to Payroll Period. It is only applicable when Period Schedule Usage = Time Tracking.   
Valuation_Date_Override_Data  Valuation_Date_Override_Data  [0..*]  Container element for Valuation Date Override Data 
Validation Description
A country/date combination can only be entered once per pay period.   
 
Period_ID  string  [0..1]  Period ID   
Validation Description
Period with same Start Date, End Date, and Payment Date already exists for this Period Schedule.   
Period End Date should be greater than or equal to Start Date.   
Accrual Date must be after Period Start Date   
Accrual Reversal Date must be after Accrual Date   
For a Forward Accrual, all attributes are required. For No Forward Accrual, no attributes can have a value.   
Payroll GL Accruals can only be entered if period schedule usage includes Payroll.   
Payroll Payment Date can only be entered if period schedule usage includes Payroll. Payroll Payment Date is required if period schedule usage includes Payroll.   
Time Period End Date cannot be greater than Pay Period End Date. Please enter Time Period End Date that is equal to or less than Pay Period End Date.   
Payroll Period Reference is invalid for the Payroll Period Schedule Reference.   
Close date must be within one year of period end date.   
Close Time Entry date must be after Unlock for Adjustments date.   
Close Time Entry date must be after Lock Time Entry date.   
Close Time Entry date must be after Open Time Entry date.   
Unlock for Adjustments date cannot be specified without Lock Time Entry date.   
Open Time Entry date must be before Lock Time Entry date.   
Unlock for Adjustments date must be after Lock Time Entry date.   
top
 

PeriodObject

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

PeriodObjectID

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

Valuation_Date_Override_Data

part of: Period_Data
Container element for Valuation Date Override Data
 
Parameter name Type/Value Cardinality Description Validations
Country_Reference  CountryObject  [1..1]  Country Reference is a unique reference to a Country 
Validation Description
Payroll Settlement Valuation Date Overrides can only be entered if Period Schedule Usage includes Payroll.   
 
Payroll_Settlement_Valuation_Date  date  [1..1]  The Payroll Settlement Valuation Date value 
Validation Description
Enter a Payroll Settlement Valuation Date Override that is different from the period payment date for the country [country].   
 
Validation Description
A country/date combination can only be entered once per pay period.   
top
 

CountryObject

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

CountryObjectID

part of: CountryObject
Contains a unique identifier for an instance of an object.
 
Parameter name Type/Value Cardinality Description Validations
#text  string       
@type  WID, ISO_3166-1_Alpha-2_Code, ISO_3166-1_Alpha-3_Code, ISO_3166-1_Numeric-3_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
 

Period_ScheduleReferenceEnumeration

part of: Period_ScheduleObjectID
Base Type
string
top
 

FrequencyReferenceEnumeration

part of: FrequencyObjectID
Base Type
string
top
 

Period_Schedule_UsageReferenceEnumeration

part of: Period_Schedule_UsageObjectID
Base Type
string
top
 

Time_Tracking_Eligibility_RuleReferenceEnumeration

part of: Time_Tracking_Eligibility_RuleObjectID
Base Type
string
top
 

PeriodReferenceEnumeration

part of: PeriodObjectID
Base Type
string
top
 

CountryReferenceEnumeration

part of: CountryObjectID
Base Type
string
top