Create Pay Run

Creates a new pay run for this business.

Request

POST http:///api/v2/business/{businessId}/payrun

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

The request body takes a complete PayRunCreateRequest resource, containing the following writable properties:

{
    "adhoc": "boolean",
    "callbackUrl": "string",
    "createWithEmptyPays": "boolean",
    "datePaid": "date-time",
    "externalId": "string",
    "includeTerminatedEmployees": "boolean",
    "payPeriodEnding": "date-time",
    "payScheduleId": "int32",
    "timesheetImportOption": "string"
}

Properties

Name Type Description
adhoc boolean Nullable
callbackUrl string String
createWithEmptyPays boolean Nullable
datePaid date-time DateTime
externalId string String
includeTerminatedEmployees boolean Nullable
payPeriodEnding date-time DateTime
payScheduleId int32 Int32
timesheetImportOption string Nullable

Possible values are:

  • None
  • ThisPayPeriod
  • AllOutstanding
  • CustomPeriod

Response

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

Status code Description Resource
200 OK

OK

 UkPayRunModel