Generates a Gross To Net Report as an Excel file.
GET https://api.yourpayroll.co.uk/api/v2/business/{businessId}/report/grosstonet/xlsx
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
Parameter name | Value | Description | Additional |
---|---|---|---|
request.employeeId | int32 | ||
request.payCategoryIds | array of int32, multiple occurances | ||
request.groupBy | string | ||
request.payRunId | int32 | ||
request.filterType | string |
Possible values are:
|
|
request.includeExpenses | boolean | ||
request.payScheduleId | int32 | ||
request.includePostTaxDeductions | boolean | ||
request.fromDate | date-time | ||
request.toDate | date-time | ||
request.locationId | int32 | ||
request.employingEntityId | int32 |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
ByteArrayContent |
Powered by DapperDox