Get Reporting Period by Date Range

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

Zeal will return the corresponding reporting period with the given pay_schedule that is contained within the given start and end dates.

📘

In order to find the correct reporting period using this endpoint, you must 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.

Returns

Returns response status and an array of matching Reporting Periods

attribute	type	description
success	boolean	Response status
data	array	List of Reporting Periods
errors	array	Contains list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

companyID

string

required

Company ID of the employer

reportingPeriodID

string

required

ID of Reporting period

``200 200

``404 404

Updated 7 months ago

ShellNodeRubyPHPPython


xxxxxxxxxx

curl --request GET \
     --url https://api.zeal.com/reportingPeriod \
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result404 - Result

URL Expired

In order to find the correct reporting period using this endpoint, you must 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.

Returns

``200 200

``404 404

In order to find the correct reporting period using this endpoint, you must 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.