Import a new pay schedule.

Creates a new pay schedule for the business by importing from external data. The pay schedule defines how frequently employees are paid and related configuration.

Example request body: { "name": "Weekly Pay Schedule", "frequency": "Weekly", "includedEmployees": "All", "monthlyPaymentMode": false, "proRataCalculations": true, "unitType": "Days per year", "unit": 260, "qualifyingDays": "Working days", "locations": [1, 2, 3], "paySlipMessage": "Custom message for pay slips" }

Request

POST http:///api/v2/business/{businessId}/import/pay-schedule

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "frequency": "string",
    "includedEmployees": "string",
    "locations": [
        "int32"
    ],
    "monthlyPaymentMode": "boolean",
    "name": "string",
    "paySlipMessage": "string",
    "payeSchemeId": "int32",
    "paymentFileId": "int32",
    "proRataCalculations": "boolean",
    "qualifyingDays": "string",
    "unit": "double",
    "unitType": "string"
}

Properties

Name Type Description
frequency string String
includedEmployees string String
locations[] array of int32
monthlyPaymentMode boolean Nullable
name string String
paySlipMessage string String
payeSchemeId int32 Nullable
paymentFileId int32 Nullable
proRataCalculations boolean Nullable
qualifyingDays string String
unit double Nullable
unitType string String

Response

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

Status code Description Resource
200 OK

OK
400 Bad Request

Bad Request

 ProblemDetails