PR
PRDeductCode
Includes the settings of the deduction or benefit code.
View API Entity: DeductionBenefitCode
/entity/Default/25.200.001/DeductionBenefitCode| Field Name | Type | Display Name | Foreign Key | |
|---|---|---|---|---|
AcaApplicable API | bit | ACA Applicable | - | |
Description:No description available | ||||
AffectsTaxes API | bit | Affects Tax Calculation | - | |
Description:A boolean value that specifies (if set to true) that the code affects the tax calculation. | ||||
AllowSupplementalElection | bit | Include Supplemental Earnings | - | |
Description:A boolean value that specifies (if set to true) that supplemental earnings are included in the calculation of this deduction and benefit code. | ||||
string | Associated With | - | ||
Description:No description available | ||||
BAccountID API | int | Vendor | Vendor | |
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. | ||||
BenefitCalculationMethod | int | Calculation Method | - | |
Description:A code that determines which calculation method the deduction will use. | ||||
BenefitExpenseAcctID | int | Benefit Expense Account | Account | |
Description:The unique identifier of the expense account to be used by default to record the benefit to employee paycheck. The field is included in FK.BenefitExpenseAccount. | ||||
BenefitExpenseSubID | int | Benefit Expense Sub. | Sub | |
Description:The unique identifier of the corresponding subaccount used with the benefit expense account. The field is included in FK.BenefitExpenseSubaccount. | ||||
BenefitLiabilityAcctID | int | Benefit Liability Account | Account | |
Description:The unique identifier of the liability account to be used by default to off-set the benefit expense account. The field is included in FK.BenefitLiabilityAccount. | ||||
BenefitLiabilitySubID | int | Benefit Liability Sub. | Sub | |
Description:The unique identifier of the corresponding subaccount used with the benefit liability account. The field is included in FK.BenefitLiabilitySubaccount. | ||||
BenefitTypeCD | int | Code Type | - | |
Description:The user-friendly unique identifier of the benefit type that is used for reporting and calculation purposes. | ||||
BenefitTypeCDCAN | int | Code Type | PRDynType | |
Description:The benefit type that is used for reporting and calculation purposes in Canada. | ||||
BenefitsIncreasingWageIncludeType | nvarchar(3) | Inclusion Type | - | |
Description:The way earning types are selected for the calculation of the applicable benefit. The field can have one of the values described in SubjectToTaxes.ListAttribute. | ||||
CertifiedReportType | int | Certified Reporting Type | - | |
Description:The type used for certified reporting. | ||||
CntAmount | decimal | Amount | - | |
Description:The contribution amount to be used if the calculation method is set to either DedCntCalculationMethod.FixedAmount or DedCntCalculationMethod.AmountPerHour. | ||||
CntApplicableEarnings | char(3) | Applicable Earnings | - | |
Description:A restriction on the use of earning types in the calculation of employer contributions based on the categories of those earning types. | ||||
CntCalcType | char(3) | Calculation Method | - | |
Description:The method to be used for determining the contribution amount. The field can have one of the values described in DedCntCalculationMethod.ListAttribute. | ||||
CntMaxAmount | decimal | Limit Amount | - | |
Description:The contribution amount cap. | ||||
CntMaxFreqType | char(3) | Limit Frequency | - | |
Description:How often the maximum contribution amount (if any) specified in the following box is to be applied. The field can have one of the values described in DeductionMaxFrequencyType.ListAttribute. | ||||
CntPercent | decimal | Percent | - | |
Description:The contribution percentage to be used if the calculation method is set to either DedCntCalculationMethod.PercentOfGross or DedCntCalculationMethod.PercentOfNet. | ||||
CntQuebecReportTypeCAN | int | Quebec Reporting Type | PRDynType | |
Description:The contribution reporting type for Quebec. | ||||
CntReportType | int | Reporting Type | - | |
Description:A code that determines which reporting type the contribution will use. | ||||
CntReportTypeCAN | int | Federal Reporting Type | PRDynType | |
Description:The contribution type that is used for reporting and calculation purposes in Canada. | ||||
CodeCD API | nvarchar(15) | Code | - | |
Description:The user-friendly unique identifier of the code. | ||||
CodeID | int | Code ID | - | |
Description:The unique identifier of the code. | ||||
ContribType API | char(3) | Contribution Type | - | |
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. | ||||
ContributesToBenefitApplicableWage | bit | Contributes to Benefit Applicable Wage | - | |
Description:A boolean value that specifies (if set to true) that the amount of the benefit increases the applicable wage. | ||||
ContributesToGrossCalculation | bit | Contributes to Gross Calculation | - | |
Description:A boolean value that specifies (if set to true) that the deduction or benefit produces no financial transactions. | ||||
CountryID | char(2) | Country | ||
Description:The unique identifier of the country to which the deduction or benefit corresponds. The field is included in FK.State and FK.Country. | ||||
CreatedByID | uniqueidentifier | Created By | Users | |
Description:No description available | ||||
CreatedByScreenID | char(8) | - | ||
Description:No description available | ||||
CreatedDateTime | datetime | - | ||
Description:No description available | ||||
DedAmount | decimal | Amount | - | |
Description:The deduction amount to be used if the calculation method is set to either DedCntCalculationMethod.FixedAmount or DedCntCalculationMethod.AmountPerHour. | ||||
DedApplicableEarnings | char(3) | Applicable Earnings | - | |
Description:A restriction on the use of earning types in the calculation of employee deductions based on the categories of those earning types. | ||||
DedCalcType | char(3) | Calculation Method | - | |
Description:The method to be used for determining the deduction amount. The field can have one of the values described in DedCntCalculationMethod.ListAttribute. | ||||
DedInvDescrType API | char(3) | Invoice Description Source | - | |
Description:The way the description of the vendor invoice is generated. The field can have one of the values described in InvoiceDescriptionType.DeductionInvoiceDescriptionListAttribute. | ||||
DedLiabilityAcctID | int | Deduction Liability Account | Account | |
Description:The unique identifier of the liability account used by default to record the deduction from employee paycheck. The field is included in FK.DeductionLiabilityAccount. | ||||
DedLiabilitySubID | int | Deduction Liability Sub. | Sub | |
Description:The unique identifier of the corresponding subaccount used with the deduction liability account. The field is included in FK.DeductionLiabilitySubaccount. | ||||
DedMaxAmount | decimal | Limit Amount | - | |
Description:The deduction amount cap. | ||||
DedMaxFreqType | char(3) | Limit Frequency | - | |
Description:How often the maximum deduction amount (if any) specified in the following box is to be applied. The field can have one of the values described in DeductionMaxFrequencyType.ListAttribute. | ||||
DedPercent | decimal | Percent | - | |
Description:The deduction percentage to be used if the calculation method is set to either DedCntCalculationMethod.PercentOfGross or DedCntCalculationMethod.PercentOfNet. | ||||
DedQuebecReportTypeCAN | int | Quebec Reporting Type | PRDynType | |
Description:The deduction reporting type for Quebec. | ||||
DedReportType | int | Reporting Type | - | |
Description:A code that determines which reporting type the deduction will use. | ||||
DedReportTypeCAN | int | Federal Reporting Type | PRDynType | |
Description:The deduction type that is used for reporting and calculation purposes in Canada. | ||||
DeductionsDecreasingWageIncludeType | nvarchar(3) | Inclusion Type | - | |
Description:The way earning types are selected for the calculation of the applicable deduction. The field can have one of the values described in SubjectToTaxes.ListAttribute. | ||||
Description API | nvarchar(60) | Description | - | |
Description:The description of the code to appear in such places as box selectors and pay stubs. | ||||
EarningsIncreasingWageIncludeType | nvarchar(3) | Inclusion Type | - | |
Description:The way earning types are selected for the calculation of the applicable earning. The field can have one of the values described in SubjectToTaxes.ListAttribute. | ||||
IncludeType | char(3) | Impact on Taxable Wage | - | |
Description:The method to be used to determine the list of applicable taxes. The field can have one of the values described in SubjectToTaxes.ListForDeductionTaxabilityAttribute. | ||||
IsActive API | bit | Active | - | |
Description:A boolean value that specifies (if set to true) that the code is available for use. | ||||
IsCertifiedProject | bit | - | ||
Description:A boolean value that specifies (if set to true) that the code is tied to a construction project. | ||||
IsGarnishment API | bit | Garnishment | - | |
Description:A boolean value that specifies (if set to true) that the code is to be used for a garnishment. | ||||
IsPayableBenefit API | bit | Payable Benefit | - | |
Description:A boolean value that specifies (if set to true) that the code may contribute to gross calculation. | ||||
IsUnion | bit | - | ||
Description:A boolean value that specifies (if set to true) that the code is provided through a union. | ||||
IsWorkersCompensation | bit | - | ||
Description:A boolean value that specifies (if set to true) that the code represents some form of employee compensation. | ||||
LastModifiedByID | uniqueidentifier | Last Modified By | Users | |
Description:No description available | ||||
LastModifiedByScreenID | char(8) | - | ||
Description:No description available | ||||
LastModifiedDateTime API | datetime | - | ||
Description:No description available | ||||
MinimumIndividualContribution | decimal | Minimum Individual Contribution | - | |
Description:No description available | ||||
NoFinancialTransaction | bit | No Financial Transaction | - | |
Description:A boolean value that specifies (if set to true) that the deduction or benefit produces no financial transactions. | ||||
NoteID | uniqueidentifier | - | ||
Description:No description available | ||||
bool? | - | |||
Description:No description available | ||||
ShowCANTaxSettingsTabNonexistent in DB | bool? | - | ||
Description:No description available | ||||
ShowUSTaxSettingsTabNonexistent in DB | bool? | - | ||
Description:No description available | ||||
State | nvarchar(50) | State | State | |
Description:The state or province to which the deduction or benefit corresponds. The field is included in FK.State. | ||||
TStamp | timestamp | - | ||
Description:No description available | ||||
TaxesDecreasingWageIncludeType | nvarchar(3) | Inclusion Type | - | |
Description:The way earning types are selected for the calculation of the applicable tax which decreases wages. The field can have one of the values described in SubjectToTaxes.ListAttribute. | ||||
TaxesIncreasingWageIncludeType | nvarchar(3) | Inclusion Type | - | |
Description:The way earning types are selected for the calculation of the applicable tax which increases wages. The field can have one of the values described in SubjectToTaxes.ListAttribute. | ||||
VndInvDescr API | nvarchar(60) | Vendor Invoice Description | - | |
Description:The description that you enter for the vendor invoice. | ||||
WorkCodeIDObsolete | nvarchar(15) | Workers' Compensation Code | - | |
Description:No description available | ||||