MYOB Endpoint: PayrollEntitlements
Jump to navigation
Jump to search
Overview
The MYOB PayrollEntitlements endpoint allows you to access the list of all entitlement payroll categories within MYOB.
Fields
The following fields are available for the PayrollEntitlements 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 Entitlement.
- PrintOnPayAdvice
- A true/false field that indicates if this amounts are printed on the payroll advice for 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
- CarryEntitlementOverToNextYear
- A true/false field that indicates if amounts rolled over to the next financial year or resets to 0.
- CalculationBasis
- A record field that provides the calculation basis details for this payroll category.
- See CalculationBasis Fields for more information.
- LinkedPayrollCategoryWages
- A table field that provides a list of all the payroll categories that are used to reduce this entitlement.
- For example, the AnnualLeaveAccrued entitlement should be linked to an AnnualLeaveTaken wage.
- 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.
- FixedHours: 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.
- FixedHoursOf
- A decimal field that provides the hours when Type is set to FixedHours.
- AccrualPeriod
- A text field that indicates the accrual period basis when Type is set to FixedDollars.
- Possible values are:
- PayPeriod: Indicates the FixedHoursOf value is an amount of hours per pay period.
- Month: Indicates the FixedHoursOf value is an amount of hours per month.
- Year: Indicates the FixedHoursOf value is an amount of hours per year.
- Hour: Indicates the FixedHoursOf value is an amount of hours per hour.
MYOB API
For a detailed run through of the endpoint, you can see the MYOB API.
Related Fields
Related Endpoints