MYOB Endpoint: PayrollSuperannuations - Revision history

Nic at 23:12, 2 April 2025

2025-04-02T23:12:59Z

← Older revision		Revision as of 18:12, 2 April 2025
Line 7:		Line 7:

	The following fields are available for the PayrollSuperannuation endpoint.		The following fields are available for the PayrollSuperannuation endpoint.

			;DataFile
			:A [[Field Type: Record\|record field]] that provides the [[Field: DataFile\|DataFile]] associated with the data.

	;UID		;UID

Nic at 05:50, 22 September 2021

2021-09-22T05:50:58Z

← Older revision		Revision as of 00:50, 22 September 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==

	The MYOB '''PayrollSuperannuation''' [[Endpoints\|endpoint]] allows you to access the list of all superannuation payroll categories within MYOB.		The MYOB '''PayrollSuperannuation''' [[MYOB Endpoints\|endpoint]] allows you to access the list of all superannuation payroll categories within MYOB.


Line 161:		Line 161:

	:[[MYOB Endpoint: PayrollCategories\|PayrollCategories]]		:[[MYOB Endpoint: PayrollCategories\|PayrollCategories]]


			== Related Topics ==

			:[[MYOB Models]]
			:[[MYOB Endpoints]]

Nic at 04:20, 10 September 2021

2021-09-10T04:20:27Z

← Older revision		Revision as of 23:20, 9 September 2021
Line 96:		Line 96:
	:A [[Field Type: Text\|text field]] that provides the type of calculation used by the payroll category.		:A [[Field Type: Text\|text field]] that provides the type of calculation used by the payroll category.
	:Possible values are:		:Possible values are:
	:* '''UserEntered''': Indicates the ~~deduction~~ is entered on the employees standard pay.		:* '''UserEntered''': Indicates the payroll category amount is entered on the employees standard pay.
	:* '''PercentageOfPayrollCategory''': Indicates the ~~deduction is~~ a percentage of another payroll category.		:* '''PercentageOfPayrollCategory''': Indicates the payroll category uses a percentage of another payroll category.
	:* '''FixedDollars''': Indicates the ~~deduction is~~ a fixed amount.		:* '''FixedDollars''': Indicates the payroll category uses a fixed amount.

	;PercentageOf		;PercentageOf
Line 126:		Line 126:
	:Possible values are:		:Possible values are:
	:* '''NoLimit''': Indicates there is no limit on the amount.		:* '''NoLimit''': Indicates there is no limit on the amount.
	:* '''PercentageOfPayrollCategory''': Indicates the ~~deduction~~ is capped at percentage of another payroll category.		:* '''PercentageOfPayrollCategory''': Indicates the payroll category is capped at percentage of another payroll category.
	:* '''FixedDollars''': Indicates the ~~deduction~~ is capped at a fixed amount.		:* '''FixedDollars''': Indicates the payroll category is capped at a fixed amount.

	;PercentageOf		;PercentageOf

Nic at 04:18, 10 September 2021

2021-09-10T04:18:03Z

← Older revision		Revision as of 23:18, 9 September 2021
Line 83:		Line 83:

	;Exemptions		;Exemptions
	:A [[Field Type: Table\|table field]] that provides a list of all the [[MYOB Field: PayrollCategories\|payroll categories]] that the ~~deduction~~ payroll category is exempt from.		:A [[Field Type: Table\|table field]] that provides a list of all the [[MYOB Field: PayrollCategories\|payroll categories]] that the payroll category is exempt from.

	;RowVersion		;RowVersion

Nic at 04:09, 10 September 2021

2021-09-10T04:09:12Z

← Older revision		Revision as of 23:09, 9 September 2021
Line 22:		Line 22:

	;StpCategory		;StpCategory
	:A [[Field Type: Text\|text field]] that provides the single-touch payroll category type for this ~~deduction~~ payroll category.		:A [[Field Type: Text\|text field]] that provides the single-touch payroll category type for this payroll category.
	:Possible values are:		:Possible values are:
	:* '''NotReportable'''		:* '''NotReportable'''

Nic: Created page with "== Overview == The MYOB '''PayrollSuperannuation''' endpoint allows you to access the list of all superannuation payroll categories within MYOB. == Fields ==..."

