Skip to main content
GET
Get Reporting Period by ID
Zeal returns the corresponding reporting period with the given pay_schedule that is contained within the given start and end dates.
To find the correct reporting period using this endpoint, ensure that searchStart is less than or equal to the start date in the response, and that searchEnd is greater than or equal to the end date in the response.
This uses the same underlying endpoint as Get Reporting Period by ID - see that page for the formal parameter schema.

Authorizations

Authorization
string
header
required

Query Parameters

companyID
string
required

Company ID of the employer

reportingPeriodID
string
required

ID of Reporting period

Response

200

success
boolean
default:true
Example:

true

data
object