Pay Conditions Comparison Report

Generates the pay conditions comparison report as JSON, grouped by primary location then employee.

Request

GET http:///api/v2/business/{businessId}/report/payconditioncomparison

Path parameters

Parameter name Value Description Additional
businessId string Required

Query parameters

Parameter name Value Description Additional
PeriodSelectionType string

Possible values are:

  • ServicePeriod
  • DateRange
  • PayRun
StartDate date-time
EndDate date-time
PayScheduleId int32
PayRunId int32
ServicePeriodType string

Possible values are:

  • CurrentYear
  • PreviousYear
  • Custom
ServicePeriodStartDate date-time
ServicePeriodEndDate date-time
EmployingEntityId int32
LocationId int32
EmployeeId int32
NegativeVariancesOnly boolean

Response

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

Status code Description Resource
200 OK

OK

 PccReportApiModel
403 Forbidden

Forbidden

 ProblemDetails
409 Conflict

Conflict

 ProblemDetails