Skip to content

Commit a98454d

Browse files
committed
feat: enable enums to be open for xero-payroll-au.yaml
BREAKING CHANGE: open enums
1 parent c35c853 commit a98454d

1 file changed

Lines changed: 156 additions & 46 deletions

File tree

xero-payroll-au.yaml

Lines changed: 156 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -3248,12 +3248,14 @@ components:
32483248
example: developer@me.com
32493249
Gender:
32503250
description: The employee’s gender. See Employee Gender
3251-
type: string
3252-
enum:
3253-
- N
3254-
- M
3255-
- F
3256-
- I
3251+
anyOf:
3252+
- type: string
3253+
enum:
3254+
- N
3255+
- M
3256+
- F
3257+
- I
3258+
- type: string
32573259
example: F
32583260
Phone:
32593261
description: Employee phone number
@@ -3316,15 +3318,17 @@ components:
33163318
* `F` Dismissal - An employer-initiated termination of employment due to dismissal, inability to perform the required work, misconduct or inefficiency
33173319
* `C` Contract cessation - The natural conclusion of a limited employment relationship due to contract/engagement duration or task completion, seasonal work completion, or to cease casuals that are no longer required
33183320
* `T` Transfer - The administrative arrangements performed to transfer employees across payroll systems, move them temporarily to another employer (machinery of government for public servants), transfer of business, move them to outsourcing arrangements or other such technical activities.
3319-
type: string
3320-
enum:
3321-
- V
3322-
- I
3323-
- D
3324-
- R
3325-
- F
3326-
- C
3327-
- T
3321+
anyOf:
3322+
- type: string
3323+
enum:
3324+
- V
3325+
- I
3326+
- D
3327+
- R
3328+
- F
3329+
- C
3330+
- T
3331+
- type: string
33283332
example: F
33293333
BankAccounts:
33303334
type: array
@@ -3459,13 +3463,17 @@ components:
34593463
example: /Date(322560000000+0000)/
34603464
LeavePeriodStatus:
34613465
$ref: '#/components/schemas/LeavePeriodStatus'
3462-
LeavePeriodStatus:
3466+
LeavePeriodStatusClosed:
34633467
type: string
34643468
enum:
34653469
- SCHEDULED #The default status
34663470
- PROCESSED #A LeavePeriod is set to the "Processed" status when the Payrun associated with the LeavePeriod is "POSTED"
34673471
- REQUESTED
34683472
- REJECTED
3473+
LeavePeriodStatus:
3474+
anyOf:
3475+
- $ref: '#/components/schemas/LeavePeriodStatusClosed'
3476+
- type: string
34693477
PayItems:
34703478
type: object
34713479
x-objectArrayKey: pay_items
@@ -4327,11 +4335,13 @@ components:
43274335
x-is-msdate-time: true
43284336
example: /Date(1583967733054+0000)/
43294337
DeductionCategory:
4330-
type: string
4331-
enum:
4332-
- NONE
4333-
- UNIONFEES
4334-
- WORKPLACEGIVING
4338+
anyOf:
4339+
- type: string
4340+
enum:
4341+
- NONE
4342+
- UNIONFEES
4343+
- WORKPLACEGIVING
4344+
- type: string
43354345
CurrentRecord:
43364346
description: Is the current record
43374347
type: boolean
@@ -4880,13 +4890,17 @@ components:
48804890
- JURYDUTYLEAVE
48814891
- DEFENCERESERVELEAVE
48824892
example: ANNUALLEAVE
4883-
RateType:
4893+
RateTypeClosed:
48844894
type: string
48854895
enum:
48864896
- FIXEDAMOUNT
48874897
- MULTIPLE #Multiple of Employee’s Ordinary Earnings Rate - an earnings rate which is derived from an employee’s ordinary earnings rate
48884898
- RATEPERUNIT #An earnings rate allowing entry of a rate per unit
4889-
EarningsType:
4899+
RateType:
4900+
anyOf:
4901+
- $ref: '#/components/schemas/RateTypeClosed'
4902+
- type: string
4903+
EarningsTypeClosed:
48904904
type: string
48914905
enum:
48924906
- FIXED
@@ -4903,12 +4917,20 @@ components:
49034917
- DIRECTORSFEES
49044918
- PAIDPARENTALLEAVE
49054919
- WORKERSCOMPENSATION
4906-
EmploymentTerminationPaymentType:
4920+
EarningsType:
4921+
anyOf:
4922+
- $ref: '#/components/schemas/EarningsTypeClosed'
4923+
- type: string
4924+
EmploymentTerminationPaymentTypeClosed:
49074925
type: string
49084926
enum:
49094927
- O
49104928
- R
4911-
AllowanceType:
4929+
EmploymentTerminationPaymentType:
4930+
anyOf:
4931+
- $ref: '#/components/schemas/EmploymentTerminationPaymentTypeClosed'
4932+
- type: string
4933+
AllowanceTypeClosed:
49124934
type: string
49134935
enum:
49144936
- CAR
@@ -4920,7 +4942,11 @@ components:
49204942
- TOOLS
49214943
- TASKS
49224944
- QUALIFICATIONS
4923-
AllowanceCategory:
4945+
AllowanceType:
4946+
anyOf:
4947+
- $ref: '#/components/schemas/AllowanceTypeClosed'
4948+
- type: string
4949+
AllowanceCategoryClosed:
49244950
type: string
49254951
enum:
49264952
- NONDEDUCTIBLE
@@ -4930,7 +4956,11 @@ components:
49304956
- TRANSPORT
49314957
- GENERAL
49324958
- OTHER
4933-
CalendarType:
4959+
AllowanceCategory:
4960+
anyOf:
4961+
- $ref: '#/components/schemas/AllowanceCategoryClosed'
4962+
- type: string
4963+
CalendarTypeClosed:
49344964
type: string
49354965
enum:
49364966
- WEEKLY
@@ -4939,18 +4969,30 @@ components:
49394969
- MONTHLY
49404970
- TWICEMONTHLY
49414971
- QUARTERLY
4942-
EarningsRateCalculationType:
4972+
CalendarType:
4973+
anyOf:
4974+
- $ref: '#/components/schemas/CalendarTypeClosed'
4975+
- type: string
4976+
EarningsRateCalculationTypeClosed:
49434977
type: string
49444978
enum:
49454979
- USEEARNINGSRATE
49464980
- ENTEREARNINGSRATE
49474981
- ANNUALSALARY
4948-
DeductionTypeCalculationType:
4982+
EarningsRateCalculationType:
4983+
anyOf:
4984+
- $ref: '#/components/schemas/EarningsRateCalculationTypeClosed'
4985+
- type: string
4986+
DeductionTypeCalculationTypeClosed:
49494987
type: string
49504988
enum:
49514989
- FIXEDAMOUNT
49524990
- PRETAX
49534991
- POSTTAX
4992+
DeductionTypeCalculationType:
4993+
anyOf:
4994+
- $ref: '#/components/schemas/DeductionTypeCalculationTypeClosed'
4995+
- type: string
49544996
LeaveLineCalculationType:
49554997
description: Calculation type for leave line for Opening Balance on Employee
49564998
type: string
@@ -4959,20 +5001,28 @@ components:
49595001
- FIXEDAMOUNTEACHPERIOD
49605002
- ENTERRATEINPAYTEMPLATE
49615003
- BASEDONORDINARYEARNINGS
4962-
SuperannuationContributionType:
5004+
SuperannuationContributionTypeClosed:
49635005
type: string
49645006
enum:
49655007
- SGC
49665008
- SALARYSACRIFICE
49675009
- EMPLOYERADDITIONAL
49685010
- EMPLOYEE
4969-
SuperannuationCalculationType:
5011+
SuperannuationContributionType:
5012+
anyOf:
5013+
- $ref: '#/components/schemas/SuperannuationContributionTypeClosed'
5014+
- type: string
5015+
SuperannuationCalculationTypeClosed:
49705016
type: string
49715017
enum:
49725018
- FIXEDAMOUNT
49735019
- PERCENTAGEOFEARNINGS
49745020
- STATUTORY
4975-
PaymentFrequencyType:
5021+
SuperannuationCalculationType:
5022+
anyOf:
5023+
- $ref: '#/components/schemas/SuperannuationCalculationTypeClosed'
5024+
- type: string
5025+
PaymentFrequencyTypeClosed:
49765026
type: string
49775027
enum:
49785028
- WEEKLY
@@ -4982,24 +5032,40 @@ components:
49825032
- TWICEMONTHLY
49835033
- FOURWEEKLY
49845034
- YEARLY
4985-
LeaveTypeContributionType:
5035+
PaymentFrequencyType:
5036+
anyOf:
5037+
- $ref: '#/components/schemas/PaymentFrequencyTypeClosed'
5038+
- type: string
5039+
LeaveTypeContributionTypeClosed:
49865040
type: string
49875041
enum:
49885042
- SGC
49895043
- SALARYSACRIFICE
49905044
- EMPLOYERADDITIONAL
49915045
- EMPLOYEE
4992-
EntitlementFinalPayPayoutType:
5046+
LeaveTypeContributionType:
5047+
anyOf:
5048+
- $ref: '#/components/schemas/LeaveTypeContributionTypeClosed'
5049+
- type: string
5050+
EntitlementFinalPayPayoutTypeClosed:
49935051
type: string
49945052
enum:
49955053
- NOTPAIDOUT
49965054
- PAIDOUT
4997-
PayRunStatus:
5055+
EntitlementFinalPayPayoutType:
5056+
anyOf:
5057+
- $ref: '#/components/schemas/EntitlementFinalPayPayoutTypeClosed'
5058+
- type: string
5059+
PayRunStatusClosed:
49985060
type: string
49995061
enum:
50005062
- DRAFT
50015063
- POSTED
5002-
ManualTaxType:
5064+
PayRunStatus:
5065+
anyOf:
5066+
- $ref: '#/components/schemas/PayRunStatusClosed'
5067+
- type: string
5068+
ManualTaxTypeClosed:
50035069
type: string
50045070
enum:
50055071
- PAYGMANUAL
@@ -5008,16 +5074,28 @@ components:
50085074
- SCHEDULE5MANUAL
50095075
- SCHEDULE5STSLMANUAL
50105076
- SCHEDULE4MANUAL
5011-
SuperFundType:
5077+
ManualTaxType:
5078+
anyOf:
5079+
- $ref: '#/components/schemas/ManualTaxTypeClosed'
5080+
- type: string
5081+
SuperFundTypeClosed:
50125082
type: string
50135083
enum:
50145084
- REGULATED
50155085
- SMSF
5016-
EmploymentType:
5086+
SuperFundType:
5087+
anyOf:
5088+
- $ref: '#/components/schemas/SuperFundTypeClosed'
5089+
- type: string
5090+
EmploymentTypeClosed:
50175091
type: string
50185092
enum:
50195093
- EMPLOYEE
50205094
- CONTRACTOR
5095+
EmploymentType:
5096+
anyOf:
5097+
- $ref: '#/components/schemas/EmploymentTypeClosed'
5098+
- type: string
50215099
CountryOfResidence:
50225100
description: Country of residence as a valid ISO 3166-1 alpha-2 country code e.g. "AU", "NZ", "CA". Only applicable, and mandatory if income type is WORKINGHOLIDAYMAKER.
50235101
type: string
@@ -5273,15 +5351,19 @@ components:
52735351
- CW
52745352
- SX
52755353
- SS
5276-
IncomeType:
5354+
IncomeTypeClosed:
52775355
type: string
52785356
enum:
52795357
- SALARYANDWAGES
52805358
- WORKINGHOLIDAYMAKER
52815359
- NONEMPLOYEE
52825360
- CLOSELYHELDPAYEES
52835361
- LABOURHIRE
5284-
TaxScaleType:
5362+
IncomeType:
5363+
anyOf:
5364+
- $ref: '#/components/schemas/IncomeTypeClosed'
5365+
- type: string
5366+
TaxScaleTypeClosed:
52855367
type: string
52865368
enum:
52875369
- REGULAR
@@ -5290,19 +5372,31 @@ components:
52905372
- SENIORORPENSIONER
52915373
- WORKINGHOLIDAYMAKER
52925374
- FOREIGN
5293-
WorkCondition:
5375+
TaxScaleType:
5376+
anyOf:
5377+
- $ref: '#/components/schemas/TaxScaleTypeClosed'
5378+
- type: string
5379+
WorkConditionClosed:
52945380
type: string
52955381
enum:
52965382
- PROMOTIONAL
52975383
- THREELESSPERFORMANCESPERWEEK
52985384
- NONE
5299-
SeniorMaritalStatus:
5385+
WorkCondition:
5386+
anyOf:
5387+
- $ref: '#/components/schemas/WorkConditionClosed'
5388+
- type: string
5389+
SeniorMaritalStatusClosed:
53005390
type: string
53015391
enum:
53025392
- MEMBEROFCOUPLE
53035393
- MEMBEROFILLNESSSEPARATEDCOUPLE
53045394
- SINGLE
5305-
EmploymentBasis:
5395+
SeniorMaritalStatus:
5396+
anyOf:
5397+
- $ref: '#/components/schemas/SeniorMaritalStatusClosed'
5398+
- type: string
5399+
EmploymentBasisClosed:
53065400
type: string
53075401
enum:
53085402
- FULLTIME
@@ -5311,27 +5405,43 @@ components:
53115405
- LABOURHIRE
53125406
- SUPERINCOMESTREAM # Usage is deprecated.
53135407
- NONEMPLOYEE
5314-
TFNExemptionType:
5408+
EmploymentBasis:
5409+
anyOf:
5410+
- $ref: '#/components/schemas/EmploymentBasisClosed'
5411+
- type: string
5412+
TFNExemptionTypeClosed:
53155413
type: string
53165414
enum:
53175415
- NOTQUOTED
53185416
- PENDING
53195417
- PENSIONER
53205418
- UNDER18
5321-
ResidencyStatus:
5419+
TFNExemptionType:
5420+
anyOf:
5421+
- $ref: '#/components/schemas/TFNExemptionTypeClosed'
5422+
- type: string
5423+
ResidencyStatusClosed:
53225424
type: string
53235425
enum:
53245426
- AUSTRALIANRESIDENT
53255427
- FOREIGNRESIDENT
53265428
- WORKINGHOLIDAYMAKER # Usage is deprecated.
5327-
TimesheetStatus:
5429+
ResidencyStatus:
5430+
anyOf:
5431+
- $ref: '#/components/schemas/ResidencyStatusClosed'
5432+
- type: string
5433+
TimesheetStatusClosed:
53285434
type: string
53295435
enum:
53305436
- DRAFT
53315437
- PROCESSED
53325438
- APPROVED
53335439
- REJECTED
53345440
- REQUESTED
5441+
TimesheetStatus:
5442+
anyOf:
5443+
- $ref: '#/components/schemas/TimesheetStatusClosed'
5444+
- type: string
53355445
EmployeeStatus:
53365446
type: string
53375447
description: Employee Status Types

0 commit comments

Comments
 (0)