Skip to content

Commit cbafaed

Browse files
manishT72manishT72
authored
update examples to be compatible with Java tests (#731)
update examples to be compatible with Java tests (#731)
1 parent 972b173 commit cbafaed

File tree

1 file changed

+75
-103
lines changed

1 file changed

+75
-103
lines changed

‎xero-payroll-uk.yaml‎

Lines changed: 75 additions & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -62,62 +62,56 @@ paths:
6262
- employeeID: aad6b292-7b94-408b-93f6-e489867e3fb0
6363
firstName: Jack
6464
lastName: Allan
65-
dateOfBirth: 1987-12-23T00:00:00
65+
dateOfBirth: 1987-12-23T00:00:00Z
6666
gender: M
6767
email: null
6868
phoneNumber: null
6969
startDate: 2020-02-03T00:00:00
7070
address:
7171
addressLine1: 171 Midsummer Boulevard
72-
addressLine2: null
7372
city: Milton Keynes
7473
county: null
7574
countryName: UNITED KINGDOM
7675
postCode: MK9 1EB
7776
payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe
7877
updatedDateUTC: 2020-02-13T16:23:31
7978
createdDateUTC: 2020-02-10T10:00:24
80-
endDate: null
8179
isOffPayrollWorker: false
8280
- employeeID: 67e545d4-e8a6-4f98-9f63-85c2383dfe12
8381
firstName: Charlotte
8482
lastName: Danes
85-
dateOfBirth: 1993-10-24T00:00:00
83+
dateOfBirth: 1993-10-24T00:00:00Z
8684
gender: F
8785
email: null
8886
phoneNumber: null
8987
startDate: 2020-02-03T00:00:00
9088
address:
9189
addressLine1: 171 Midsummer Blvd
92-
addressLine2: null
9390
city: Milton Keynes
9491
county: null
9592
countryName: UNITED KINGDOM
9693
postCode: MK9 1EB
9794
payrollCalendarID: 5e813d9e-949c-461f-8a89-e9ee8955a254
9895
updatedDateUTC: 2020-02-13T16:48:51
9996
createdDateUTC: 2020-02-13T16:32:12
100-
endDate: null
10197
isOffPayrollWorker: false
10298
- employeeID: eb4a0c3b-b0d6-440d-bccc-348b7dc92321
10399
firstName: Chelsea
104100
lastName: Serati
105-
dateOfBirth: 1976-02-16T00:00:00
101+
dateOfBirth: 1976-02-16T00:00:00Z
106102
gender: F
107103
email: null
108104
phoneNumber: null
109105
startDate: 2019-07-02T00:00:00
110106
address:
111107
addressLine1: 171 Midsummer Boulevard
112-
addressLine2: null
113108
city: Milton Keynes
114109
county: null
115110
countryName: UNITED KINGDOM
116111
postCode: MK9 1EB
117112
payrollCalendarID: d45bc68f-59d6-4000-929d-1058dcfa79e1
118113
updatedDateUTC: 2020-02-13T16:53:12
119114
createdDateUTC: 2020-02-13T16:46:41
120-
endDate: null
121115
isOffPayrollWorker: false
122116
"400":
123117
description: validation error for a bad request
@@ -237,7 +231,7 @@ paths:
237231
title: Mr
238232
firstName: Mike
239233
lastName: Fancy
240-
dateOfBirth: 1999-01-01T00:00:00
234+
dateOfBirth: 1999-01-01
241235
gender: M
242236
email: [email protected]
243237
phoneNumber: null
@@ -246,17 +240,15 @@ paths:
246240
isOffPayrollWorker: false
247241
address:
248242
addressLine1: 171 Midsummer
249-
addressLine2: null
250243
city: Milton Keyness
251244
county: null
252-
countryName: null
245+
countryName: UNITED KINGDOM
253246
postCode: MK9 1EB
254247
payrollCalendarID: null
255-
updatedDateUTC: 2020-03-25T03:12:10
256-
createdDateUTC: 2020-03-25T03:12:10
248+
updatedDateUTC: '2020-03-25T03:12:10Z'
249+
createdDateUTC: '2020-03-25T03:12:10Z'
257250
niCategory: null
258251
employeeNumber: null
259-
endDate: null
260252
"400":
261253
description: validation error for a bad request
262254
content:
@@ -273,7 +265,7 @@ paths:
273265
title: Mr
274266
firstName: Mike
275267
lastName: Fancy
276-
dateOfBirth: 1999-01-01T00:00:00
268+
dateOfBirth: 1999-01-01T00:00:00Z
277269
gender: M
278270
email: [email protected]
279271
isOffPayrollWorker: false
@@ -311,52 +303,42 @@ paths:
311303
application/json:
312304
schema:
313305
$ref: '#/components/schemas/EmployeeObject'
314-
example: '{
315-
"id": "9414291b-a8c6-08fa-b165-9b30b1e6aab5",
316-
"providerName": "!YLT5Y",
317-
"dateTimeUTC": "2018-04-09T05:15:18.1011141",
318-
"httpStatusCode": "OK",
319-
"pagination": null,
320-
"problem": null,
321-
"employee": {
322-
"employeeID": "d17e008e-3381-45c0-b50c-2fab7757e503",
323-
"title": "Mr.",
324-
"firstName": "Edgar",
325-
"lastName": "Allan Po",
326-
"dateOfBirth": "1985-03-24T00:00:00",
327-
"gender": "M",
328-
"email": "[email protected]",
329-
"phoneNumber": "0400123456",
330-
"nationalInsuranceNumber": null,
331-
"isOffPayrollWorker": false,
332-
"address": {
333-
"addressLine1": "171 Midsummer",
334-
"addressLine2": null,
335-
"city": "Milton Keyness",
336-
"county": null,
337-
"countryName": null,
338-
"postCode": "MK9 1EB"
339-
},
340-
"payrollCalendarID": null,
341-
"updatedDateUTC": "2017-05-12T10:00:24",
342-
"createdDateUTC": "2017-05-12T10:00:24",
343-
"niCategories": [
344-
{
345-
"startDate": "2020-05-01T00:00:00",
346-
"niCategory": "A"
347-
},
348-
{
349-
"startDate": null,
350-
"niCategory": "F",
351-
"niCategoryID": 1,
352-
"dateFirstEmployedAsCivilian": null,
353-
"workplacePostcode": "SW1A 1AA"
354-
}
355-
],
356-
"employeeNumber": "2",
357-
"endDate": null
358-
}
359-
}'
306+
example:
307+
id: 9414291b-a8c6-08fa-b165-9b30b1e6aab5
308+
providerName: "!YLT5Y"
309+
dateTimeUTC: '2018-04-09T05:15:18.1011141'
310+
httpStatusCode: OK
311+
pagination: null
312+
employee:
313+
employeeID: d17e008e-3381-45c0-b50c-2fab7757e503
314+
title: Mr.
315+
firstName: Edgar
316+
lastName: Allan Po
317+
dateOfBirth: '1985-03-24'
318+
gender: M
319+
email: [email protected]
320+
phoneNumber: '0400123456'
321+
nationalInsuranceNumber: 'AB123456C'
322+
isOffPayrollWorker: false
323+
address:
324+
addressLine1: 171 Midsummer
325+
city: Milton Keyness
326+
county: null
327+
countryName: UNITED KINGDOM
328+
postCode: MK9 1EB
329+
payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe
330+
updatedDateUTC: '2017-05-12T10:00:24Z'
331+
createdDateUTC: '2017-05-12T10:00:24Z'
332+
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'
360342
put:
361343
security:
362344
- OAuth2:
@@ -478,7 +460,7 @@ paths:
478460
title: Mr
479461
firstName: Mike
480462
lastName: Johnllsbkrhwopson
481-
dateOfBirth: 1999-01-01T00:00:00
463+
dateOfBirth: 1999-01-01
482464
gender: M
483465
email: [email protected]
484466
phoneNumber: "0400123456"
@@ -487,15 +469,13 @@ paths:
487469
isOffPayrollWorker: false
488470
address:
489471
addressLine1: 101 Green St
490-
addressLine2: null
491472
city: San Francisco
492473
county: null
493474
countryName: null
494475
postCode: 6TGR4F
495476
payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe
496477
updatedDateUTC: "2020-03-25T17:03:50Z"
497478
createdDateUTC: "2020-02-10T10:00:24Z"
498-
endDate: null
499479
"400":
500480
description: validation error for a bad request
501481
content:
@@ -512,7 +492,7 @@ paths:
512492
title: Mr.
513493
firstName: TestDataUK
514494
lastName: Tester
515-
dateOfBirth: 1992-11-22T00:00:00
495+
dateOfBirth: 1992-11-22T00:00:00Z
516496
gender: M
517497
email: [email protected]
518498
phoneNumber: "0400123456"
@@ -596,28 +576,23 @@ paths:
596576
application/json:
597577
schema:
598578
$ref: '#/components/schemas/EmploymentObject'
599-
example: '{
600-
"id": "0160a355-1e6d-4fdc-9532-c0857feaa515",
601-
"providerName": "provider-name",
602-
"dateTimeUTC": "2020-03-26T18:09:11.6235442",
603-
"httpStatusCode": "OK",
604-
"pagination": null,
605-
"problem": null,
606-
"employment": {
607-
"payrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe",
608-
"startDate": "2020-04-01T00:00:00",
609-
"niCategories": [
610-
{
611-
"niCategory": "A",
612-
"startDate": "2020-05-01",
613-
"niCategoryID": 594,
614-
"dateFirstEmployedAsCivilian": null,
615-
"workplacePostcode": null
616-
}
617-
],
618-
"employeeNumber": "123ABC"
619-
}
620-
}'
579+
example:
580+
id: 0160a355-1e6d-4fdc-9532-c0857feaa515
581+
providerName: provider-name
582+
dateTimeUTC: '2020-03-26T18:09:11.6235442'
583+
httpStatusCode: OK
584+
pagination:
585+
problem:
586+
employment:
587+
payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe
588+
startDate: '2020-04-01T00:00:00'
589+
niCategories:
590+
- niCategory: I
591+
startDate: '2020-05-01'
592+
niCategoryID: 594
593+
dateFirstEmployedAsCivilian: '2020-05-01'
594+
workplacePostcode: SW1A 1AA
595+
employeeNumber: 123ABC
621596
'400':
622597
description: validation error for a bad request
623598
content:
@@ -630,17 +605,14 @@ paths:
630605
application/json:
631606
schema:
632607
$ref: '#/components/schemas/Employment'
633-
example: '{
634-
"PayrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe",
635-
"StartDate": "2020-04-01",
636-
"NICategories": [
637-
{
638-
"NICategory": "A",
639-
"StartDate": "2020-05-01"
640-
}
641-
],
642-
"EmployeeNumber": "123ABC"
643-
}'
608+
example:
609+
payrollCalendarID: cdfb8371-0b21-4b8a-8903-1024df6c391e
610+
startDate: '2024-04-01'
611+
niCategories:
612+
- niCategory: I
613+
startDate: '2020-05-01'
614+
workplacePostcode: SW1A 1AA
615+
employeeNumber: 123ABC
644616
/Employees/{EmployeeID}/Tax:
645617
parameters:
646618
- $ref: '#/components/parameters/requiredHeader'
@@ -5797,10 +5769,10 @@ components:
57975769
Employment:
57985770
type: object
57995771
required:
5800-
- PayrollCalendarID
5801-
- StartDate
5802-
- EmployeeNumber
5803-
- NICategories
5772+
- payrollCalendarID
5773+
- startDate
5774+
- employeeNumber
5775+
- niCategories
58045776
properties:
58055777
payrollCalendarID:
58065778
description: Xero unique identifier for the payroll calendar of the employee

0 commit comments

Comments
 (0)