Skip to main content
POST
Create Year to Date Report

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

The ID of the company

year
string
required

The year to query for the report

media_type
enum<string>
default:json
required

The media_type of the report

Available options:
json,
csv
employeeID
string[]

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

include_migrated
boolean
default:false

Include migrated data in the report

Response

200

success
boolean
default:true
Example:

true

data
object