Methods

  • get - Get Employee Deduction by ID
  • get - List Employee Deductions
  • post - Create Employee Deduction
  • put - Update Employee Deduction

Resource

[
    {
        "additionalData": "int32",
        "amount": "double",
        "carryForwardUnpaidDeductions": "boolean",
        "carryForwardUnusedPreservedEarnings": "boolean",
        "deductionCategoryId": "int32",
        "deductionType": "string",
        "employeeId": "int32",
        "expiryDate": "date-time",
        "externalReferenceId": "string",
        "fromDate": "date-time",
        "id": "int32",
        "isActive": "boolean",
        "maximumAmountPaid": "double",
        "name": "string",
        "notes": "string",
        "paidTo": "string",
        "paidToAccountId": "int32",
        "paymentReference": "string",
        "preservedEarnings": "string",
        "preservedEarningsAmount": "double",
        "preservedEarningsAmountNotReachedAction": "string",
        "priority": "int32",
        "studentLoanDeductionOption": "string",
        "totalAmountPaid": "double"
    }
]

Properties

Name Type Description
additionalData int32 Nullable
amount double Decimal
carryForwardUnpaidDeductions boolean Boolean
carryForwardUnusedPreservedEarnings boolean Boolean
deductionCategoryId int32 Int32
deductionType string DeductionTypeEnum

Possible values are:

  • NotSet
  • Fixed
  • PercentageGross
  • PercentageOTE
  • PercentageStudentLoan
  • PercentageNet
  • Tiered
employeeId int32 Int32
expiryDate date-time Nullable
externalReferenceId string String
fromDate date-time DateTime
id int32 Nullable
isActive boolean Boolean
maximumAmountPaid double Nullable
name string String
notes string String
paidTo string EmployeeRecurringDeductionPaidToEnum

Possible values are:

  • Manual
  • BankAccount
  • SuperFund
  • Bpay
  • PensionScheme
  • TaxOffice
paidToAccountId int32 Int32
paymentReference string String
preservedEarnings string PreservedEarningsCalculationTypeEnum

Possible values are:

  • Never
  • Amount
  • Percentage
preservedEarningsAmount double Decimal
preservedEarningsAmountNotReachedAction string DeductionAmountNotReachedEnum

Possible values are:

  • DoNotPay
  • PayToLimit
priority int32 Nullable
studentLoanDeductionOption string Nullable

Possible values are:

  • ApplyStudentLoanFirst
  • ApplyDeductionFirst
  • DoNotApplyStudentLoan
totalAmountPaid double Decimal