PayGroupsPeriods
Supports a collection of payroll periods associated with a specific Payroll Interface pay group ID, facilitating accurate period-based payroll calculations.
Workday Resource Information
Retrieves all payroll periods for the specified Payroll Interface pay group ID and sorts in descending order by the period end date.Secured by: REST API Public
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | False |
The unique ID for the payroll period record. This value is system-generated and should be used to reference specific pay periods within Workday. |
| PayGroups_Id [KEY] | String | False |
The unique Workday ID (WID) for the pay group associated with this payroll period. This ID links payroll periods to specific pay groups, ensuring accurate payroll processing. |
| PeriodEndDate | Datetime | False |
The final date of the payroll period, representing the last day for which employees receive compensation. This date determines payroll cutoff and reporting timelines. |
| PeriodIsEarliestOpen | Bool | False |
Indicates whether this payroll period is the earliest available open period for payroll processing. If true, this is the earliest unpaid or unprocessed payroll period. |
| PeriodStartDate | Datetime | False |
The first date of the payroll period, marking the beginning of the pay cycle. This date is used for payroll calculations and reporting purposes. |
| Status | String | False |
The current status of the payroll period, such as 'Open,' 'Closed,' or 'Processing.' This value determines whether payroll actions can be performed within the specified period. |
| PeriodEndDate_Prompt | Date | False |
Specifies the end date of the payroll period in YYYY-MM-DD format for querying purposes. This parameter should not be used in conjunction with the showMostRecentOnly query parameter. |
| ShowMostRecentOnly_Prompt | Bool | False |
Determines whether to return only the five most recent pay periods. If set to true, the query retrieves the five most recent periods instead of filtering by a specific period end date. |
| Country_Prompt | String | False |
The Workday ID of the country or territory of the pay group. You can use a returned country id from any of the payGroups endpoints in this Payroll API. |