Creates a new pay schedule for the business.
POST https://keypay.yourpayroll.com.au/api/v2/business/{businessId}/payschedule
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required |
The request body takes a complete PayScheduleModel resource, containing the following writable properties:
{
"abaDetailsId": "int32",
"employeeSelectionStrategy": "string",
"externalId": "string",
"frequency": "string",
"id": "int32",
"lastDatePaid": "date-time",
"lastPayRun": "date-time",
"locations": [
"int32"
],
"name": "string",
"source": "string"
}
Name | Type | Description |
---|---|---|
abaDetailsId | int32 |
Nullable |
employeeSelectionStrategy | string |
Nullable Possible values are:
|
externalId | string | String |
frequency | string |
PayCycleFrequencyEnum
Possible values are:
|
id | int32 | Int32 |
lastDatePaid | date-time |
Nullable |
lastPayRun | date-time |
Nullable |
locations[] | array of int32 | |
name | string | String |
source | string | String |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
Powered by DapperDox