Create Pay Category

Creates a new pay category for the business.

Request

POST https://api.yourpayroll.com.au/api/v2/business/{businessId}/paycategory

Path parameters

Parameter name Value Description Additional
businessId string Required

Request body

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

{
    "accruesLeave": "boolean",
    "allowanceDescription": "string",
    "awardId": "int32",
    "awardName": "string",
    "defaultSuperRate": "double",
    "externalId": "string",
    "generalLedgerMappingCode": "string",
    "hideUnitsOnPaySlip": "boolean",
    "id": "int32",
    "isPayrollTaxExempt": "boolean",
    "isPrimary": "boolean",
    "isSystemPayCategory": "boolean",
    "isTaxExempt": "boolean",
    "name": "string",
    "numberOfDecimalPlaces": "int32",
    "parentId": "int32",
    "payCategoryType": "string",
    "paymentSummaryClassification": "string",
    "penaltyLoadingPercent": "double",
    "rateLoadingPercent": "double",
    "rateUnit": "string",
    "roundingMethod": "string",
    "source": "string",
    "superExpenseMappingCode": "string",
    "superLiabilityMappingCode": "string"
}

Properties

Name Type Description
accruesLeave boolean Boolean
allowanceDescription string String
awardId int32 Nullable
awardName string String
defaultSuperRate double Decimal
externalId string String
generalLedgerMappingCode string String
hideUnitsOnPaySlip boolean Boolean
id int32 Int32
isPayrollTaxExempt boolean Boolean
isPrimary boolean Boolean
isSystemPayCategory boolean Boolean
isTaxExempt boolean Boolean
name string String
numberOfDecimalPlaces int32 Nullable
parentId int32 Nullable
payCategoryType string AuPayCategoryType

Possible values are:

  • Standard
  • LeaveLoading
  • GenuineRedundancyLeavePayment
  • OpeningBalanceAllowances
  • EtpTypeRTaxable
  • EtpTypeRTaxFree
  • EtpTypeOTaxable
  • EtpTypeOTaxFree
  • EtpLumpSumD
  • GenuineRedundancyLeaveLoading
  • MethodB2AdditionalPaymentsOpeningBalance
  • EtpSuperableTypeOTaxable
  • EtpSuperableTypeOTaxFree
  • EtpTypeOUnusedLeavePayment
  • EtpTypeSTaxable
  • EtpTypeSTaxFree
  • EtpTypePTaxable
  • EtpTypePTaxFree
  • EtpSuperableTypePTaxable
  • EtpSuperableTypePTaxFree
  • EtpTypePUnusedLeavePayment
  • JobKeeperTier
  • JobKeeperCancelTier
  • JobMakerNomination
  • JobMakerRenomination
  • JobMakerPeriod
  • JobMakerCancelNomination
  • JobMakerCancelRenomination
  • JobMakerCancelPeriod
  • NormalTerminationLeaveLoading
  • PublicHolidayWorked
  • PublicHolidayNotWorked
  • UnusedLeavePaymentNormalTermination
  • BackPayment
  • PaidFamilyAndDomesticViolenceLeave
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
superExpenseMappingCode string String
superLiabilityMappingCode string String

Response

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

Status code Description Resource
200 OK

OK

 AuPayCategoryModel