Detailed Activity Report as Excel

Generates a Detailed Activity Report as an Excel file.

Request

GET http:///api/v2/business/{businessId}/report/detailedactivity/xlsx

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
FromDate date-time
ToDate date-time
GroupBy string

Possible values are:

  • EarningsLocation
  • RollUpLocation
  • DefaultLocation
FilterType string

Possible values are:

  • DateRange
  • PayRun
  • SuperBatch
PayRunId int32
PayScheduleId int32
LocationsIds array of int32, multiple occurances
EmployeeIds array of int32, multiple occurances
IncludePostTaxDeductions boolean
ShowLocationTotalsOnly boolean
IncludeEmployeePayRunBreakdown boolean

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

OK

 ByteArrayContent