---
title: "Create new Deduction"
slug: "create-new-deduction"
updated: 2026-05-26T12:53:14Z
published: 2026-05-26T12:53:48Z
canonical: "developers.cmicglobal.com/create-new-deduction"
---
> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Create new Deduction
Post/hcm-rest-api/rest/1/pydeduction
## Create Deductions
UI Location: Human Capital Management - Human Resources - Benefit Administration - Deductions - Master
###
SecurityHTTPType basic
Basic authentication
Header parametersContent-TypestringExampleapplication/vnd.oracle.adf.resourceItem+json
Body parametersobject Example{
"DedCode": "LZT1",
"DedDescription": "TEST DESCRIPTION",
"DedShortDesc": "TEST SHORT",
"DedType": "D",
"DedBaseCode": "STAT",
"DedCalcSeq": "91231",
"DedForDepFlag": "N",
"DedAllocationMethod": "DEF"
}DedDescriptionstring Required
Describe the Deduction
💻 UI Fieldname: *Description
Max length30
DedBaseCodestring Required
Identify the Base code on which the value is to be applied
💻 UI Fieldname: Based On
Max length4
DedCodestring Required
Identify the Deduction
💻 UI Fieldname: *Code
Max length4
DedTypestring Required
Identify the Type as H/L/P
💻 UI Fieldname: *Type
Max length1
DedForDepFlagstring Required
💻 UI Fieldname: Dependents Enrollment Allowed
Max length1
DedShortDescstring Required
💻 UI Fieldname: *Short Description
Max length16
DedAllocationMethodstring Required
Job allocation method: DEF=default method, BASE=base wage, HRWK=hours worked, HRPD=hours paid. Currently only applicable for non-pw job allocation.
💻 UI Fieldname: *Job Allocation Based On
Max length4
DedCalcSeqnumber Required
💻 UI Fieldname: *Calculation Sequence
DedVUuidstring Max length64
DedGrpNamestring Max length30
DedPartialCfFlagstring Max length1
DedAmountnumber
Value of the deduction in appropriation to its type
💻 UI Fieldname: Amount
Max length18
DedLimitGrpNamestring Max length30
DedBaseNamestring Max length30
DedCreateApVoucherstring
💻 UI Fieldname: Create Voucher For Accts Payable
Max length1
DedProRatedFlagstring
Y: The Lump Sum deduction will be prorated
Max length2
DedLumpSum1planFlagstring
Applicable for EMPLOYEE LEVEL lump sum deduction. When Y only one plan/option will be deducted per pay period. This address for example health coverage whereby employee changes plan in the middle of a pay period.
💻 UI Fieldname: *Employee Level Lump Sum Deduction. Deduct Only One Plan Per Pay Period
Max length1
DedPrintOrdernumber
Identify Whether Benefit is because of Prevailing Wage restiricti
💻 UI Fieldname: Print Order
Max length4
DedIuCreateDatestring
DedExcludeFlagstring
Flag to show ifthis deduction is to be calculated when no wages exist.
💻 UI Fieldname: Exclude Without Wages
Max length1
DedInvoiceFlagstring
Include on Invoices
💻 UI Fieldname: Include on Invoices
Max length1
DedIuUpdateUserstring Max length30
DedDeptAllocationstring
The Burden will be allocated to the Timesheet Department
💻 UI Fieldname: Department Allocation
Max length1
DedIuCreateUserstring Max length30
DedJobAllocationstring
💻 UI Fieldname: Job Allocation
Max length1
DedUserstring
Name of the user who made last update
Max length30
DedInclPyFcBurdenCalstring
Y/N: Deduction Will Be Included Include In PY Forecast Burden Calculation, Available When PY FORECAST BURDEN CALCULATION Alternative Feature Is Installed
Max length1
DedIuUpdateDatestring
DedGrpCodestring
💻 UI Fieldname: Reporting Group
Max length4
DedWrlAllocationstring
💻 UI Fieldname: Work Location Allocation
Max length1
DedInclInRetropayCalcFlagstring
Yes to Include this Deductioni in Retropay Calculation
💻 UI Fieldname: Include In Retropay Processing
Max length1
DedEmplrContrstring
Employer Contribution Multiplier
💻 UI Fieldname: Employer Contribution
Max length1
DedLastUpdDatestring
Date and Time stamp of the last modification
DedPrioritynumber
Numeric Values
💻 UI Fieldname: Priority
Max length4
DedCfFlagstring
💻 UI Fieldname: Automatic Carry Forward
Max length1
DedLimitGrpCodestring
An optional code to group related deductions in order to apply a maximum limit on the sum.
💻 UI Fieldname: Maximum Limit Group Code
Max length4
DedPkgFlagstring
"Y: The Lump Sum Deduction will be part of Package calculation for Salary employee
Max length2
DedBasecdAllocationFlagstring
Y/N: Whether to job allocate based on user-defined base code definition (only applicable under certain conditions, see deduction maint. and PY processing). [N] will use original standard allocation.
💻 UI Fieldname: Job Allocate Using User-Defined Base Code
Max length1
DedMandatoryFlagstring
💻 UI Fieldname: Mandatory
Max length1
Responses201
Created
HeadersContent-TypestringExampleapplication/vnd.oracle.adf.resourceitem+json
```json
{
"DedCode": "LZT1",
"DedDescription": "TEST DESCRIPTION",
"DedShortDesc": "TEST SHORT",
"DedGrpCode": null,
"DedGrpName": null,
"DedType": "D",
"DedAmount": null,
"DedBaseCode": "STAT",
"DedBaseName": null,
"DedEmplrContr": null,
"DedJobAllocation": null,
"DedPriority": null,
"DedCfFlag": null,
"DedPrintOrder": null,
"DedCalcSeq": 91231,
"DedPartialCfFlag": null,
"DedMandatoryFlag": null,
"DedForDepFlag": "N",
"DedInvoiceFlag": null,
"DedWrlAllocation": null,
"DedCreateApVoucher": null,
"DedExcludeFlag": null,
"DedLimitGrpCode": null,
"DedLimitGrpName": null,
"DedDeptAllocation": null,
"DedAllocationMethod": "DEF",
"DedUser": null,
"DedLastUpdDate": null,
"DedBasecdAllocationFlag": null,
"DedInclPyFcBurdenCal": null,
"DedInclInRetropayCalcFlag": null,
"DedLumpSum1planFlag": null,
"DedIuCreateDate": null,
"DedIuCreateUser": null,
"DedIuUpdateDate": null,
"DedIuUpdateUser": null,
"DedProRatedFlag": null,
"DedPkgFlag": null,
"DedVUuid": "030B10A290630E79E06316821FAC49BA",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/030B10A290630E79E06316821FAC49BA",
"name": "pydeduction",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/hcm-rest-api/rest/1/pydeduction/030B10A290630E79E06316821FAC49BA",
"name": "pydeduction",
"kind": "item"
}
]
}
```
object