Creates a new pay run for this business.
POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/payrun
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
The request body takes a complete PayRunCreateRequest resource, containing the following writable properties:
{
"adhoc": "boolean",
"callbackUrl": "string",
"createWithEmptyPays": "boolean",
"datePaid": "date-time",
"externalId": "string",
"payPeriodEnding": "date-time",
"payScheduleId": "int32",
"timesheetImportOption": "string"
}
Name | Type | Description |
---|---|---|
adhoc | boolean |
Nullable |
callbackUrl | string | String |
createWithEmptyPays | boolean |
Nullable |
datePaid | date-time | DateTime |
externalId | string | String |
payPeriodEnding | date-time | DateTime |
payScheduleId | int32 | Int32 |
timesheetImportOption | string |
Nullable Possible values are:
|
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
PayRunModel |
Powered by DapperDox