Creates a new pay category for the business.

Request

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

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "accruesLeave": "boolean",
    "excludeFromAverageEarnings": "boolean",
    "externalId": "string",
    "generalLedgerMappingCode": "string",
    "id": "int32",
    "isAccLevyExempt": "boolean",
    "isKiwiSaverExempt": "boolean",
    "isSystemPayCategory": "boolean",
    "isTaxExempt": "boolean",
    "name": "string",
    "numberOfDecimalPlaces": "int32",
    "parentId": "int32",
    "penaltyLoadingPercent": "double",
    "rateLoadingPercent": "double",
    "rateUnit": "string",
    "source": "string"
}

Properties

Name Type Description
accruesLeave boolean Boolean
excludeFromAverageEarnings boolean Boolean
externalId string String
generalLedgerMappingCode string String
id int32 Int32
isAccLevyExempt boolean Boolean
isKiwiSaverExempt boolean Boolean
isSystemPayCategory boolean Boolean
isTaxExempt boolean Boolean
name string String
numberOfDecimalPlaces int32 Nullable
parentId int32 Nullable
penaltyLoadingPercent double Decimal
rateLoadingPercent double Decimal
rateUnit string RateUnitEnum

Possible values are:

  • Hourly
  • Annually
  • Fixed
  • Daily
source string String

Response

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

Status code Description Resource
200 OK

OK