Creates a new recurring deduction for the employee.
POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/employee/{employeeId}/deduction
Parameter name | Value | Description | Additional |
---|---|---|---|
businessId | string | Required | |
employeeId | string | Required |
The request body takes a complete AuEmployeeRecurringDeductionModel resource, containing the following writable properties:
{
"additionalData": "int32",
"amount": "double",
"carryForwardUnpaidDeductions": "boolean",
"carryForwardUnusedPreservedEarnings": "boolean",
"deductionCategoryId": "int32",
"deductionType": "string",
"deleted": "boolean",
"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",
"totalAmountPaid": "double"
}
Name | Type | Description |
---|---|---|
additionalData | int32 |
Nullable |
amount | double | Decimal |
carryForwardUnpaidDeductions | boolean | Boolean |
carryForwardUnusedPreservedEarnings | boolean | Boolean |
deductionCategoryId | int32 | Int32 |
deductionType | string |
DeductionTypeEnum
Possible values are:
|
deleted | boolean | Boolean |
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 |
AuEmployeeRecurringDeductionPaidToEnum
Possible values are:
|
paidToAccountId | int32 | Int32 |
paymentReference | string | String |
preservedEarnings | string |
PreservedEarningsCalculationTypeEnum
Possible values are:
|
preservedEarningsAmount | double | Decimal |
preservedEarningsAmountNotReachedAction | string |
DeductionAmountNotReachedEnum
Possible values are:
|
priority | int32 |
Nullable |
totalAmountPaid | double | Decimal |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK OK |
AuEmployeeRecurringDeductionModel |
Powered by DapperDox