Skip to content

Ni category updates #707

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sangeet-joy-tw merged 11 commits into from
Apr 9, 2025
Merged

Ni category updates #707

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0a7781c
Added entities
daniel-hutchinson-xero-public Mar 20, 2025
cbd44d7
Added missing comma to employee post
daniel-hutchinson-xero-public Mar 20, 2025
9b3129a
Added NI category and NI Categories to Employee entity. Marked NI Cat…
daniel-hutchinson-xero-public Mar 20, 2025
cb63044
Updated GET Employee example
daniel-hutchinson-xero-public Mar 20, 2025
7be7069
Added NI Categories to Employment entity and marked NI Category as de…
daniel-hutchinson-xero-public Mar 20, 2025
1a8384c
Added validation for workplace postcode and date first employed as a …
daniel-hutchinson-xero-public Mar 20, 2025
fdb81b1
Alphabetised NI Category Letters and added missing freeport/investmen…
daniel-hutchinson-xero-public Mar 20, 2025
8710224
Added NI Categories to employment POST. Redundant NI Category.
daniel-hutchinson-xero-public Mar 20, 2025
261a68e
Removed redundant NI Category from GET Employee by ID. Added extra N…
daniel-hutchinson-xero-public Mar 20, 2025
243d300
Added missing start date to example for Employment POST
daniel-hutchinson-xero-public Mar 20, 2025
8241365
Updated example NI category to use the correct NI category letter bas…
daniel-hutchinson-xero-public Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 126 additions & 23 deletions xero-payroll-uk.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ paths:
"county":null,
"countryName":null,
"postCode": "MK9 1EB"
}
},
"payrollCalendarID":null,
"updatedDateUTC":"2020-03-25T03:12:10",
"createdDateUTC":"2020-03-25T03:12:10",
Expand Down Expand Up @@ -352,6 +352,20 @@ paths:
"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
}
}'
Expand Down Expand Up @@ -570,7 +584,14 @@ paths:
python: start_date
ruby: start_date
object: employment
is_last: true
is_last: true
- niCategories:
key: niCategories
keyPascal: NICategories
keySnake: ni_categories
is_object: true
object: employment
default: A
summary: Creates employment detail for a specific employee using a unique employee ID
parameters:
- $ref: '#/components/parameters/idempotencyKey'
Expand Down Expand Up @@ -600,7 +621,15 @@ paths:
"employment": {
"payrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe",
"startDate": "2020-04-01T00:00:00",
"niCategory": "A",
"niCategories": [
{
"niCategory": "A",
"startDate": "2020-05-01",
"niCategoryID": 594,
"dateFirstEmployedAsCivilian": null,
"workplacePostcode": null
}
],
"employeeNumber": "123ABC"
}
}'
Expand All @@ -619,8 +648,13 @@ paths:
example: '{
"PayrollCalendarID": "216d80e6-af55-47b1-b718-9457c3f5d2fe",
"StartDate": "2020-04-01",
"EmployeeNumber": "123ABC",
"NICategory": "A"
"NICategories": [
{
"NICategory": "A",
"StartDate": "2020-05-01"
}
],
"EmployeeNumber": "123ABC"
}'
/Employees/{EmployeeID}/Tax:
parameters:
Expand Down Expand Up @@ -5997,6 +6031,14 @@ components:
type: string
format: date-time
x-is-datetime: true
niCategory:
$ref: '#/components/schemas/NICategoryLetter'
deprecated: true
niCategories:
description: The employee's NI categories
type: array
items:
$ref: '#/components/schemas/NICategory'
nationalInsuranceNumber:
description: National insurance number of the employee
type: string
Expand All @@ -6019,7 +6061,7 @@ components:
- PayrollCalendarID
- StartDate
- EmployeeNumber
- NICategory
- NICategories
properties:
payrollCalendarID:
description: Xero unique identifier for the payroll calendar of the employee
Expand All @@ -6035,23 +6077,14 @@ components:
type: string
example: 007
niCategory:
description: The NI Category of the employee
type: string
enum:
- A
- B
- C
- F
- H
- I
- J
- L
- M
- S
- V
- X
- Z
example: A
$ref: '#/components/schemas/NICategoryLetter'
deprecated: true
niCategories:
description: The employee's NI categories
type: array
items:
$ref: '#/components/schemas/NICategory'

EmployeeTaxObject:
type: object
properties:
Expand Down Expand Up @@ -7864,3 +7897,73 @@ components:
description: The Xero identifier for Timesheet tracking category.
type: string
format: uuid
NICategoryLetter:
description: The employee's NI Category letter.
type: string
example: I
enum:
- A
- B
- C
- D
- E
- F
- H
- I
- J
- K
- L
- M
- N
- S
- V
- X
- Z
NICategory:
type: object
required:
- niCategory
- workplacePostcode
properties:
startDate:
description: The start date of the NI category (YYYY-MM-DD)
type: string
format: date
example: 2024-12-02
x-is-date: true
niCategory:
$ref: '#/components/schemas/NICategoryLetter'
niCategoryID:
description: Xero unique identifier for the NI category
type: number
example: 15
dateFirstEmployedAsCivilian:
description: The date in which the employee was first employed as a civilian (YYYY-MM-DD)
type: string
format: date
example: 2024-12-02
x-is-date: true
workplacePostcode:
description: The workplace postcode
type: string
example: SW1A 1AA
oneOf:
- required:
- workplacePostcode
properties:
niCategory:
enum:
- F
- I
- L
- S
- N
- E
- D
- K
- required:
- dateFirstEmployedAsCivilian
properties:
niCategory:
enum:
- V