Create Pay Category

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",
    "excludeFromOrdinaryEarnings": "boolean",
    "externalId": "string",
    "generalLedgerMappingCode": "string",
    "hideUnitsOnPaySlip": "boolean",
    "id": "int32",
    "isAccLevyExempt": "boolean",
    "isGstExempt": "boolean",
    "isKiwiSaverExempt": "boolean",
    "isParentalLeave": "boolean",
    "isPrimary": "boolean",
    "isSuperannuationFund": "boolean",
    "isSystemPayCategory": "boolean",
    "isTaxExempt": "boolean",
    "name": "string",
    "numberOfDecimalPlaces": "int32",
    "parentId": "int32",
    "payCategoryType": "string",
    "penaltyLoadingPercent": "double",
    "rateLoadingPercent": "double",
    "rateUnit": "string",
    "roundingMethod": "string",
    "source": "string"
}

Properties

Name Type Description
accruesLeave boolean Boolean
excludeFromAverageEarnings boolean Boolean
excludeFromOrdinaryEarnings boolean Boolean
externalId string String
generalLedgerMappingCode string String
hideUnitsOnPaySlip boolean Boolean
id int32 Int32
isAccLevyExempt boolean Boolean
isGstExempt boolean Boolean
isKiwiSaverExempt boolean Boolean
isParentalLeave boolean Boolean
isPrimary boolean Boolean
isSuperannuationFund boolean Boolean
isSystemPayCategory boolean Boolean
isTaxExempt boolean Boolean
name string String
numberOfDecimalPlaces int32 Nullable
parentId int32 Nullable
payCategoryType string NzPayCategoryType

Possible values are:

  • Standard
  • OpeningBalanceAllowances
  • ExtraPay
  • RedundancyPayRetirementAllowance
  • AnnualHolidaysCashOut
  • HolidayPay
  • AccLevy
  • AverageEarnings
  • TerminationHolidayPay
  • TerminationAverageEarnings
  • TerminationRelevantDailyPay
  • RelevantDailyPay
  • TerminationPublicHolidayPay
  • GST
  • PublicHolidayWorked
  • PublicHolidayNotWorked
  • AlternativeHolidaysCashOut
penaltyLoadingPercent double Decimal
rateLoadingPercent double Decimal
rateUnit string RateUnitEnum

Possible values are:

  • Hourly
  • Annually
  • Fixed
  • Daily
  • Monthly
roundingMethod string Nullable

Possible values are:

  • ToEven
  • AwayFromZero
source string String

Response

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

Status code Description Resource
200 OK

OK

 NzPayCategoryModel