v1

latestOpenAPI 3.1.02026-07-2414339465.7 KB

Create Year to Date Report

Create a year-to-date report.

post/reports/ytd

Request body

companyIDstring required

The ID of the company

employeeIDstring[]

Array of employee IDs to grab YTD data for. If this field is omitted, or an empty array is provided, then the report will include all employees

yearstring required

The year to query for the report

media_type'json' | 'csv' required

The media_type of the report

include_migratedboolean

Include migrated data in the report

Response

200

successboolean

Example response

{
  "success": true,
  "data": {
    "job_id": "4a25e61a9-9bd2-4445-ba70-f3e874d772d2",
    "status": "pending",
    "request_body": {
      "companyID": "fcc26cc444450ac8a33ry32a3z34462",
      "employeeID": [
        "6266y546eyecc34458aef1"
      ],
      "year": "2023",
      "media_type": "json",
      "has_live_key": true,
      "job_type": "reports",
      "report_format": "ytd"
    },
    "created_at": "2023-12-07T16:25:35.575Z"
  }
}