Create payslip configuration

Creates the payslip configuration for the specified business ID.

ShowLineNotes field must be enabled in order to enable the ShowLocationInLineNotes field.

An example of what you would populate the EmailBodyMessage field with would be:

Hi {{FirstName}},

{{BusinessName}} has just processed your pay and a new pay slip is available.

Regards {{BusinessName}}

Request

POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/payslip

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "alphabetisePayCategories": "boolean",
    "emailBodyMessage": "string",
    "emailFrom": "string",
    "employeesMustLoginToDownloadPayslips": "boolean",
    "id": "int32",
    "showBasePayRate": "boolean",
    "showClassification": "boolean",
    "showEmployeeExternalId": "boolean",
    "showEmployeeId": "boolean",
    "showKiwiSaverPercentages": "boolean",
    "showLeaveAccruals": "boolean",
    "showLineNotes": "boolean",
    "showLocationInLineNotes": "boolean",
    "showRateForAnnualEarnings": "boolean",
    "showUnitsWorked": "boolean"
}

Properties

Name Type Description
alphabetisePayCategories boolean Boolean
emailBodyMessage string String
emailFrom string String
employeesMustLoginToDownloadPayslips boolean Boolean
id int32 Int32
showBasePayRate boolean Boolean
showClassification boolean Boolean
showEmployeeExternalId boolean Boolean
showEmployeeId boolean Boolean
showKiwiSaverPercentages boolean Boolean
showLeaveAccruals boolean Boolean
showLineNotes boolean Boolean
showLocationInLineNotes boolean Boolean
showRateForAnnualEarnings boolean Boolean
showUnitsWorked boolean Nullable

Response

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

Status code Description Resource
200 OK

OK