Creates a deduction category for the business.

Request

POST https://api.yourpayroll.co.uk/api/v2/business/{businessId}/deductioncategory

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "externalId": "string",
    "id": "int32",
    "isSystem": "boolean",
    "minimumWageDeductionImpact": "string",
    "name": "string",
    "nationalInsuranceImpact": "string",
    "pensionableEarningsImpact": "string",
    "source": "string",
    "taxExempt": "boolean"
}

Properties

Name Type Description
externalId string String
id int32 Int32
isSystem boolean Boolean
minimumWageDeductionImpact string MinimumWageDeductionImpact

Possible values are:

  • NoImpact
  • ReduceMinimumWage
  • Accommodation
name string String
nationalInsuranceImpact string DeductionCategoryPreTaxNationalInsuranceImpact

Possible values are:

  • AffectsNationalInsurance
  • NoImpactOnNationalInsurance
pensionableEarningsImpact string DeductionCategoryPreTaxPensionImpact

Possible values are:

  • ReducesPensionableEarnings
  • NoImpactOnPensionableEarnings
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
  • Zoho
taxExempt boolean Boolean

Response

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

Status code Description Resource
200 OK

OK

UkDeductionCategoryModel