Expense

Return payroll categories of type expense for Australian Files

Date Released: Mar 2014 Date Updated: Jan 2021
URLSupports
/{cf_uri}/Payroll/PayrollCategory/Expense 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 Expense. 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 expense category identifier in the form of a guid.
  • NameString (31)
  • Name of the payroll expense category.
  • TypeString
  • Indicates the type of payroll category ie: Wage, Expense, Deduction.
  • ExpenseAccount
  • Details for the linked expense account of the expense 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 expense 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.
  • PrintOnPayAdviceBoolean
  • True indicates accrued expenses will show on pay advices.
    False indicates accrued expenses will not be shown on pay advices.
  • CalculationBasis
  • Details on how to calculate expenses.
    • 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 expense for all linked employees.
    • PercentageOfDecimal (13.2)
    • Percentage of expense to calculate if CalculationBasis.Type = PercentageOfPayrollCategory.
    • PayrollCategory
    • Payroll category used to calculate PercentageOf only if CalculationBasis.Type = PercentageOfPayrollCategory.
      • UIDGuid (36)
      • 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: Wage, Expense, Deduction.
      • URIString
      • Uniform resource identifier associated with the payroll category object.
    • FixedDollarsOfDecimal (13.2)
    • Nominated expense amount if CalculationBasis.Type = FixedDollars.
    • AccrualPeriodString
    • How the expense amount is calculated if CalculationBasis.Type = FixedDollars.
      Can consist of any of the following:
      PayPeriod
      Month
      Year
      Hour
  • Limit
  • Details on any limits put in place for expenses.
    • TypeString
    • The type of calculation to use can be any of the following 3:
      NoLimit - no limits in place on expense calculations.
      PercentageOfPayrollCategory - Equals x percentage, limit is calculated as a % of gross wages or another payroll category.
      FixedDollars - Equals x dollar limit set.
    • PercentageOfDecimal (13.2)
    • Limit as a percentage if Limit.Type = PercentageOfPayrollCategory.
    • PayrollCategory
    • Payroll category used to calculate limit PercentageOf only if Limit.Type = PercentageOfPayrollCategory.
      • UIDGuid (36)
      • 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: Wage, Expense, Deduction.
      • URIString
      • Uniform resource identifier associated with the payroll object.
    • FixedDollarsOfDecimal (13.2)
    • Maximum expense amount if Limit.Type = FixedDollars.
    • AccrualPeriodString
    • How the maximum expense is calculated if Limit.Type = FixedDollars.
      Can consist of any of the following:
      PayPeriod
      Month
      Year
      Hour
  • ThresholdDecimal (13.2)
  • Amount if expense is only payable when wages exceed a certain $$ per month.
  • Exemptions []
  • An array of wage categories the expense 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" : "a97de4a4-0be2-41a0-8e82-743a57c73df2",
  • "Name" : "WorkCover",
  • "Type" : "Expense",
  • "ExpenseAccount" : {
    • "UID" : "a1e93723-9ee3-4b47-9d3e-0f404778e733",
    • "Name" : "Employment Expenses",
    • "DisplayID" : "6-5200",
    • "URI" : "{cf_uri}/GeneralLedger/Account/a1e93723-9ee3-4b47-9d3e-0f404778e733"
    • },
  • "StpCategory" : "NotReportable",
  • "PayableAccount" : {
    • "UID" : "02c3f70b-2570-4f2b-bd51-560c65ecb1df",
    • "Name" : "PAYG Withholdings Payable",
    • "DisplayID" : "2-1510",
    • "URI" : "{cf_uri}/GeneralLedger/Account/02c3f70b-2570-4f2b-bd51-560c65ecb1df"
    • },
  • "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
    • },
  • "Limit": {
    • "Type" : "FixedDollars",
    • "PercentageOf" : null,
    • "PayrollCategory:" : null,
    • "FixedDollarsOf" : 350,
    • "AccrualPeriod" : "Month"
    • },
  • "Threshold" : 0,
  • "Exemptions" : null,
  • "URI" : "{cf_uri}/Payroll/PayrollCategory/Expense/a97de4a4-0be2-41a0-8e82-743a57c73df2",
  • "RowVersion" : "4991677236986773504"
  • }
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.