Updates the pay category with the specified ID.

Request

PUT https://keypay.yourpayroll.com.au/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 PayCategoryModel resource, containing the following writable properties:

{
    "accruesLeave": "boolean",
    "defaultSuperRate": "double",
    "externalId": "string",
    "generalLedgerMappingCode": "string",
    "id": "int32",
    "isPayrollTaxExempt": "boolean",
    "isSystemPayCategory": "boolean",
    "isTaxExempt": "boolean",
    "name": "string",
    "numberOfDecimalPlaces": "int32",
    "parentId": "int32",
    "paymentSummaryClassification": "string",
    "penaltyLoadingPercent": "double",
    "rateLoadingPercent": "double",
    "rateUnit": "string",
    "source": "string",
    "superExpenseMappingCode": "string",
    "superLiabilityMappingCode": "string"
}

Properties

Name Type Description
accruesLeave boolean Boolean
defaultSuperRate double Decimal
externalId string String
generalLedgerMappingCode string String
id int32 Int32
isPayrollTaxExempt 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
penaltyLoadingPercent double Decimal
rateLoadingPercent double Decimal
rateUnit string RateUnitEnum

Possible values are:

  • Hourly
  • Annually
  • Fixed
  • Daily
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