Create a custom report

POST {{baseUrl}}/v1/companies/:company_uuid/reports

Create a custom report for a company. This endpoint initiates creating a custom report with custom columns, groupings, and filters. The request_uuid in the response can then be used to poll for the status and report URL upon completion using the report GET endpoint.

scope: company_reports:write

Request Body

{"columns"=>["<string>", "<string>"], "groupings"=>["<string>", "<string>"], "file_type"=>"<string>", "custom_name"=>"<string>", "with_totals"=>false, "start_date"=>"<date>", "end_date"=>"<date>", "dismissed_start_date"=>"<date>", "dismissed_end_date"=>"<date>", "payment_method"=>"<string>", "employment_type"=>"<string>", "employment_status"=>"<string>", "employee_uuids"=>["<string>", "<string>"], "department_uuids"=>["<string>", "<string>"], "work_address_uuids"=>["<string>", "<string>"]}

HEADERS

RESPONSES

status: OK

{"file_type":"csv","request_uuid":"p83d0ca8-7d41-42a9-834y-7d218ef6cb20","company_uuid":"z83d0ca8-7d41-42a9-834y-7d218ef6cb20","custom_name":"CustomReport"}