Skip to main content
API Family:Default
Version:23.200.001
Screen ID:PR101060

Properties

Select a row for its DAC field and description
PropertyTypeData Type
ACAApplicableBooleanValueboolean
DAC Field:PX.Objects.PR.PRDeductCode.AcaApplicable
Description:No description available
ACAInformationACAInformationACAInformation
DAC Field:Not mapped to a DAC field
Description:No description available
ActiveBooleanValueboolean
DAC Field:PX.Objects.PR.PRDeductCode.IsActive
Description:A boolean value that specifies (if set to true) that the code is available for use.
AffectsTaxCalculationBooleanValueboolean
DAC Field:PX.Objects.PR.PRDeductCode.AffectsTaxes
Description:A boolean value that specifies (if set to true) that the code affects the tax calculation.
ApplicableWageApplicableWageApplicableWage
DAC Field:Not mapped to a DAC field
Description:No description available
AssociatedWithStringValuestring
DAC Field:PX.Objects.PR.PRDeductCode.AssociatedSource
Description:No description available
ContributionTypeStringValuestring
DAC Field:PX.Objects.PR.PRDeductCode.ContribType
Description:The type of a code that defines how the code affects employee earnings. The field can have one of the values described in ContributionTypeListAttribute.
DeductionBenefitCodeIDStringValuestring
DAC Field:PX.Objects.PR.PRDeductCode.CodeCD
Description:The user-friendly unique identifier of the code.
DescriptionStringValuestring
DAC Field:PX.Objects.PR.PRDeductCode.Description
Description:The description of the code to appear in such places as box selectors and pay stubs.
EmployeeDeductionEmployeeDeductionEmployeeDeduction
DAC Field:Not mapped to a DAC field
Description:No description available
EmployerContributionEmployerContributionEmployerContribution
DAC Field:Not mapped to a DAC field
Description:No description available
GLAccountsDeductionOrBenefitCodeGLAccountsDeductionOrBenefitCodeGLAccounts
DAC Field:Not mapped to a DAC field
Description:No description available
InvoiceDescrSourceStringValuestring
DAC Field:PX.Objects.PR.PRDeductCode.DedInvDescrType
Description:The way the description of the vendor invoice is generated. The field can have one of the values described in InvoiceDescriptionType.DeductionInvoiceDescriptionListAttribute.
IsGarnishmentBooleanValueboolean
DAC Field:PX.Objects.PR.PRDeductCode.IsGarnishment
Description:A boolean value that specifies (if set to true) that the code is to be used for a garnishment.
LastModifiedDateTimeDateTimeValueDateTime
DAC Field:PX.Objects.PR.PRDeductCode.LastModifiedDateTime
Description:No description available
PayableBenefitBooleanValueboolean
DAC Field:PX.Objects.PR.PRDeductCode.IsPayableBenefit
Description:A boolean value that specifies (if set to true) that the code may contribute to gross calculation.
ShowApplicableWageTabBooleanValueboolean
DAC Field:PX.Objects.PR.PRDeductCode.ShowApplicableWageTab
Description:No description available
TaxSettingsCATaxSettingsCATaxSettingsCA
DAC Field:Not mapped to a DAC field
Description:No description available
TaxSettingsUSTaxSettingsUSTaxSettingsUS
DAC Field:Not mapped to a DAC field
Description:No description available
VendorStringValuestring
DAC Field:PX.Objects.PR.PRDeductCode.BAccountID
Description:The unique identifier of the vendor that will be owed the liability resulting from the deduction or benefit. The field is included in FK.Vendor.
VendorInvoiceDescriptionStringValuestring
DAC Field:PX.Objects.PR.PRDeductCode.VndInvDescr
Description:The description that you enter for the vendor invoice.
WCCCodeDeductionBenefitWCCCodeDeductionBenefitWCCCode
DAC Field:Not mapped to a DAC field
Description:No description available

Minimum Payload

Derived from static analysis of the 2025.2 source; runtime configuration may require additional fields.

5 required fields
{
  "ContributionType": {
    "value": "string"
  },
  "DeductionBenefitCodeID": {
    "value": "string"
  },
  "Description": {
    "value": "string"
  },
  "InvoiceDescrSource": {
    "value": "string"
  },
  "VendorInvoiceDescription": {
    "value": "string"
  }
}

For every property this entity accepts, see the properties table.

Optional Children

None of these child collections is required — a payload without them is valid. If you do include one, these are the fields each row of it needs; keys the parent record supplies are named separately and must not be sent.

  • EmployeeDeductiona nested EmployeeDeductionrequired if you include one:AmountMaximumAmountPercent
  • EmployerContributiona nested EmployerContributionrequired if you include one:AmountMaximumAmountPercent

Available in Versions