Update Pay Category

Updates the pay category with the specified ID.

Request

PUT https://apisg.yourpayroll.io/api/v2/business/{businessId}/paycategory/{id}

Path parameters

Parameter name Value Description Additional
id int32 Required
businessId string Required

Request body

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

{
    "accruesLeave": "boolean",
    "cpfClassification": "string",
    "externalId": "string",
    "generalLedgerMappingCode": "string",
    "hideUnitsOnPaySlip": "boolean",
    "id": "int32",
    "isPrimary": "boolean",
    "isSdlExempt": "boolean",
    "isShgExempt": "boolean",
    "isSystemPayCategory": "boolean",
    "isTaxExempt": "boolean",
    "name": "string",
    "numberOfDecimalPlaces": "int32",
    "parentId": "int32",
    "paymentSummaryClassification": "string",
    "penaltyLoadingPercent": "double",
    "rateLoadingPercent": "double",
    "rateUnit": "string",
    "roundingMethod": "string",
    "source": "string"
}

Properties

Name Type Description
accruesLeave boolean Boolean
cpfClassification string Nullable

Possible values are:

  • None
  • OrdinaryWage
  • AdditionalWage
  • ExcludeFromCpf
externalId string String
generalLedgerMappingCode string String
hideUnitsOnPaySlip boolean Boolean
id int32 Int32
isPrimary boolean Boolean
isSdlExempt boolean Boolean
isShgExempt boolean Boolean
isSystemPayCategory boolean Boolean
isTaxExempt boolean Boolean
name string String
numberOfDecimalPlaces int32 Nullable
parentId int32 Nullable
paymentSummaryClassification string Nullable

Possible values are:

  • Default
  • Allowance
  • LumpSumATypeR
  • LumpSumATypeT
  • LumpSumB
  • LumpSumD
  • LumpSumE
  • Exclude
  • Cdep
  • ExemptForeignEmploymentIncome
  • AllowanceCar
  • AllowanceTransport
  • AllowanceLaundry
  • AllowanceMeals
  • AllowanceTravel
  • GrossSalary
  • Bonus
  • DirectorsFees
  • AllowanceEntertainment
  • GrossCommission
  • Pension
  • NotReportable
  • MyGrossSalary
  • MyFees
  • MyGrossTips
  • MyEsosBenefit
  • MyGratuity
  • MyBenefitsInKind
  • MyValueOfLivingAccommodations
  • MyRefundProvidentPensionFund
  • MyCompensationForLossOfEmployment
  • MyPension
  • MyAnnuities
  • MyCp38Deduction
  • MyZakatPaidViaSalaryDeduction
  • MyReliefClaimTp1
  • MyZakatReliefClaimTp1
  • MyTaxExemptAllowances
  • MyArrearsIncomeA
  • MyArrearsIncomeB
  • None
  • LeaveCashOutOfLeaveInService
  • LeaveUnusedLeaveOnTermination
  • LeavePaidParentalLeave
  • LeaveWorkersCompensation
  • LeaveAncillaryAndDefenceLeave
  • LeaveOtherPaidLeave
  • Overtime
  • AllowanceTool
  • AllowanceTasks
  • AllowanceQualificationsCertificates
  • EtpLifeBenefitCodeR
  • EtpLifeBenefitCodeO
  • EtpMultiplePaymentsCodeS
  • EtpMultiplePaymentsCodeP
  • EtpDeathBenefitCodeD
  • EtpDeathBenefitCodeN
  • EtpDeathBenefitCodeB
  • EtpDeathBenefitCodeT
  • ReturnToWorkPayment
  • SgGratuity
  • SgNoticePay
  • SgExGratiaPayment
  • SgOtherLumpSumPayments
  • SgCompensationLossOfOffice
  • SgRetirementBenefitsPre1993
  • SgRetirementBenefitsFrom1993
penaltyLoadingPercent double Decimal
rateLoadingPercent double Decimal
rateUnit string RateUnitEnum

Possible values are:

  • Hourly
  • Annually
  • Fixed
  • Daily
  • Monthly
roundingMethod string Nullable

Possible values are:

  • ToEven
  • AwayFromZero
source string String

Response

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

Status code Description Resource
200 OK

OK

 SgPayCategoryModel