WorkersPeriod
Retrieves a period from the period schedule the worker is eligible for.
Workday Resource Information
Returns the period from the period schedule the worker is eligible for, on the given date. If you don't specify a date, today's date is used. This endpoint returns only 1 period.Secured by: Process: Time Tracking Configuration Objects REST APIs
Scope: Time Tracking
Columns
| Name | Type | Description |
| Id [KEY] | String | Id of the instance |
| Workers_Id [KEY] | String | The Workday ID of the Workers that owns this. |
| CloseTimeEntry | Datetime | The date and time when the period is closed for time entry. |
| Descriptor | String | A preview of the instance |
| LockTimeEntry | Datetime | The date and time when the period becomes locked out. |
| OpenTimeEntry | Datetime | The date and time when the period is open for time entry. |
| PaymentDate | Datetime | The payment date for periods whose period schedule's usage includes Payroll or Time Tracking without Payroll. |
| PeriodEndDate | Datetime | The end date of the payroll period or the absence subperiod. |
| PeriodStartDate | Datetime | The start date of the payroll period or the absence subperiod. |
| UnlockTimeEntry | Datetime | The date and time when the period is unlocked for time adjustments. |
| Date_Prompt | Date | The date on which the worker is eligible, using the yyyy-mm-dd format. If date isn't given it will default to the current Date. |
| IncludeTerminatedWorkers_Prompt | Bool | Include terminated workers in the output |
| Search_Prompt | String | Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search. |