Employment Hero Payroll API Reference: Create Deduction Category

Creates a deduction category for the business.

Request

POST http:///api/v2/business/{businessId}/deductioncategory

Path parameters

Parameter name	Value	Description	Additional
businessId	string		Required

Request body

The request body takes a complete NzDeductionCategoryModel resource, containing the following writable properties:

{
    "externalId": "string",
    "id": "int32",
    "isSystem": "boolean",
    "name": "string",
    "paymentSummaryClassification": "string",
    "source": "string"
}

Properties

Name	Type	Description
externalId	string	String
id	int32	Int32
isSystem	boolean	Boolean
name	string	String
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`
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`

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code	Description	Resource
200	OK OK