Wage

Return, update, create and delete payroll categories of type wage for Australian Files

Date Released: Mar 2014 Date Updated: Jan 2021
URLSupports
/{cf_uri}/Payroll/PayrollCategory/Wage 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 Wage. 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 wage identifier in the form of a guid.
    ONLY required for updating an existing wage cateogry.
    NOT required when creating a new wage category.
  • NameString (31)
  • Name of the wage category.
  • TypeString
  • Indicates the type of payroll category ie: Wage, Expense, Deduction.
  • WageTypeString
  • Indicates whether the wage category is a salary type or an hourly type.
    Use either Hourly or Salary
  • StpCategory String
  • STP Category for this payroll category. See MYOB help for more info.

    Valid values are:
    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

  • OverriddenWagesExpenseAccount
  • Populates the account details if different to the default Payroll Wages Expense Account.
    • UIDGuid (36)
    • Foreign Key: Unique identifier for the account in the form of a guid.
      ONLY required if passing an Expense Account object on POST.
    • 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.
  • HourlyDetails
  • If WageType = Hourly then details of rates applied, if WageType = Salary then null.
    Required field on POST when WageType = Houly
    • PayRateString
    • How to calculate the rate, can be either RegularRate or FixedHourly.
    • RegularRateMultiplierDecimal (3.4)
    • Calculate as a multiple of the hourly rate setup on each employee's card if PayRate = RegularRate otherwise null.
      Required field on POST when PayRate = RegularRate
    • FixedHourlyRateDecimal (13.4)
    • Fixed hourly rate for all employees linked to this wage category if PayRate = FixedHourly otherwise null.
      Required field on POST when PayRate = FixedHoulyRate
    • AutomaticallyAdjustBaseAmountsBoolean
    • When entering leave amounts on a pay, base hourly or base salary amount will automatically be adjusted if set to True.
  • Exemptions []
  • An array of tax and deductions this wage category is exempt from
    • UIDGuid (36)
    • ONLY required when passing on POST.
      Unique payroll category identifier in the form of a guid.
    • NameString (31)
    • Name of the payroll category.
    • TypeString
    • Indicates the type of payroll category ie: Deduction, Tax.
    • URI String
    • Uniform resource identifier associated with the payroll 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.
    ONLY required for updating an existing wage cateogry.
    NOT required when creating a new wage category.

Example json GET response

  • {
  • "UID" : "e57725b2-c4f0-47ce-8103-299c7a675112",
  • "Name" : "Base Hourly",
  • "Type" : "Wage",
  • "WageType" : "Hourly",
  • "StpCategory" : "NotReportable",
  • "OverriddenWagesExpenseAccount" : null,
  • "HourlyDetails": {
    • "PayRate" : "RegularRate",
    • "RegularRateMultiplier" : 1,
    • "FixedHourlyRate" : null,
    • "AutomaticallyAdjustBaseAmounts" : true
    • },
  • "Exemptions" : null,
  • "URI" : "{cf_uri}/Payroll/PayrollCategory/Wage/e57725b2-c4f0-47ce-8103-299c7a675112",
  • "RowVersion" : "3334352574114430976"
  • }
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.