diff --git a/xero-payroll-uk.yaml b/xero-payroll-uk.yaml index c73b881f5..c099adcb5 100644 --- a/xero-payroll-uk.yaml +++ b/xero-payroll-uk.yaml @@ -62,14 +62,13 @@ paths: - employeeID: aad6b292-7b94-408b-93f6-e489867e3fb0 firstName: Jack lastName: Allan - dateOfBirth: 1987-12-23T00:00:00 + dateOfBirth: 1987-12-23T00:00:00Z gender: M email: null phoneNumber: null startDate: 2020-02-03T00:00:00 address: addressLine1: 171 Midsummer Boulevard - addressLine2: null city: Milton Keynes county: null countryName: UNITED KINGDOM @@ -77,19 +76,17 @@ paths: payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe updatedDateUTC: 2020-02-13T16:23:31 createdDateUTC: 2020-02-10T10:00:24 - endDate: null isOffPayrollWorker: false - employeeID: 67e545d4-e8a6-4f98-9f63-85c2383dfe12 firstName: Charlotte lastName: Danes - dateOfBirth: 1993-10-24T00:00:00 + dateOfBirth: 1993-10-24T00:00:00Z gender: F email: null phoneNumber: null startDate: 2020-02-03T00:00:00 address: addressLine1: 171 Midsummer Blvd - addressLine2: null city: Milton Keynes county: null countryName: UNITED KINGDOM @@ -97,19 +94,17 @@ paths: payrollCalendarID: 5e813d9e-949c-461f-8a89-e9ee8955a254 updatedDateUTC: 2020-02-13T16:48:51 createdDateUTC: 2020-02-13T16:32:12 - endDate: null isOffPayrollWorker: false - employeeID: eb4a0c3b-b0d6-440d-bccc-348b7dc92321 firstName: Chelsea lastName: Serati - dateOfBirth: 1976-02-16T00:00:00 + dateOfBirth: 1976-02-16T00:00:00Z gender: F email: null phoneNumber: null startDate: 2019-07-02T00:00:00 address: addressLine1: 171 Midsummer Boulevard - addressLine2: null city: Milton Keynes county: null countryName: UNITED KINGDOM @@ -117,7 +112,6 @@ paths: payrollCalendarID: d45bc68f-59d6-4000-929d-1058dcfa79e1 updatedDateUTC: 2020-02-13T16:53:12 createdDateUTC: 2020-02-13T16:46:41 - endDate: null isOffPayrollWorker: false "400": description: validation error for a bad request @@ -237,7 +231,7 @@ paths: title: Mr firstName: Mike lastName: Fancy - dateOfBirth: 1999-01-01T00:00:00 + dateOfBirth: 1999-01-01 gender: M email: mike@starkindustries.com phoneNumber: null @@ -246,17 +240,15 @@ paths: isOffPayrollWorker: false address: addressLine1: 171 Midsummer - addressLine2: null city: Milton Keyness county: null - countryName: null + countryName: UNITED KINGDOM postCode: MK9 1EB payrollCalendarID: null - updatedDateUTC: 2020-03-25T03:12:10 - createdDateUTC: 2020-03-25T03:12:10 + updatedDateUTC: '2020-03-25T03:12:10Z' + createdDateUTC: '2020-03-25T03:12:10Z' niCategory: null employeeNumber: null - endDate: null "400": description: validation error for a bad request content: @@ -273,7 +265,7 @@ paths: title: Mr firstName: Mike lastName: Fancy - dateOfBirth: 1999-01-01T00:00:00 + dateOfBirth: 1999-01-01T00:00:00Z gender: M email: mike@starkindustries.com isOffPayrollWorker: false @@ -311,52 +303,42 @@ paths: application/json: schema: $ref: '#/components/schemas/EmployeeObject' - example: '{ - "id": "9414291b-a8c6-08fa-b165-9b30b1e6aab5", - "providerName": "!YLT5Y", - "dateTimeUTC": "2018-04-09T05:15:18.1011141", - "httpStatusCode": "OK", - "pagination": null, - "problem": null, - "employee": { - "employeeID": "d17e008e-3381-45c0-b50c-2fab7757e503", - "title": "Mr.", - "firstName": "Edgar", - "lastName": "Allan Po", - "dateOfBirth": "1985-03-24T00:00:00", - "gender": "M", - "email": "tester1@gmail.com", - "phoneNumber": "0400123456", - "nationalInsuranceNumber": null, - "isOffPayrollWorker": false, - "address": { - "addressLine1": "171 Midsummer", - "addressLine2": null, - "city": "Milton Keyness", - "county": null, - "countryName": null, - "postCode": "MK9 1EB" - }, - "payrollCalendarID": null, - "updatedDateUTC": "2017-05-12T10:00:24", - "createdDateUTC": "2017-05-12T10:00:24", - "niCategories": [ - { - "startDate": "2020-05-01T00:00:00", - "niCategory": "A" - }, - { - "startDate": null, - "niCategory": "F", - "niCategoryID": 1, - "dateFirstEmployedAsCivilian": null, - "workplacePostcode": "SW1A 1AA" - } - ], - "employeeNumber": "2", - "endDate": null - } - }' + example: + id: 9414291b-a8c6-08fa-b165-9b30b1e6aab5 + providerName: "!YLT5Y" + dateTimeUTC: '2018-04-09T05:15:18.1011141' + httpStatusCode: OK + pagination: null + employee: + employeeID: d17e008e-3381-45c0-b50c-2fab7757e503 + title: Mr. + firstName: Edgar + lastName: Allan Po + dateOfBirth: '1985-03-24' + gender: M + email: tester1@gmail.com + phoneNumber: '0400123456' + nationalInsuranceNumber: 'AB123456C' + isOffPayrollWorker: false + address: + addressLine1: 171 Midsummer + city: Milton Keyness + county: null + countryName: UNITED KINGDOM + postCode: MK9 1EB + payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe + updatedDateUTC: '2017-05-12T10:00:24Z' + createdDateUTC: '2017-05-12T10:00:24Z' + niCategories: + - startDate: '2020-05-01' + niCategory: I + workplacePostcode: SW1A 1AA + - startDate: '2020-05-02' + niCategory: F + niCategoryID: 1 + dateFirstEmployedAsCivilian: '2020-05-01' + workplacePostcode: SW1A 1AA + employeeNumber: '2' put: security: - OAuth2: @@ -478,7 +460,7 @@ paths: title: Mr firstName: Mike lastName: Johnllsbkrhwopson - dateOfBirth: 1999-01-01T00:00:00 + dateOfBirth: 1999-01-01 gender: M email: 84044@starkindustries.com phoneNumber: "0400123456" @@ -487,7 +469,6 @@ paths: isOffPayrollWorker: false address: addressLine1: 101 Green St - addressLine2: null city: San Francisco county: null countryName: null @@ -495,7 +476,6 @@ paths: payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe updatedDateUTC: "2020-03-25T17:03:50Z" createdDateUTC: "2020-02-10T10:00:24Z" - endDate: null "400": description: validation error for a bad request content: @@ -512,7 +492,7 @@ paths: title: Mr. firstName: TestDataUK lastName: Tester - dateOfBirth: 1992-11-22T00:00:00 + dateOfBirth: 1992-11-22T00:00:00Z gender: M email: tester@gmail.com phoneNumber: "0400123456" @@ -596,28 +576,23 @@ paths: application/json: schema: $ref: '#/components/schemas/EmploymentObject' - example: '{ - "id": "0160a355-1e6d-4fdc-9532-c0857feaa515", - "providerName": "provider-name", - "dateTimeUTC": "2020-03-26T18:09:11.6235442", - "httpStatusCode": "OK", - "pagination": null, - "problem": null, - "employment": { - "payrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe", - "startDate": "2020-04-01T00:00:00", - "niCategories": [ - { - "niCategory": "A", - "startDate": "2020-05-01", - "niCategoryID": 594, - "dateFirstEmployedAsCivilian": null, - "workplacePostcode": null - } - ], - "employeeNumber": "123ABC" - } - }' + example: + id: 0160a355-1e6d-4fdc-9532-c0857feaa515 + providerName: provider-name + dateTimeUTC: '2020-03-26T18:09:11.6235442' + httpStatusCode: OK + pagination: + problem: + employment: + payrollCalendarID: 216d80e6-af55-47b1-b718-9457c3f5d2fe + startDate: '2020-04-01T00:00:00' + niCategories: + - niCategory: I + startDate: '2020-05-01' + niCategoryID: 594 + dateFirstEmployedAsCivilian: '2020-05-01' + workplacePostcode: SW1A 1AA + employeeNumber: 123ABC '400': description: validation error for a bad request content: @@ -630,17 +605,14 @@ paths: application/json: schema: $ref: '#/components/schemas/Employment' - example: '{ - "PayrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe", - "StartDate": "2020-04-01", - "NICategories": [ - { - "NICategory": "A", - "StartDate": "2020-05-01" - } - ], - "EmployeeNumber": "123ABC" - }' + example: + payrollCalendarID: cdfb8371-0b21-4b8a-8903-1024df6c391e + startDate: '2024-04-01' + niCategories: + - niCategory: I + startDate: '2020-05-01' + workplacePostcode: SW1A 1AA + employeeNumber: 123ABC /Employees/{EmployeeID}/Tax: parameters: - $ref: '#/components/parameters/requiredHeader' @@ -5797,10 +5769,10 @@ components: Employment: type: object required: - - PayrollCalendarID - - StartDate - - EmployeeNumber - - NICategories + - payrollCalendarID + - startDate + - employeeNumber + - niCategories properties: payrollCalendarID: description: Xero unique identifier for the payroll calendar of the employee