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	Supported for: SELECT. The date and time when the period is closed for time entry.
Descriptor	String	Supported for: SELECT. A preview of the instance
LockTimeEntry	Datetime	Supported for: SELECT. The date and time when the period becomes locked out.
OpenTimeEntry	Datetime	Supported for: SELECT. The date and time when the period is open for time entry.
PaymentDate	Datetime	Supported for: SELECT. The payment date for periods whose period schedule's usage includes Payroll or Time Tracking without Payroll.
PeriodEndDate	Datetime	Supported for: SELECT. The end date of the payroll period or the absence subperiod.
PeriodStartDate	Datetime	Supported for: SELECT. The start date of the payroll period or the absence subperiod.
UnlockTimeEntry	Datetime	Supported for: SELECT. 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	Only used when a Workers_Id filter is not provided. Include terminated workers in the output
Search_Prompt	String	Only used when a Workers_Id filter is not provided. Searches workers by name or worker ID. The search is case-insensitive. You can include space-delimited search strings for an OR search.