11openapi : 3.0.0
22info :
3- version : 9.1.1
4- title : ' Xero Payroll UK'
5- description : ' This is the Xero Payroll API for orgs in the UK region.'
6- termsOfService : " https://developer.xero.com/xero-developer-platform-terms-conditions/"
3+ version : 9.2.0
4+ title : Xero Payroll UK
5+ description : This is the Xero Payroll API for orgs in the UK region.
6+ termsOfService : https://developer.xero.com/xero-developer-platform-terms-conditions/
77 contact :
88 name : Xero Platform Team
99@@ -245,8 +245,8 @@ paths:
245245 countryName : UNITED KINGDOM
246246 postCode : MK9 1EB
247247 payrollCalendarID : null
248- updatedDateUTC : ' 2020-03-25T03:12:10Z'
249- createdDateUTC : ' 2020-03-25T03:12:10Z'
248+ updatedDateUTC : " 2020-03-25T03:12:10Z"
249+ createdDateUTC : " 2020-03-25T03:12:10Z"
250250 niCategory : null
251251 employeeNumber : null
252252 " 400 " :
@@ -303,22 +303,22 @@ paths:
303303 application/json :
304304 schema :
305305 $ref : ' #/components/schemas/EmployeeObject'
306- example :
306+ example :
307307 id : 9414291b-a8c6-08fa-b165-9b30b1e6aab5
308- providerName : " !YLT5Y"
309- dateTimeUTC : ' 2018-04-09T05:15:18.1011141'
308+ providerName : ' !YLT5Y'
309+ dateTimeUTC : 2018-04-09T05:15:18.1011141
310310 httpStatusCode : OK
311311 pagination : null
312312 employee :
313313 employeeID : d17e008e-3381-45c0-b50c-2fab7757e503
314314 title : Mr.
315315 firstName : Edgar
316316 lastName : Allan Po
317- dateOfBirth : ' 1985-03-24'
317+ dateOfBirth : " 1985-03-24"
318318 gender : M
319319320- phoneNumber : ' 0400123456'
321- nationalInsuranceNumber : ' AB123456C'
320+ phoneNumber : " 0400123456"
321+ nationalInsuranceNumber : AB123456C
322322 isOffPayrollWorker : false
323323 address :
324324 addressLine1 : 171 Midsummer
@@ -327,18 +327,18 @@ paths:
327327 countryName : UNITED KINGDOM
328328 postCode : MK9 1EB
329329 payrollCalendarID : 216d80e6-af55-47b1-b718-9457c3f5d2fe
330- updatedDateUTC : ' 2017-05-12T10:00:24Z'
331- createdDateUTC : ' 2017-05-12T10:00:24Z'
330+ updatedDateUTC : " 2017-05-12T10:00:24Z"
331+ createdDateUTC : " 2017-05-12T10:00:24Z"
332332 niCategories :
333- - startDate : ' 2020-05-01'
334- niCategory : I
335- workplacePostcode : SW1A 1AA
336- - startDate : ' 2020-05-02'
337- niCategory : F
338- niCategoryID : 1
339- dateFirstEmployedAsCivilian : ' 2020-05-01'
340- workplacePostcode : SW1A 1AA
341- employeeNumber : ' 2 '
333+ - startDate : " 2020-05-01"
334+ niCategory : I
335+ workplacePostcode : SW1A 1AA
336+ - startDate : " 2020-05-02"
337+ niCategory : F
338+ niCategoryID : 1
339+ dateFirstEmployedAsCivilian : " 2020-05-01"
340+ workplacePostcode : SW1A 1AA
341+ employeeNumber : " 2 "
342342 put :
343343 security :
344344 - OAuth2 :
@@ -576,24 +576,24 @@ paths:
576576 application/json :
577577 schema :
578578 $ref : ' #/components/schemas/EmploymentObject'
579- example :
579+ example :
580580 id : 0160a355-1e6d-4fdc-9532-c0857feaa515
581581 providerName : provider-name
582- dateTimeUTC : ' 2020-03-26T18:09:11.6235442'
582+ dateTimeUTC : 2020-03-26T18:09:11.6235442
583583 httpStatusCode : OK
584- pagination :
585- problem :
584+ pagination :
585+ problem :
586586 employment :
587587 payrollCalendarID : 216d80e6-af55-47b1-b718-9457c3f5d2fe
588- startDate : ' 2020-04-01T00:00:00'
588+ startDate : 2020-04-01T00:00:00
589589 niCategories :
590- - niCategory : I
591- startDate : ' 2020-05-01'
592- niCategoryID : 594
593- dateFirstEmployedAsCivilian : ' 2020-05-01'
594- workplacePostcode : SW1A 1AA
590+ - niCategory : I
591+ startDate : " 2020-05-01"
592+ niCategoryID : 594
593+ dateFirstEmployedAsCivilian : " 2020-05-01"
594+ workplacePostcode : SW1A 1AA
595595 employeeNumber : 123ABC
596- ' 400 ' :
596+ " 400 " :
597597 description : validation error for a bad request
598598 content :
599599 application/json :
@@ -605,13 +605,13 @@ paths:
605605 application/json :
606606 schema :
607607 $ref : ' #/components/schemas/Employment'
608- example :
608+ example :
609609 payrollCalendarID : cdfb8371-0b21-4b8a-8903-1024df6c391e
610- startDate : ' 2024-04-01'
610+ startDate : " 2024-04-01"
611611 niCategories :
612- - niCategory : I
613- startDate : ' 2020-05-01'
614- workplacePostcode : SW1A 1AA
612+ - niCategory : I
613+ startDate : " 2020-05-01"
614+ workplacePostcode : SW1A 1AA
615615 employeeNumber : 123ABC
616616 /Employees/{EmployeeID}/Tax :
617617 parameters :
@@ -5649,7 +5649,6 @@ components:
56495649 type : array
56505650 items :
56515651 $ref : ' #/components/schemas/NICategory'
5652-
56535652 EmployeeTaxObject :
56545653 type : object
56555654 properties :
@@ -7473,23 +7472,23 @@ components:
74737472 type : string
74747473 example : I
74757474 enum :
7476- - A
7477- - B
7478- - C
7479- - F
7480- - H
7481- - I
7482- - J
7483- - L
7484- - M
7485- - S
7486- - V
7487- - X
7488- - Z
7489- - D
7490- - E
7491- - K
7492- - N
7475+ - A
7476+ - B
7477+ - C
7478+ - F
7479+ - H
7480+ - I
7481+ - J
7482+ - L
7483+ - M
7484+ - S
7485+ - V
7486+ - X
7487+ - Z
7488+ - D
7489+ - E
7490+ - K
7491+ - N
74937492 NICategory :
74947493 type : object
74957494 required :
@@ -7500,8 +7499,8 @@ components:
75007499 description : The start date of the NI category (YYYY-MM-DD)
75017500 type : string
75027501 format : date
7503- example : 2024-12-02
7504- x-is-date : true
7502+ example : 2024-12-02
7503+ x-is-date : true
75057504 niCategory :
75067505 $ref : ' #/components/schemas/NICategoryLetter'
75077506 niCategoryID :
@@ -7513,17 +7512,17 @@ components:
75137512 type : string
75147513 format : date
75157514 example : 2024-12-02
7516- x-is-date : true
7515+ x-is-date : true
75177516 workplacePostcode :
75187517 description : The workplace postcode
75197518 type : string
75207519 example : SW1A 1AA
75217520 oneOf :
75227521 - required :
7523- - workplacePostcode
7522+ - workplacePostcode
75247523 properties :
75257524 niCategory :
7526- enum :
7525+ enum :
75277526 - F
75287527 - I
75297528 - L
@@ -7533,7 +7532,7 @@ components:
75337532 - D
75347533 - K
75357534 - required :
7536- - dateFirstEmployedAsCivilian
7535+ - dateFirstEmployedAsCivilian
75377536 properties :
75387537 niCategory :
75397538 enum :
0 commit comments