Skip to content

Commit b4cbd7b

Browse files
Nikky Whitesaxon-is-my-name
Nikky White
authored and
saxon-is-my-name
committed
feat: added QualifyingEarnings for au payroll
1 parent fc83a04 commit b4cbd7b

File tree

1 file changed

+60
-11
lines changed

1 file changed

+60
-11
lines changed

‎xero-payroll-au.yaml‎

Lines changed: 60 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,7 @@ paths:
313313
UpdatedDateUTC: /Date(1573623306000+0000)/
314314
HasStudentStartupLoan: false
315315
ResidencyStatus: AUSTRALIANRESIDENT
316+
IncludeLeaveLoadingInQualifyingEarnings: false
316317
BankAccounts: []
317318
OpeningBalances:
318319
OpeningBalanceDate: /Date(1573603200000+0000)/
@@ -348,6 +349,7 @@ paths:
348349
CalculationType: FIXEDAMOUNTEACHPERIOD
349350
AnnualNumberOfUnits: 4
350351
EntitlementFinalPayPayoutType: NOTPAIDOUT
352+
IsQualifyingEarnings: false
351353
SuperMemberships: []
352354
LeaveBalances:
353355
- LeaveName: Carer Leave (unpaid)
@@ -1219,10 +1221,11 @@ paths:
12191221
AccountCode: "477"
12201222
TypeOfUnits: Hours
12211223
RatePerUnit: 3
1222-
IsExemptFromTax: true
1223-
IsExemptFromSuper: true
1224-
IsReportableAsW1: true
1225-
AllowanceContributesToAnnualLeaveRate: false
1224+
IsExemptFromTax: false
1225+
IsExemptFromSuper: false
1226+
IsReportableAsW1: false
1227+
IsQualifyingEarnings: true
1228+
AllowanceContributesToAnnualLeaveRate: true
12261229
AllowanceContributesToOvertimeRate: false
12271230
UpdatedDateUTC: /Date(1573620821000+0000)/
12281231
CurrentRecord: true
@@ -1235,6 +1238,7 @@ paths:
12351238
IsExemptFromTax: false
12361239
IsExemptFromSuper: true
12371240
IsReportableAsW1: false
1241+
IsQualifyingEarnings: false
12381242
AllowanceContributesToAnnualLeaveRate: false
12391243
AllowanceContributesToOvertimeRate: false
12401244
UpdatedDateUTC: /Date(1547500330000+0000)/
@@ -1247,6 +1251,7 @@ paths:
12471251
IsExemptFromTax: true
12481252
IsExemptFromSuper: true
12491253
IsReportableAsW1: true
1254+
IsQualifyingEarnings: false
12501255
AllowanceContributesToAnnualLeaveRate: false
12511256
AllowanceContributesToOvertimeRate: false
12521257
UpdatedDateUTC: /Date(1547500330000+0000)/
@@ -1260,6 +1265,7 @@ paths:
12601265
IsExemptFromTax: false
12611266
IsExemptFromSuper: true
12621267
IsReportableAsW1: true
1268+
IsQualifyingEarnings: false
12631269
AllowanceContributesToAnnualLeaveRate: false
12641270
AllowanceContributesToOvertimeRate: false
12651271
UpdatedDateUTC: /Date(1573620791000+0000)/
@@ -1305,20 +1311,26 @@ paths:
13051311
ShowOnPayslip: true
13061312
UpdatedDateUTC: /Date(1573620853000+0000)/
13071313
CurrentRecord: true
1314+
SGCExempt: false
1315+
IsQualifyingEarnings: true
13081316
- LeaveTypeID: 74195ab2-1f2b-4136-8ddc-20387a0b1027
13091317
Name: Long Service Leave
13101318
TypeOfUnits: Hours
13111319
IsPaidLeave: true
13121320
ShowOnPayslip: false
13131321
UpdatedDateUTC: /Date(1547500330000+0000)/
13141322
CurrentRecord: true
1323+
SGCExempt: false
1324+
IsQualifyingEarnings: true
13151325
- LeaveTypeID: ff4d16da-ae8a-4f57-acb3-9ee593996bce
13161326
Name: Parental Leave (unpaid)
13171327
TypeOfUnits: Hours
13181328
IsPaidLeave: false
13191329
ShowOnPayslip: false
13201330
UpdatedDateUTC: /Date(1547500330000+0000)/
13211331
CurrentRecord: true
1332+
SGCExempt: false
1333+
IsQualifyingEarnings: false
13221334
"400":
13231335
description: validation error for a bad request
13241336
content:
@@ -1373,6 +1385,13 @@ paths:
13731385
object: earningsRate
13741386
default: true
13751387
nonString: true
1388+
- isQualifyingEarnings:
1389+
key: isQualifyingEarnings
1390+
keyPascal: IsQualifyingEarnings
1391+
keySnake: is_qualifying_earnings
1392+
object: earningsRate
1393+
default: false
1394+
nonString: true
13761395
- earningsType:
13771396
key: earningsType
13781397
nonString: true
@@ -1594,6 +1613,7 @@ paths:
15941613
IsExemptFromSuper: true
15951614
AccrueLeave: false
15961615
IsReportableAsW1: false
1616+
IsQualifyingEarnings: false
15971617
AllowanceContributesToAnnualLeaveRate: false
15981618
AllowanceContributesToOvertimeRate: false
15991619
UpdatedDateUTC: /Date(1593448963210+0000)/
@@ -1606,6 +1626,7 @@ paths:
16061626
IsExemptFromTax: true
16071627
IsExemptFromSuper: true
16081628
IsReportableAsW1: true
1629+
IsQualifyingEarnings: false
16091630
AllowanceContributesToAnnualLeaveRate: false
16101631
AllowanceContributesToOvertimeRate: false
16111632
UpdatedDateUTC: /Date(1476729649000+0000)/
@@ -1619,13 +1640,14 @@ paths:
16191640
IsExemptFromTax: false
16201641
IsExemptFromSuper: true
16211642
IsReportableAsW1: true
1643+
IsQualifyingEarnings: false
16221644
AllowanceContributesToAnnualLeaveRate: false
16231645
AllowanceContributesToOvertimeRate: false
16241646
UpdatedDateUTC: /Date(1520900705000+0000)/
16251647
EmploymentTerminationPaymentType: O
16261648
CurrentRecord: true
16271649
"400":
1628-
description: invalid input, object invalid - TODO
1650+
description: invalid input, object invalid - When IsQualifyingEarnings supplied it will be validated against the IsExemptFromSuper and other fields.
16291651
requestBody:
16301652
required: true
16311653
content:
@@ -1637,9 +1659,10 @@ paths:
16371659
- Name: MyRate
16381660
AccountCode: "400"
16391661
TypeOfUnits: "4.00"
1640-
IsExemptFromTax: true
1662+
IsExemptFromTax: false
16411663
IsExemptFromSuper: true
16421664
IsReportableAsW1: false
1665+
IsQualifyingEarnings: true
16431666
AllowanceContributesToAnnualLeaveRate: false
16441667
AllowanceContributesToOvertimeRate: false
16451668
EarningsType: ORDINARYTIMEEARNINGS
@@ -3350,10 +3373,6 @@ components:
33503373
type: array
33513374
items:
33523375
$ref: "#/components/schemas/LeaveBalance"
3353-
LeaveLines:
3354-
type: array
3355-
items:
3356-
$ref: "#/components/schemas/LeaveLine"
33573376
SuperMemberships:
33583377
type: array
33593378
items:
@@ -4238,6 +4257,10 @@ components:
42384257
description: Boolean to determine if the earnings rate is reportable or exempt from W1
42394258
type: boolean
42404259
example: false
4260+
IsQualifyingEarnings:
4261+
description: Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings
4262+
type: boolean
4263+
example: true
42414264
AllowanceContributesToAnnualLeaveRate:
42424265
description: Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
42434266
type: boolean
@@ -4387,6 +4410,10 @@ components:
43874410
description: Set this to indicate that the leave type is exempt from superannuation guarantee contribution
43884411
type: boolean
43894412
example: true
4413+
IsQualifyingEarnings:
4414+
description: Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings
4415+
type: boolean
4416+
example: true
43904417
ReimbursementType:
43914418
type: object
43924419
properties:
@@ -4521,6 +4548,10 @@ components:
45214548
readOnly: true
45224549
x-is-msdate-time: true
45234550
example: /Date(1583967733054+0000)/
4551+
IncludeLeaveLoadingInQualifyingEarnings:
4552+
description: Optional Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations
4553+
type: boolean
4554+
example: true
45244555
type: object
45254556
BankAccount:
45264557
type: object
@@ -4755,6 +4786,10 @@ components:
47554786
description: amount of leave line
47564787
type: boolean
47574788
example: true
4789+
IsQualifyingEarnings:
4790+
description: Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settings
4791+
type: boolean
4792+
example: true
47584793
NumberOfUnits:
47594794
description: Number of units for leave line.
47604795
type: number
@@ -4806,6 +4841,20 @@ components:
48064841
description: Reset the STP categorisations for the leave type. *Only applicable for Leave Types with Annual Leave Categories
48074842
type: boolean
48084843
example: true
4844+
OpeningBalanceLeaveLine:
4845+
type: object
4846+
properties:
4847+
LeaveTypeID:
4848+
description: Xero leave type identifier
4849+
type: string
4850+
format: uuid
4851+
example: 742998cb-7584-4ecf-aa88-d694f59c50f9
4852+
NumberOfUnits:
4853+
description: Number of units for leave line.
4854+
type: number
4855+
format: double
4856+
x-is-money: true
4857+
example: 2.5
48094858
OpeningBalances:
48104859
type: object
48114860
properties:
@@ -4837,7 +4886,7 @@ components:
48374886
LeaveLines:
48384887
type: array
48394888
items:
4840-
$ref: "#/components/schemas/LeaveLine"
4889+
$ref: "#/components/schemas/OpeningBalanceLeaveLine"
48414890
PaidLeaveEarningsLines:
48424891
type: array
48434892
items:

0 commit comments

Comments
 (0)