Employment Hero Payroll API Reference: DeductionCategoryEditModel

Methods

post - Create Import Deduction Categories

Resource

{
    "calculationBasis": "string",
    "cisType": "string",
    "deductionCategoryName": "string",
    "defaultPercentageRate": "double",
    "excludedPayCategoryIds": [
        "int32"
    ],
    "expenseGeneralLedgerMappingCode": "string",
    "externalReferenceId": "string",
    "id": "int32",
    "includedPayCategoryTypes": [
        "string"
    ],
    "isInUse": "boolean",
    "isNameReadOnly": "boolean",
    "isResc": "boolean",
    "isSystem": "boolean",
    "liabilityGeneralLedgerMappingCode": "string",
    "minimumWageDeductionImpact": "string",
    "nationalInsuranceImpact": "string",
    "paymentSummaryClassification": "string",
    "pensionableEarningsImpact": "string",
    "sgcCalculationImpact": "string",
    "source": "string",
    "t4Boxes": [
        "int32"
    ],
    "taxExempt": "boolean"
}

Properties

Name	Type	Description
calculationBasis	string	Nullable Possible values are: `NotSet` `Fixed` `PercentageGross` `PercentageOTE` `PercentageStudentLoan` `PercentageNet` `Tiered` `Custom` `PercentageSuperannuation` `PercentageCompensation` `PercentagePensionable` `PercentageCustomBasis`
cisType	string	DeductionCategoryCisType Possible values are: `None` `PreCis` `PostCis`
deductionCategoryName	string	String
defaultPercentageRate	double	Nullable
excludedPayCategoryIds[]	array of int32
expenseGeneralLedgerMappingCode	string	String
externalReferenceId	string	String
id	int32	Int32
includedPayCategoryTypes[]	array of string	Possible values are: `Standard` `LeaveLoading` `GenuineRedundancyLeavePayment` `OpeningBalanceAllowances` `EtpTypeRTaxable` `EtpTypeRTaxFree` `EtpTypeOTaxable` `EtpTypeOTaxFree` `EtpLumpSumD` `StatutorySickPay` `StatutoryMaternityPay` `StatutoryAdoptionPay` `StatutoryPaternityPay` `StatutorySharedParentalPay` `ExtraPay` `RedundancyPayRetirementAllowance` `GenuineRedundancyLeaveLoading` `KeepingInTouchDay` `AnnualHolidaysCashOut` `HolidayPay` `AccLevy` `AverageEarnings` `TerminationHolidayPay` `TerminationAverageEarnings` `MethodB2AdditionalPaymentsOpeningBalance` `TerminationRelevantDailyPay` `RelevantDailyPay` `LumpSumGratuity` `LumpSumNoticePay` `LumpSumExGratiaPayment` `LumpSumOther` `CompensationForLossOfOffice` `Pre93RetirementBenefits` `Post93RetirementBenefits` `TerminationPublicHolidayPay` `RestDayEmployerRequested` `RestDayEmployeeRequested` `PublicHoliday` `EtpSuperableTypeOTaxable` `EtpSuperableTypeOTaxFree` `EtpTypeOUnusedLeavePayment` `StatutoryParentalBereavementPay` `UKPensionDeathBenefit` `JobKeeperStart` `JobKeeperFinish` `JobKeeperTopUp` `RestDay` `GST` `EtpTypeSTaxable` `EtpTypeSTaxFree` `EtpTypePTaxable` `EtpTypePTaxFree` `EtpSuperableTypePTaxable` `EtpSuperableTypePTaxFree` `EtpTypePUnusedLeavePayment` `JobKeeperTier` `JobKeeperCancelTier` `TerminationPayment` `FlexibleDrawdownPayment` `FlexibleDrawdownPaymentNonTaxable` `PayrollHistory` `PreviousYearEarnings` `JobMakerNomination` `JobMakerRenomination` `JobMakerPeriod` `JobMakerCancelNomination` `JobMakerCancelRenomination` `JobMakerCancelPeriod` `NormalTerminationLeaveLoading` `PublicHolidayWorked` `PublicHolidayNotWorked` `UnusedLeavePaymentNormalTermination` `BackPayment` `UkOccupationalSickPay` `PaidFamilyAndDomesticViolenceLeave` `UkOccupationalMaternityPay` `RolledUpHolidayPay` `ShppInTouchPay` `AlternativeHolidaysCashOut` `StatutoryNeonatalCarePay` `SeverancePay` `VacationPayout` `BereavementLeave` `BonusDiscretionary` `BonusWorkRelated` `Commission` `CarAllowance` `RetroactivePay` `VacationPayoutTimeOff` `ControlledTips` `CellPhoneAllowance` `DoubleOvertime` `FlexTimeOff` `TimeAndHalfOvertime` `PayInLieuOfNotice` `PersonalTimeOff` `WorkedHolidayPremiumPay` `PensionCommencementExcess` `StandAloneLumpSum` `SickPay` `UnpaidTimeOff` `RegularPayHourly` `RegularPayAnnual` `RetroactivePayHourly` `WorkedHolidayPremiumPayDouble` `VacationPayoutOnTermination` `VacationPayoutCashOut` `EtpTypeD` `EtpTypeN` `EtpTypeB` `EtpTypeT` `CaContractorFeesForServices` `CaContractorSelfEmployedCommissions` `CaContractorLumpSumPayments` `CaContractorOtherIncome` `CaContractorPension` `EtpSuperableLumpSumD` `EtpSuperableTypeRTaxable` `EtpSuperableTypeRTaxFree`
isInUse	boolean	Boolean
isNameReadOnly	boolean	Boolean
isResc	boolean	Boolean
isSystem	boolean	Boolean
liabilityGeneralLedgerMappingCode	string	String
minimumWageDeductionImpact	string	MinimumWageDeductionImpact Possible values are: `NoImpact` `ReduceMinimumWage` `Accommodation`
nationalInsuranceImpact	string	DeductionCategoryPreTaxNationalInsuranceImpact Possible values are: `AffectsNationalInsurance` `NoImpactOnNationalInsurance`
paymentSummaryClassification	string	DeductionCategoryPaymentSummaryClassification Possible values are: `Default` `UnionOrProfessionalAssociationFees` `WorkplaceGiving` `StudentLoanMandatory` `StudentLoanVoluntary` `ChildSupport` `FamilyTaxCreditOverpayment` `Donation` `Contribution` `LifeInsurancePremium` `MyCp38Deduction` `MyZakatPaidViaSalaryDeduction` `MyReliefClaimTp1` `MyZakatReliefClaimTp1` `MyGrossSalaryWagesOrLeavePay` `MyFeesCommissionsOrBonuses` `MyGrossTipsOrOtherAllowances` `ChildSupportDeduction` `ChildSupportGarnishee` `PayrollGiving` `SalarySacrificeOtherEmployeeBenefits` `SalarySacrificeSuperannuation` `IrdArrears` `UnionDues` `CharityDeduction` `Custom`
pensionableEarningsImpact	string	DeductionCategoryPreTaxPensionImpact Possible values are: `ReducesPensionableEarnings` `NoImpactOnPensionableEarnings`
sgcCalculationImpact	string	SGCCalculationImpactEnum Possible values are: `None` `ReducesOTE` `ReducesQeOnly`
source	string	ExternalService Possible values are: `None` `Saasu` `Xero` `MYOB` `Deputy` `EmployeeTimePunch` `ClickSuper` `IntegratedTimesheets` `FileImport` `FileExport` `QuickBooks` `Harmony` `AwardStore` `Attache` `IntegratedRostering` `ReckonAccounts` `API` `MicroPower` `RosterLive` `NetSuite` `Kounta` `TimeAndAttendanceKiosk` `DetailedFileExport` `JonasPremier` `WageEasy` `Maestrano` `WorkZone` `EmployeePortal` `RosterTemplate` `Onboarding` `Admin` `WorkZoneClockOnOff` `NetSuiteOneWorld` `Sage50` `PensionSync` `FinancialsOffice` `ProntoXI` `PayRunDefault` `StandardWorkDay` `Beam` `PayRunAutomation` `BureauDashboard` `Wiise` `QBOMigrationTool` `AbridgedFileImport` `QBOForcedMigration` `HmrcDpsUpdate` `HmrcDpsStudentLoan` `HmrcDpsPostGradLoan` `Sage50FileImporter` `FPSFileImporter` `OAuth` `FreshBooks` `StarFileImporter` `ActiveCampaign` `SummaryAndDetailsExport` `Telleroo` `EmployeeAdvancedHoursUpload` `BusinessCentral` `Paytron` `AccessFinancials` `Comma` `Zoho` `FlatFileEmployeeImporter` `Twinfield` `SageAccounting` `Square` `Quickfile` `Tide` `TideSso` `FreeAgent` `Akahu` `InstaPay` `Zepto` `Slack` `Caxton` `QuickbooksStandalonePayroll` `ImportEmployeeSelfSetup` `XeroIdentityPayrollSignUp` `XeroIdentityHrSignUp` `SageIntacct` `InstaPayDaily` `Salesforce` `AutomatedPublicHolidayNotWorked` `EmployeePayRatesUpload` `Zapier` `StapledSuperFund` `Swag` `Crezco` `KafkaConsumer` `EmployeeLeaveRateCalculationMethodUpload` `MoneyMovement` `PayRunSettingsFlatFileImport` `Sage200` `RosterCostCalculation` `HeroClear` `BrightPay` `EmployeeLeaveYearStartDatesImport` `PayConditionComparisonUpload` `GlobalMoneyMovement`
t4Boxes[]	array of int32
taxExempt	boolean	Boolean

DeductionCategoryEditModel resource

Methods

Resource

Properties