2021-09-10T04:01:09Z

Created page with "== Overview == The MYOB '''PayrollSuperannuation''' endpoint allows you to access the list of all superannuation payroll categories within MYOB. == Fields ==..."

New page

== Overview ==

The MYOB '''PayrollSuperannuation''' [[Endpoints|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 [[Field Type: GUID|GUID field]] representing the internal id of the payroll category. This field can be used to link to other endpoints.

;Name
:A [[Field Type: Text|text field]] that provides the name of the payroll category.

;Type
:A [[Field Type: Text|text field]] that provides the type of payroll category.
:This will always be set to '''Superannuation'''.

;ExpenseAccount
:A [[Field Type: Record|record field]] that identifies the [[MYOB Field: Accounts|expense account]] used by this payroll category.

;StpCategory
:A [[Field Type: Text|text field]] that provides the single-touch payroll category type for this deduction 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 [[Field Type: Record|record field]] that identifies the [[MYOB Field: Accounts|payable account]] used by this payroll category.

;ContributionType
:A [[Field Type: Text|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 [[Field Type: Boolean|true/false field]] that indicates if amounts for this payroll category are included on the payroll payment advice.

;CalculationBasis
:A [[Field Type: Record|record field]] that provides the calculation basis details for this payroll category.
:See [[#CalculationBasis Fields|CalculationBasis Fields]] for more information.

;Exclusion
:A [[Field Type: Decimal|decimal field]] that provides an amount used to reduce wages before calculating the superannuation amount.

;Limit
:A [[Field Type: Record|record field]] that provides the limits for this payroll category.
:See [[#Limit Fields|Limit Fields]] for more information.

;Threshold
:A [[Field Type: Decimal|decimal field]] that provides a minimum amount required before this expense is applicable.

;Exemptions
:A [[Field Type: Table|table field]] that provides a list of all the [[MYOB Field: PayrollCategories|payroll categories]] that the deduction payroll category is exempt from.

;RowVersion
:A [[Field Type: Row Version|row version field]].

== CalculationBasis Fields ==

The [[#Fields|CalculationBasis]] field contains the following sub-fields.

;Type
:A [[Field Type: Text|text field]] that provides the type of calculation used by the payroll category.
:Possible values are:
:* '''UserEntered''': Indicates the deduction is entered on the employees standard pay.
:* '''PercentageOfPayrollCategory''': Indicates the deduction is a percentage of another payroll category.
:* '''FixedDollars''': Indicates the deduction is a fixed amount.

;PercentageOf
:A [[Field Type: Decimal|decimal field]] that provides the percentage when '''Type''' is set to '''PercentageOfPayrollCategory'''

;PayrollCategory
:A [[Field Type: Record|record field]] that identifies the [[MYOB Field: PayrollCategories|payroll category]] used by the calculation.

;FixedDollarsOf
:A [[Field Type: Decimal|decimal field]] that provides the amount when '''Type''' is set to '''FixedDollars'''.

;AccrualPeriod
:A [[Field Type: Text|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 [[#Fields|Limit]] field contains the following sub-fields.

;Type
:A [[Field Type: Text|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 deduction is capped at percentage of another payroll category.
:* '''FixedDollars''': Indicates the deduction is capped at a fixed amount.

;PercentageOf
:A [[Field Type: Decimal|decimal field]] that provides the percentage when '''Type''' is set to '''PercentageOfPayrollCategory'''

;PayrollCategory
:A [[Field Type: Record|record field]] that identifies the [[MYOB Field: PayrollCategories|payroll category]] used by the calculation.

;FixedDollarsOf
:A [[Field Type: Decimal|decimal field]] that provides the amount when '''Type''' is set to '''FixedDollars'''.

;AccrualPeriod
:A [[Field Type: Text|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 [https://developer.myob.com/api/accountright/v2/payroll/payroll-category/superannuation/ MYOB API].

== Related Fields ==

:[[MYOB Field: Accounts|Accounts]]
:[[MYOB Field: PayrollCategories|PayrollCategories]]

== Related Endpoints==

:[[MYOB Endpoint: PayrollCategories|PayrollCategories]]