Updates the employee's recurring deduction with the specified ID.
PUT https://keypay.yourpayroll.com.au/api/v2/business/{businessId}/employee/{employeeId}/deduction/{id}
Parameter name | Value | Description | Additional |
---|---|---|---|
id | int32 | Required | |
businessId | string | Required | |
employeeId | string | Required |
The request body takes a complete EmployeeRecurringDeductionModel resource, containing the following writable properties:
{
"amount": "double",
"carryForwardAmount": "double",
"carryForwardUnpaidDeductions": "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": "boolean",
"preservedEarningsAmount": "double",
"preservedEarningsAmountNotReachedAction": "string",
"totalAmountPaid": "double"
}
Name | Type | Description |
---|---|---|
amount | double | Decimal |
carryForwardAmount | double | Decimal |
carryForwardUnpaidDeductions | boolean | Boolean |
deductionCategoryId | int32 | Int32 |
deductionType | string |
DeductionTypeEnum
Possible values are:
|
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:
|
paidToAccountId | int32 | Int32 |
paymentReference | string | String |
preservedEarnings | boolean | Boolean |
preservedEarningsAmount | double | Decimal |
preservedEarningsAmountNotReachedAction | string |
DeductionAmountNotReachedEnum
Possible values are:
|
totalAmountPaid | double | Decimal |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
EmployeeRecurringDeductionModel |