Create Employee Additional Earning

Creates a new additional earning for the employee.

Request

POST https://api.nzpayroll.co.nz/api/v2/business/{businessId}/employee/{employeeId}/additional-earnings

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

{
    "amount": "double",
    "employeeId": "int32",
    "expiryDate": "date-time",
    "id": "int64",
    "includeInRdpOrOwp": "boolean",
    "locationId": "int32",
    "maximumAmountPaid": "double",
    "notes": "string",
    "overrideSuperRate": "boolean",
    "payCategoryId": "int32",
    "reduceAllowance": "boolean",
    "superRate": "double",
    "units": "double"
}

Properties

Name Type Description
amount double Decimal
employeeId int32 Int32
expiryDate date-time Nullable
id int64 Int64
includeInRdpOrOwp boolean Boolean
locationId int32 Nullable
maximumAmountPaid double Nullable
notes string String
overrideSuperRate boolean Boolean
payCategoryId int32 Nullable
reduceAllowance boolean Boolean
superRate double Nullable
units double Decimal

Response

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

Status code Description Resource
200 OK

OK

 NzAdditionalEarningsModel