Superannuation

Return payroll categories of type superannuation for Australian Files.

Date Released: Mar 2014 Date Updated: Jan 2021
URLSupports
/{cf_uri}/Payroll/PayrollCategory/Superannuation 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 Superannuation. 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 superannuation category identifier in the form of a guid.
  • NameString (31)
  • Name of the payroll superannuation category.
  • TypeString
  • Indicates the type of payroll category ie: Wage, Expense, Deduction.
  • ExpenseAccount
  • Details for the linked expense account of the superannuation category.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the account in the form of a guid.
    • NameString (30)
    • Account name belonging to the account record.
    • DisplayIDString (6)
    • Account code format includes separator ie 6-1200{ 'DisplayID': '6-1200' }
    • URIString
    • Uniform resource identifier associated with the account object.
  • 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

  • PayableAccount
  • Details for the linked payable account of the superannuation category.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the account in the form of a guid.
    • NameString (30)
    • Account name belonging to the account record.
    • DisplayIDString (6)
    • Account code format includes separator ie 2-2100{ 'DisplayID': '2-2100' }
    • URIString
    • Uniform resource identifier associated with the account object.
  • ContributionTypeString
  • The type of contribution basis, consist of the following:
    SuperannuationGuarantee
    EmployeeAdditional
    EmployerAdditional
    Productivity
    Redundancy
    SalaySacrifice
    Spouse
  • PrintOnPayAdviceBoolean
  • True indicates accrued superannuation will show on pay advices.
    False indicates accrued superannuation will not be shown on pay advices.
  • CalculationBasis
  • Details on how to calculate superannuation.
    • TypeString
    • The type of calculation to use can be any of the following 3:
      UserEntered - use amount on employees standard pay when processing.
      PercentageOfPayrollCategory - Equals x percentage, calculate as a % of gross wages or another payroll category.
      FixedDollars - Equals x dollar to contribute for all linked employees.
      Learn more about superannuation setup here
    • PercentageOfDecimal (13.2)
    • Percentage of super to calculate 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.
    • FixedDollarsOfDecimal (13.2)
    • Nominated contribution amount if CalculationBasis.Type = FixedDollars.
    • AccrualPeriodString
    • How the specified contribution is calculated if CalculationBasis.Type = FixedDollars.
      Can consist of any of the following:
      PayPeriod
      Month
      Year
      Hour
  • ExclusionDecimal (13.2)
  • Amount to reduce an employees wage by before calculating superannuation.
  • Limit
  • Details on any limits put in place for superannuation.
    • TypeString
    • The type of calculation to use can be any of the following 3:
      NoLimit - no limits in place on contribution calculations.
      PercentageOfPayrollCategory - Equals x percentage, limit is calculated as a % of gross wages or another payroll category.
      FixedDollars - Equals x dollar limit set.
      Learn more about superannuation setup here
    • PercentageOfDecimal (13.2)
    • Limit as a percentage if Limit.Type = PercentageOfPayrollCategory.
    • PayrollCategory
    • Payroll wage category used to calculate limit PercentageOf only if Limit.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.
    • FixedDollarsOfDecimal (13.2)
    • Maximum contribution amount if Limit.Type = FixedDollars.
    • AccrualPeriodString
    • How the maximum contribution is calculated if Limit.Type = FixedDollars.
      Can consist of any of the following:
      PayPeriod
      Month
      Year
      Hour
  • ThresholdDecimal (13.2)
  • Amount if superannuation is only payable when wages exceed a certain $$ per month.
  • Exemptions []
  • An array of wage categories the superannuation 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, Deduction, 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" : "da0b6499-fc03-44ae-b6e0-87106a4ea1cf",
  • "Name" : "Superannuation Guarantee",
  • "Type" : "Superannuation",
  • "ExpenseAccount" : {
    • "UID" : "6cb29278-01e2-4ab5-9b7e-ec579be914cb",
    • "Name" : "Superannuation",
    • "DisplayID" : "6-3120",
    • "URI" : "{cf_uri}/GeneralLedger/Account/6cb29278-01e2-4ab5-9b7e-ec579be914cb"
    • },
  • "StpCategory" : "SuperGuarantee",
  • "PayableAccount" : {
    • "UID" : "6f7ed8fe-5548-484c-86ad-b66a389cf1c1",
    • "Name" : "Superannuation Payable",
    • "DisplayID" : "2-1530",
    • "URI" : "{cf_uri}/GeneralLedger/Account/6f7ed8fe-5548-484c-86ad-b66a389cf1c1"
    • },
  • "ContributionType" : "SuperannuationGuarantee",
  • "PrintOnPayAdvice" : true,
  • "CalculationBasis": {
    • "Type" : "PercentageOfPayrollCategory",
    • "PercentageOf" : 9.25,
    • "PayrollCategory:" : {
      • "UID" : "fd571691-d70f-4ba1-a383-43825f7290ec",
      • "Name" : "Gross Wages",
      • "Type" : "WagesGroup",
      • "URI" : "{cf_uri}/PayrollCategory/fd571691-d70f-4ba1-a383-43825f7290ec"
      • },
    • "FixedDollarsOf" : null,
    • "AccrualPeriod" : null
    • },
  • "Exclusion" : 0,
  • "Limit": {
    • "Type" : "NoLimit",
    • "PercentageOf" : null,
    • "PayrollCategory:" : null,
    • "FixedDollarsOf" : null,
    • "AccrualPeriod" : null
    • },
  • "Threshold" : 450,
  • "Exemptions" : [
    • {
    • "UID" : "b8cfe4cf-bb11-4013-a13d-0e4e1f3b3b41",
    • "Name" : "Advance",
    • "Type" : "Wage",
    • "URI" : "{cf_uri}/PayrollCategory/Wage/b8cfe4cf-bb11-4013-a13d-0e4e1f3b3b41"
    • },
    • {
    • "UID" : "960db9be-1f4e-40a2-be17-9999b30e1bff",
    • "Name" : "Bonus",
    • "Type" : "Wage",
    • "URI" : "{cf_uri}/PayrollCategory/Wage/960db9be-1f4e-40a2-be17-9999b30e1bff"
    • },
    • {
    • "UID" : "3f479471-eebf-41f1-9e87-0f2d0ebe47bd",
    • "Name" : "Holiday Leave Loading",
    • "Type" : "Wage",
    • "URI" : "{cf_uri}/PayrollCategory/Wage/3f479471-eebf-41f1-9e87-0f2d0ebe47bd"
    • },
    • {
    • "UID" : "d4d7c4c1-1391-4dd1-a091-e8fe89488e82",
    • "Name" : "Overtime (1.5x)",
    • "Type" : "Wage",
    • "URI" : "{cf_uri}/PayrollCategory/Wage/d4d7c4c1-1391-4dd1-a091-e8fe89488e82"
    • },
    • {
    • "UID" : "df8c2652-523e-464d-91b3-555639ca12ca",
    • "Name" : "Overtime (2x)",
    • "Type" : "Wage",
    • "URI" : "{cf_uri}/PayrollCategory/Wage/df8c2652-523e-464d-91b3-555639ca12ca"
    • },
    • {
    • "UID" : "fecff7a5-5b5b-4bbc-aae5-408fe5c6c48a",
    • "Name" : "Unused Holiday Pay",
    • "Type" : "Wage",
    • "URI" : "{cf_uri}/PayrollCategory/Wage/fecff7a5-5b5b-4bbc-aae5-408fe5c6c48a"
    • },
    • {
    • "UID" : "40ce4469-0174-40a6-b38a-c6f172a8c51c",
    • "Name" : "Unused Long Service Leave",
    • "Type" : "Wage",
    • "URI" : "{cf_uri}/PayrollCategory/Wage/40ce4469-0174-40a6-b38a-c6f172a8c51c"
    • }
    • ],
  • "URI" : "{cf_uri}/Payroll/PayrollCategory/Superannuation/da0b6499-fc03-44ae-b6e0-87106a4ea1cf",
  • "RowVersion" : "-7523263177522413568"
  • }
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.