Skip to content

feat: Remove GPR Employee endpoint from spec #790

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

Open
alexle-x wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Remove GPR Employee endpoint from spec #790

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
266 changes: 0 additions & 266 deletions xero_accounting.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6535,272 +6535,6 @@ paths:
example:
Code: USD
Description: United States Dollar
/Employees:
parameters:
- $ref: "#/components/parameters/requiredHeader"
get:
deprecated: true
security:
- OAuth2:
- accounting.settings
- accounting.settings.read
tags:
- Accounting
operationId: getEmployees
summary: Retrieves employees used in Xero payrun
description: This endpoint is deprecated and will be removed April 28, 2026
parameters:
- $ref: "#/components/parameters/ifModifiedSince"
- in: query
name: where
description: Filter by an any element
example: Status=="ACTIVE"
x-example-csharp: Status==\"ACTIVE\"
x-example-java: Status=="' + Employee.StatusEnum.ACTIVE + '"
x-example-php: Status=="' . \XeroAPI\XeroPHP\Models\Accounting\Employee::STATUS_ACTIVE . '"
x-example-ruby: Status==#{XeroRuby::Accounting::Employee::ACTIVE}
schema:
type: string
- in: query
name: order
description: Order by an any element
example: LastName ASC
schema:
type: string
responses:
"200":
description: Success - return response of type Employees array with all Employee
content:
application/json:
schema:
$ref: "#/components/schemas/Employees"
example:
Id: 593cbccc-5cd2-4cd2-be5e-150f0843709e
Status: OK
ProviderName: Provider Name Example
DateTimeUTC: /Date(1552325082775)/
Employees:
- EmployeeID: 972615c5-ad3d-47a0-b579-20370d374578
Status: ACTIVE
FirstName: Tony
LastName: Stark
ExternalLink:
Url: http://twitter.com/#!/search/Stark+Industries
Description: Go to external link
UpdatedDateUTC: /Date(1552324681593+0000)/
- EmployeeID: ad3db144-6362-459c-8c36-5d31d196e629
Status: ACTIVE
FirstName: Bruce
LastName: Banner
ExternalLink:
Url: http://twitter.com/#!/search/Nick+Fury
Description: Go to external link
UpdatedDateUTC: /Date(1552325081303+0000)/
- EmployeeID: e1ada26b-a10e-4065-a941-af34b53740e3
Status: ACTIVE
FirstName: Nick
LastName: Fury
ExternalLink:
Url: http://twitter.com/#!/search/Nick+Fury
Description: Go to external link
UpdatedDateUTC: /Date(1552324737990+0000)/
put:
deprecated: true
security:
- OAuth2:
- accounting.settings
tags:
- Accounting
operationId: createEmployees
summary: Creates new employees used in Xero payrun
description: This endpoint is deprecated and will be removed April 28, 2026
x-hasAccountingValidationError: true
x-example:
- employee:
is_object: true
key: employee
keyPascal: Employee
- firstName:
key: firstName
keyPascal: FirstName
keySnake: first_name
default: Nick
object: employee
- lastName:
is_last: true
key: lastName
keyPascal: LastName
keySnake: last_name
default: Fury
object: employee
- employees:
is_object: true
key: employees
keyPascal: Employees
- add_employee:
is_last: true
is_array_add: true
key: employees
keyPascal: Employees
java: Employees
csharp: Employee
object: employee
parameters:
- $ref: "#/components/parameters/summarizeErrors"
- $ref: "#/components/parameters/idempotencyKey"
responses:
"200":
description: Success - return response of type Employees array with new Employee
content:
application/json:
schema:
$ref: "#/components/schemas/Employees"
example:
Id: 0d6a08e7-6936-4828-a1bc-e4595e0ef778
Status: OK
ProviderName: Provider Name Example
DateTimeUTC: /Date(1552324736508)/
Employees:
- EmployeeID: e1ada26b-a10e-4065-a941-af34b53740e3
Status: ACTIVE
FirstName: Nick
LastName: Fury
ExternalLink:
Url: http://twitter.com/#!/search/Nick+Fury
Description: Go to external link
UpdatedDateUTC: /Date(1552324736463+0000)/
"400":
$ref: "#/components/responses/400Error"
requestBody:
required: true
description: Employees with array of Employee object in body of request
content:
application/json:
schema:
$ref: "#/components/schemas/Employees"
example:
Employees:
- FirstName: Nick
LastName: Fury
ExternalLink:
Url: http://twitter.com/#!/search/Nick+Fury
post:
deprecated: true
security:
- OAuth2:
- accounting.settings
tags:
- Accounting
operationId: updateOrCreateEmployees
summary: Creates a single new employees used in Xero payrun
description: This endpoint is deprecated and will be removed April 28, 2026
x-hasAccountingValidationError: true
x-example:
- employee:
is_object: true
key: employee
keyPascal: Employee
- firstName:
key: firstName
keyPascal: FirstName
keySnake: first_name
default: Nick
object: employee
- lastName:
is_last: true
key: lastName
keyPascal: LastName
keySnake: last_name
default: Fury
object: employee
- employees:
is_object: true
key: employees
keyPascal: Employees
- add_employee:
is_last: true
is_array_add: true
key: employees
keyPascal: Employees
java: Employees
csharp: Employee
object: employee
parameters:
- $ref: "#/components/parameters/summarizeErrors"
- $ref: "#/components/parameters/idempotencyKey"
responses:
"200":
description: Success - return response of type Employees array with new Employee
content:
application/json:
schema:
$ref: "#/components/schemas/Employees"
example:
Id: 0d6a08e7-6936-4828-a1bc-e4595e0ef778
Status: OK
ProviderName: Provider Name Example
DateTimeUTC: /Date(1552324736508)/
Employees:
- EmployeeID: e1ada26b-a10e-4065-a941-af34b53740e3
Status: ACTIVE
FirstName: Nick
LastName: Fury
ExternalLink:
Url: http://twitter.com/#!/search/Nick+Fury
Description: Go to external link
UpdatedDateUTC: /Date(1552324736463+0000)/
"400":
$ref: "#/components/responses/400Error"
requestBody:
required: true
description: Employees with array of Employee object in body of request
content:
application/json:
schema:
$ref: "#/components/schemas/Employees"
example:
Employees:
- FirstName: Nick
LastName: Fury
ExternalLink:
Url: http://twitter.com/#!/search/Nick+Fury
/Employees/{EmployeeID}:
parameters:
- $ref: "#/components/parameters/requiredHeader"
get:
deprecated: true
security:
- OAuth2:
- accounting.settings
- accounting.settings.read
tags:
- Accounting
operationId: getEmployee
summary: Retrieves a specific employee used in Xero payrun using a unique employee Id
description: This endpoint is deprecated and will be removed April 28, 2026
parameters:
- $ref: "#/components/parameters/EmployeeID"
responses:
"200":
description: Success - return response of type Employees array with specified Employee
content:
application/json:
schema:
$ref: "#/components/schemas/Employees"
example:
Id: 417a529e-4f8d-4b1a-8816-7100245cf8b2
Status: OK
ProviderName: Provider Name Example
DateTimeUTC: /Date(1552325084085)/
Employees:
- EmployeeID: 972615c5-ad3d-47a0-b579-20370d374578
Status: ACTIVE
FirstName: Tony
LastName: Stark
ExternalLink:
Url: http://twitter.com/#!/search/Stark+Industries
Description: Go to external link
UpdatedDateUTC: /Date(1552324681593+0000)/
/ExpenseClaims:
parameters:
- $ref: "#/components/parameters/requiredHeader"
Expand Down
Loading