Entitlement

Return payroll categories of type entitlement for Australian Files

Date Released: Mar 2014 Date Updated: Jan 2021
URLSupports
/{cf_uri}/Payroll/PayrollCategory/Entitlement GET |  PUT |  POST |  DELETE
Please note: While accessibility via the API is available to both AccountRight and new Essentials files. Not all features will be displayed in Product for new Essentials

The elements list below details information for Entitlement. To view the descriptions for the elements you can either hover any attribute to reveal details or click here to show all details inline.

Items shown with are required when posting or puting data
Items shown with are read-only elements

Attribute Details

  • UIDGuid (36)
  • Unique entitlement identifier in the form of a guid.
  • NameString (31)
  • Name of the payroll entitlement category.
  • TypeString
  • Indicates the type of payroll category ie: Wage, Expense, Deduction.
  • PrintOnPayAdviceBoolean
  • True indicates accrued leave hours will show on pay advices.
    False indicates accrued leave hours will not be shown on pay advices
  • StpCategory String
  • STP Category for this payroll category. See MYOB help for more info.

    Expected values include:
    NotReportable (default)

    GrossPayments
    PAYGWithholding
    ExemptForeignIncome
    CDEPPayments

    AllowanceCar
    AllowanceTransport
    AllowanceTravel
    AllowanceMeals
    AllowanceLaundry
    AllowanceOther

    DeductionUnionProfAssocFees
    DeductionWorkPlaceGiving

    ReportableFringeBenefitsExemptAmount
    ReportableFringeBenefitsTaxableAmount

    ETPTaxableComponent
    ETPTaxFreeComponent
    ETPTaxWithholding

    LumpSumPaymentATermination
    LumpSumPaymentARedundancy
    LumpSumPaymentB
    LumpSumPaymentD
    LumpSumPaymentE

    SuperGuarantee
    OrdinaryTimesEarnings
    ReportableEmployerSuperContributions

  • CarryEntitlementOverToNextYearBoolean
  • True indicates to carry over any unused leave hours when starting a new payroll year.
    False indicates not to carry over unused leave hours when starting a new payroll year.
  • CalculationBasis
  • Details on how to calculate the entitlement.
    • TypeString
    • The type of calculation to use can be any of the following 3:
      UserEntered - use hours on employees standard pay when processing.
      PercentageOfPayrollCategory - Equals x percentage, calculate as a % of gross wages or another payroll category.
      FixedHours - Equals x hours to accrue for all linked employees.
      Learn more about leave entitlments here
    • PercentageOfDecimal (13.2)
    • Percentage of leave hours accrued per hour worked if CalculationBasis.Type = PercentageOfPayrollCategory.
    • PayrollCategory
    • Payroll wage category used to calculate PercentageOf only if CalculationBasis.Type = PercentageOfPayrollCategory.
      • UIDGuid (36)
      • Unique wage category identifier in the form of a guid.
      • NameString (31)
      • Name of the payroll wage category.
      • TypeString
      • Indicates the type of payroll category ie: Wage, Expense, Deduction.
      • URIString
      • Uniform resource identifier associated with the payroll wage object.
    • FixedHoursOfDecimal (13.2)
    • Number of hours to accrue if CalculationBasis.Type = FixedHours.
    • AccrualPeriodString
    • How the specified hours are accrued if CalculationBasis.Type = FixedHours.
      Can consist of any of the following:
      PayPeriod
      Month
      Year
      Hour
  • LinkedPayrollCategoryWages []
  • An array of linked wage category information, when recording hours for selected linked wage on an employee's pay, the entitlement balance will reduce accordingly.
    • UIDGuid (36)
    • Unique wage payroll category identifier in the form of a guid.
    • NameString (31)
    • Name of the payroll wage category.
    • TypeString
    • Indicates the type of payroll category ie: Deduction, Tax.
    • URI String
    • Uniform resource identifier associated with the wage payroll category object.
  • Exemptions []
  • An array of wage categories the entitlement category is exempt from.
    • UIDGuid (36)
    • Unique payroll wage category identifier in the form of a guid.
    • NameString (31)
    • Name of the payroll wage category.
    • TypeString
    • Indicates the type of payroll category ie: Wage, Tax.
    • URI String
    • Uniform resource identifier associated with the payroll wage category object.
  • URIString
  • Uniform resource identifier encompasses all types of names and addresses that refer to objects on the web.
  • RowVersionString
  • Number value that changes upon a record update, can be used for change control but does does not preserve a date or a time.


Paging: default page size is set to 400 with a maximum of 1000 results.

Example json GET response

  • {
  • "UID" : "470d9b21-b730-410d-b6f2-411a34a63bbc",
  • "Name" : "Holiday Leave Accrual",
  • "Type" : "Entitlement",
  • "PrintOnPayAdvice" : true,
  • "StpCategory" : "NotReportable",
  • "CarryEntitlementOverToNextYear" : true,
  • "CalculationBasis": {
    • "Type" : "FixedHours",
    • "PercentageOf" : null,
    • "PayrollCategory:" : null,
    • "FixedHoursOf" : 160,
    • "AccrualPeriod" : "Year"
    • },
  • "LinkedPayrollCategoryWages" : [
    • {
    • "UID" : "12977075-a394-4223-a6fc-49b48368b284",
    • "Name" : "Holiday Pay",
    • "Type" : "Wage",
    • "URI" : "{cf_uri}/PayrollCategory/Wage/12977075-a394-4223-a6fc-49b48368b284"
    • }
    • ],
  • "Exemptions" : null,
  • "URI" : "{cf_uri}/Payroll/PayrollCategory/Entitlement/470d9b21-b730-410d-b6f2-411a34a63bbc",
  • "RowVersion" : "-8387954305977548800"
  • }
Hypermedia in the MYOB Business API

The {cf_uri} is provided by the Company File endpoint.

Read more about Hypermedia in the MYOB Business API in our best practice guide.