Create Pay Rate Template

Creates a new pay rate template for the business.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "externalId": "string",
    "id": "int32",
    "name": "string",
    "payCategories": [
        {
            "calculatedRate": "double",
            "payCategoryId": "int32",
            "standardWeeklyHours": "double",
            "userSuppliedRate": "double"
        }
    ],
    "primaryPayCategoryId": "int32",
    "reapplyToLinkedEmployees": "boolean",
    "source": "string"
}

Properties

Name Type Description
externalId string String
id int32 Int32
name string String
payCategories[] array
payCategories[].calculatedRate double Decimal
payCategories[].payCategoryId int32 Int32
payCategories[].standardWeeklyHours double Decimal
payCategories[].userSuppliedRate double Decimal
primaryPayCategoryId int32 Int32
reapplyToLinkedEmployees boolean Boolean
source string String

Response

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

Status code Description Resource
200 OK

OK

 PayRateTemplateExportModel