Create Deduction Category

Creates a deduction category for the business.

Request

POST https://apisg.yourpayroll.io/api/v2/business/{businessId}/deductioncategory

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

The request body takes a complete SgDeductionCategoryModel 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
  • MyLevyRelease
  • MyGrossSalaryWagesOrLeavePay
  • MyFeesCommissionsOrBonuses
  • MyGrossTipsOrOtherAllowances
source string String

Response

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

Status code Description Resource
200 OK

OK

 SgDeductionCategoryModel