Creates a new recurring super adjustment for the employee.


POST http://keypay.yourpayroll.local/api/v2/business/{businessId}/employee/{employeeId}/superadjustment

Path parameters

Parameter name Value Description Additional
businessId string Required
employeeId string Required

Request body

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

    "adjustmentType": "string",
    "amount": "double",
    "contributionType": "string",
    "employeeId": "int32",
    "expiryDate": "date-time",
    "fromDate": "date-time",
    "id": "int32",
    "isActive": "boolean",
    "maximumAmountPaid": "double",
    "notes": "string",
    "totalAmountPaid": "double"


Name Type Description
adjustmentType string SuperAdjustmentTypeEnum

Possible values are:

  • Fixed
  • PercentageGross
  • PercentageOTE
  • PercentageTaxableEarnings
amount double Decimal
contributionType string SuperContributionType

Possible values are:

  • SuperGuarantee
  • SalarySacrifice
  • MemberVoluntary
  • EmployerContribution
employeeId int32 Int32
expiryDate date-time Nullable
fromDate date-time DateTime
id int32 Nullable
isActive boolean Boolean
maximumAmountPaid double Nullable
notes string String
totalAmountPaid double Decimal


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

Status code Description Resource
200 OK