Get Reporting Period by ID

get/reportingPeriod

Request

Base URL
https://api.zeal.com
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/zeal/apis/zeal-api/docs/reportingPeriod/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

companyIDstring required

Company ID of the employer

reportingPeriodIDstring required

ID of Reporting period

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "reportingPeriodID": "5eb317a40d1158d5ddcb6895",
    "pay_schedule": "weekly",
    "start": "2020-05-06",
    "end": "2020-05-12"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.