MYOB Endpoint: PayrollSuperannuations

Overview

The MYOB PayrollSuperannuation endpoint allows you to access the list of all superannuation payroll categories within MYOB.


Fields

The following fields are available for the PayrollSuperannuation endpoint.

UID
A GUID field representing the internal id of the payroll category. This field can be used to link to other endpoints.
Name
A text field that provides the name of the payroll category.
Type
A text field that provides the type of payroll category.
This will always be set to Superannuation.
ExpenseAccount
A record field that identifies the expense account used by this payroll category.
StpCategory
A text field that provides the single-touch payroll category type for this payroll category.
Possible values are:
  • NotReportable
  • 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
A record field that identifies the payable account used by this payroll category.
ContributionType
A text field that indicates the type of contribution represented by this superannuation payroll category.
Possible values are:
  • SuperannuationGuarantee
  • EmployeeAdditional
  • EmployerAdditional
  • Productivity
  • Redundancy
  • SalaySacrifice
  • Spouse
PrintOnPayAdvice
A true/false field that indicates if amounts for this payroll category are included on the payroll payment advice.
CalculationBasis
A record field that provides the calculation basis details for this payroll category.
See CalculationBasis Fields for more information.
Exclusion
A decimal field that provides an amount used to reduce wages before calculating the superannuation amount.
Limit
A record field that provides the limits for this payroll category.
See Limit Fields for more information.
Threshold
A decimal field that provides a minimum amount required before this expense is applicable.
Exemptions
A table field that provides a list of all the payroll categories that the payroll category is exempt from.
RowVersion
A row version field.


CalculationBasis Fields

The CalculationBasis field contains the following sub-fields.

Type
A text field that provides the type of calculation used by the payroll category.
Possible values are:
  • UserEntered: Indicates the payroll category amount is entered on the employees standard pay.
  • PercentageOfPayrollCategory: Indicates the payroll category uses a percentage of another payroll category.
  • FixedDollars: Indicates the payroll category uses a fixed amount.
PercentageOf
A decimal field that provides the percentage when Type is set to PercentageOfPayrollCategory
PayrollCategory
A record field that identifies the payroll category used by the calculation.
FixedDollarsOf
A decimal field that provides the amount when Type is set to FixedDollars.
AccrualPeriod
A text field that indicates the accrual period basis when Type is set to FixedDollars.
Possible values are:
  • PayPeriod: Indicates the FixedDollarsOf amount is an amount per pay period.
  • Month: Indicates the FixedDollarsOf amount is an amount per month.
  • Year: Indicates the FixedDollarsOf amount is an amount per year.
  • Hour: Indicates the FixedDollarsOf amount is an amount per hour.


Limit Fields

The Limit field contains the following sub-fields.

Type
A text field that indicates the type of limit in use.
Possible values are:
  • NoLimit: Indicates there is no limit on the amount.
  • PercentageOfPayrollCategory: Indicates the payroll category is capped at percentage of another payroll category.
  • FixedDollars: Indicates the payroll category is capped at a fixed amount.
PercentageOf
A decimal field that provides the percentage when Type is set to PercentageOfPayrollCategory
PayrollCategory
A record field that identifies the payroll category used by the calculation.
FixedDollarsOf
A decimal field that provides the amount when Type is set to FixedDollars.
AccrualPeriod
A text field that indicates the accrual period basis when Type is set to FixedDollars.
Possible values are:
  • PayPeriod: Indicates the FixedDollarsOf amount is an amount per pay period.
  • Month: Indicates the FixedDollarsOf amount is an amount per month.
  • Year: Indicates the FixedDollarsOf amount is an amount per year.
  • Hour: Indicates the FixedDollarsOf amount is an amount per hour.


MYOB API

For a detailed run through of the endpoint, you can see the MYOB API.


Related Fields

Accounts
PayrollCategories


Related Endpoints

PayrollCategories


Related Topics

MYOB Models
MYOB Endpoints