Xero OpenAPI

https://github.com/xeroapi/xero-openapi
Admin
An OpenAPI (Swagger) specification for the Xero API, including OAuth 2.0 security, for generating...
Tokens:129,619
Snippets:796
Trust Score:7.7
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### GET,PUT /Accounts

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/endpoints.md

Retrieve a list of accounts or create a new account. The GET method returns all accounts, while PUT creates a new account.

```APIDOC
## GET /Accounts

### Description
Retrieves a list of accounts.

### Method
GET

### Endpoint
/Accounts

### Response
#### Success Response (200)
- **accounts** (array) - List of account objects.

## PUT /Accounts

### Description
Creates a new account.

### Method
PUT

### Endpoint
/Accounts

### Request Body
- **account** (object) - The account details to create.

### Response
#### Success Response (200)
- **account** (object) - The created account object.
```

--------------------------------

### GET /Settings

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/endpoints.md

Retrieves payroll settings.

```APIDOC
## GET /Settings

### Description
Retrieves payroll settings.

### Method
GET

### Endpoint
/Settings

### Response
#### Success Response (200)
- **settings** (object) - Payroll settings.
```

--------------------------------

### GET /Settings

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Retrieves payroll settings.

```APIDOC
## GET /Settings

### Description
Retrieves payroll settings.

### Method
GET

### Endpoint
/Settings

### Response
#### Success Response (200)
- **Settings** - The payroll settings object.

```

--------------------------------

### GET /Settings

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Retrieves payroll settings.

```APIDOC
## GET /Settings

### Description
Retrieves payroll settings.

### Method
GET

### Endpoint
/Settings

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
#### Success Response (200)
- **SettingsObject** - The response body contains a SettingsObject.

```

--------------------------------

### GET /Connections

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/identity.md

Retrieves the list of connections (tenants) for the authenticated user. This endpoint is used to get all connections associated with the user's authorization.

```APIDOC
## GET /Connections

### Description
Retrieves the connections for a user. This endpoint returns a list of connections (tenants) that the authenticated user has authorized the application to access.

### Method
GET

### Endpoint
/Connections

### Parameters
#### Query Parameters
- **authEventId** (string) - Optional - Identifier shared across connections authorised at the same time.

### Response
#### Success Response (200)
Returns an array of Connection objects.

#### Response Example
```json
[
  {
    "id": "uuid",
    "tenantId": "uuid",
    "authEventId": "uuid",
    "tenantType": "string",
    "tenantName": "string",
    "createdDateUtc": "date-time",
    "updatedDateUtc": "date-time"
  }
]
```
```

--------------------------------

### GET /Settings

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Retrieves payroll settings for the organisation.

```APIDOC
## [GET] /Settings

### Description
Retrieves payroll settings for the organisation.

### Method
GET

### Endpoint
`https://api.xero.com/payroll.xro/2.0/Settings`

### Response
#### Success Response (200)
- **settings** (object) - The payroll settings object.

#### Response Example
```json
{
  "settings": {
    "accounts": [],
    "trackingCategories": []
  }
}
```
```

--------------------------------

### GET /Budgets

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/endpoints.md

Retrieves a list of budgets.

```APIDOC
## GET /Budgets

### Description
Retrieves a list of budgets.

### Method
GET

### Endpoint
/Budgets

### Response
#### Success Response (200)
- **budgets** (array) - List of budget objects.
```

--------------------------------

### Conventional Commits: breaking change commit example

Source: https://github.com/xeroapi/xero-openapi/blob/master/README.md

Conventional Commits example for a breaking change commit that triggers a major version bump, using the '!' header marker and a BREAKING CHANGE footer.

```text
feat(payroll-nz)!: remove deprecated EarningsRateID field from Payslip response

BREAKING CHANGE: clients must use EarningsRateIdentifier instead of EarningsRateID.
```

--------------------------------

### GET /BrandingThemes

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/endpoints.md

Retrieves a list of branding themes.

```APIDOC
## GET /BrandingThemes

### Description
Retrieves a list of branding themes.

### Method
GET

### Endpoint
/BrandingThemes

### Response
#### Success Response (200)
- **brandingThemes** (array) - List of branding theme objects.
```

--------------------------------

### GET /Accounts

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-bank-and-payments.md

Retrieves a list of accounts.

```APIDOC
## GET /Accounts

### Description
Retrieves a list of accounts.

### Method
GET

### Endpoint
/Accounts

### Parameters
#### Query Parameters
- **where** (string) - Optional - Filter results by a where clause.
- **order** (string) - Optional - Order results by a field.
- **page** (integer) - Optional - Page number.

### Response
#### Success Response (200)
- **Accounts** (array) - List of accounts.

#### Response Example
{
  "Accounts": [
    {
      "AccountID": "00000000-0000-0000-0000-000000000000",
      "Code": "200",
      "Name": "Sales",
      "Type": "REVENUE"
    }
  ]
}
```

--------------------------------

### GET /LeaveApplications

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Retrieves a list of leave applications.

```APIDOC
## GET /LeaveApplications

### Description
Retrieves a list of leave applications.

### Method
GET

### Endpoint
/LeaveApplications

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
#### Success Response (200)
- **LeaveApplications** - The response body contains a LeaveApplications object.

#### Error Statuses
- 400

```

--------------------------------

### GET /Reports/TrialBalance

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves the Trial Balance report.

```APIDOC
## GET /Reports/TrialBalance

### Description
Retrieves the Trial Balance report.

### Method
GET

### Endpoint
/Reports/TrialBalance

### Parameters
#### Query Parameters
- **date** (string) - Optional - Report date.
- **paymentsOnly** (boolean) - Optional - Show payments only.

### Response
#### Success Response (200)
- **ReportWithRows** (object) - The report data with rows.

#### Response Example
```json
{
  "ReportID": "00000000-0000-0000-0000-000000000000",
  "ReportName": "TrialBalance",
  "ReportTitles": [],
  "Rows": []
}
```
```

--------------------------------

### GET /LeaveApplications/v2

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Retrieves a list of leave applications (v2).

```APIDOC
## GET /LeaveApplications/v2

### Description
Retrieves a list of leave applications (v2).

### Method
GET

### Endpoint
/LeaveApplications/v2

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
#### Success Response (200)
- **LeaveApplications** - The response body contains a LeaveApplications object.

#### Error Statuses
- 400

```

--------------------------------

### GET /FinancialStatements/TrialBalance

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/finance.md

Retrieves the trial balance financial statement.

```APIDOC
## GET /FinancialStatements/TrialBalance

### Description
Retrieves the trial balance financial statement.

### Method
GET

### Endpoint
/FinancialStatements/TrialBalance

### Parameters
#### Header Parameters
- **xero-tenant-id** (string) - Required - Xero identifier for Tenant

### Response
#### Success Response (200)
- **TrialBalanceResponse** - The response body is a TrialBalanceResponse object.

#### Error Statuses
- 400

```

--------------------------------

### POST /Setup

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Performs initial setup for the organisation. Requires the accounting.settings scope.

```APIDOC
## POST /Setup

### Description
Performs initial setup for the organisation.

### Method
POST

### Endpoint
/Setup

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **Setup** (object) - Required - Setup information.

### Request Example
{
  "Setup": {}
}

### Response
#### Success Response (200)
- **ImportSummaryObject** (object) - Summary of the import.

#### Response Example
{
  "ImportSummaryObject": {}
}
```

--------------------------------

### Conventional Commits: fix commit example

Source: https://github.com/xeroapi/xero-openapi/blob/master/README.md

Conventional Commits example for a bug fix commit that triggers a patch version bump.

```text
fix(files): correct nullable schema for File.ContentLength
```

--------------------------------

### POST /Projects

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/projects.md

Creates a new project in Xero.

```APIDOC
## POST /Projects

### Description
Creates a new project. This endpoint requires the `projects` OAuth scope.

### Method
POST

### Endpoint
`https://api.xero.com/projects.xro/2.0/Projects`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **ProjectCreateOrUpdate** (object) - Required - The project data to create.

### Request Example
None

### Response
#### Success Response (200)
- **Project** (object) - The created project.

#### Response Example
None

### Error Handling
- **400** - A failed request due to validation error.
```

--------------------------------

### Conventional Commits: feat commit example

Source: https://github.com/xeroapi/xero-openapi/blob/master/README.md

Conventional Commits example for a feature commit that triggers a minor version bump in semantic-release.

```text
feat(accounting): add includeArchived query parameter to GET /Accounts
```

--------------------------------

### POST /Employees/{EmployeeID}/LeaveSetup

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Creates leave setup for an employee. Requires the payroll.employees scope.

```APIDOC
## POST /Employees/{EmployeeID}/LeaveSetup

### Description
Creates leave setup for an employee.

### Method
POST

### Endpoint
/Employees/{EmployeeID}/LeaveSetup

### Parameters
#### Path Parameters
- **EmployeeID** (string) - Required - The unique identifier of the employee

#### Headers
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant

#### Request Body
- **EmployeeLeaveSetup** (object) - Required - Leave setup details

### Request Example
```json
{
  "employeeLeaveSetup": {}
}
```

### Response
#### Success Response (200)
- **EmployeeLeaveSetupObject** - The created leave setup

#### Response Example
```json
{
  "employeeLeaveSetup": {}
}
```
```

--------------------------------

### GET /Settings

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/assets.md

Retrieves the asset settings. Requires the 'assets' or 'assets.read' scope.

```APIDOC
## GET /Settings

### Description
Retrieves the asset settings.

### Method
GET

### Endpoint
/Settings

### Response
#### Success Response (200)
- **Setting** (Setting) - The asset settings.

#### Error Statuses
- 400 - Bad Request
```

--------------------------------

### Run Swagger UI with npx

Source: https://github.com/xeroapi/xero-openapi/blob/master/README.md

Run Swagger UI locally via an NPM package. It opens a webpage in your default browser.

```bash
npx -y open-swagger-ui --open ./xero_accounting.yaml
```

--------------------------------

### GET,POST,DELETE /Accounts/{AccountID}

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/endpoints.md

Retrieve, update, or delete a specific account by its ID. GET returns the account, POST updates it, and DELETE removes it.

```APIDOC
## GET /Accounts/{AccountID}

### Description
Retrieves a specific account by its ID.

### Method
GET

### Endpoint
/Accounts/{AccountID}

### Parameters
#### Path Parameters
- **AccountID** (string) - Required - The unique identifier of the account.

### Response
#### Success Response (200)
- **account** (object) - The account object.

## POST /Accounts/{AccountID}

### Description
Updates a specific account by its ID.

### Method
POST

### Endpoint
/Accounts/{AccountID}

### Parameters
#### Path Parameters
- **AccountID** (string) - Required - The unique identifier of the account.

### Request Body
- **account** (object) - The updated account details.

### Response
#### Success Response (200)
- **account** (object) - The updated account object.

## DELETE /Accounts/{AccountID}

### Description
Deletes a specific account by its ID.

### Method
DELETE

### Endpoint
/Accounts/{AccountID}

### Parameters
#### Path Parameters
- **AccountID** (string) - Required - The unique identifier of the account.

### Response
#### Success Response (200)
- **status** (string) - Deletion status.
```

--------------------------------

### POST /Employees/{EmployeeID}/LeaveSetup

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/endpoints.md

Creates leave setup for a specific employee.

```APIDOC
## POST /Employees/{EmployeeID}/LeaveSetup

### Description
Creates leave setup for a specific employee.

### Method
POST

### Endpoint
/Employees/{EmployeeID}/LeaveSetup

### Parameters
#### Path Parameters
- **EmployeeID** (string) - Required - The unique identifier of the employee.

### Request Body
- **leaveSetup** (object) - Leave setup details.

### Response
#### Success Response (200)
- **leaveSetup** (object) - The created leave setup.
```

--------------------------------

### POST /Employees/{EmployeeID}/ukopeningbalances

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-uk.md

Creates opening balances for a specific employee. Requires the Xero-Tenant-Id header and the payroll.employees scope.

```APIDOC
## POST /Employees/{EmployeeID}/ukopeningbalances

### Description
Creates opening balances for a specific employee.

### Method
POST

### Endpoint
/Employees/{EmployeeID}/ukopeningbalances

### Parameters
#### Path Parameters
- **EmployeeID** (string) - Required - The unique identifier of the employee

#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

#### Request Body
- **EmployeeOpeningBalances** - Required - Employee opening balances object

### Auth Scopes
payroll.employees

### Response
#### Success Response (200)
- **EmployeeOpeningBalancesObject** - Created employee opening balances object

### Error Statuses
- 400
```

--------------------------------

### POST /Folders

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/files.md

Creates a new folder. Requires the files scope.

```APIDOC
## POST /Folders

### Description
Creates a new folder.

### Method
POST

### Endpoint
/Folders

### Parameters
#### Request Body
- **Folder** (object) - Required - The folder to create

### Response
#### Success Response (200)
- **Folder** (object) - The created folder

#### Response Example
{
  "Folder": {}
}

### Error Statuses
- 400 - Bad Request
```

--------------------------------

### GET /Timesheets

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Retrieves a list of timesheets.

```APIDOC
## GET /Timesheets

### Description
Retrieves a list of timesheets.

### Method
GET

### Endpoint
/Timesheets

### Response
#### Success Response (200)
- **Timesheets** - A collection of timesheet objects.

```

--------------------------------

### GET /Projects

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/projects.md

Retrieves a list of projects from the Xero Projects API.

```APIDOC
## GET /Projects

### Description
Retrieves a list of projects. This endpoint requires the `projects` or `projects.read` OAuth scope.

### Method
GET

### Endpoint
`https://api.xero.com/projects.xro/2.0/Projects`

### Parameters
#### Path Parameters
None

#### Query Parameters
- **projectIds** (array<string>) - Optional - Filter by project IDs.
- **contactID** (string) - Optional - Filter by contact ID.
- **states** (string) - Optional - Filter by project states.
- **page** (integer) - Optional - Page number for pagination.
- **pageSize** (integer) - Optional - Number of records per page.

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Projects** (object) - A list of projects.

#### Response Example
None

### Error Handling
- **400** - A failed request due to validation error.
```

--------------------------------

### GET /Reimbursements

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Retrieves a list of reimbursements.

```APIDOC
## GET /Reimbursements

### Description
Retrieves a list of reimbursements.

### Method
GET

### Endpoint
/Reimbursements

### Response
#### Success Response (200)
- **Reimbursements** - A collection of reimbursement objects.

```

--------------------------------

### GET /Organisation

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves the organisation details.

```APIDOC
## GET /Organisation

### Description
Retrieves the organisation details.

### Method
GET

### Endpoint
/Organisation

### Response
#### Success Response (200)
- **Organisations** (array) - List of organisation details.

#### Response Example
```json
{
  "Organisations": [
    {
      "OrganisationID": "00000000-0000-0000-0000-000000000000",
      "Name": "Example Organisation",
      "LegalName": "Example Legal Name",
      "PaysTax": true,
      "Version": "AU"
    }
  ]
}
```
```

--------------------------------

### GET /Benefits

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-uk.md

Retrieves a list of benefits. Requires the Xero-Tenant-Id header and appropriate payroll scopes.

```APIDOC
## GET /Benefits

### Description
Retrieves a list of benefits.

### Method
GET

### Endpoint
/Benefits

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Auth Scopes
payroll.settings,payroll.settings.read

### Response
#### Success Response (200)
- **Benefits** - List of benefits
```

--------------------------------

### GET /Reports

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves a list of reports.

```APIDOC
## GET /Reports

### Description
Retrieves a list of reports.

### Method
GET

### Endpoint
/Reports

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number.

### Response
#### Success Response (200)
- **ReportWithRows** (object) - The report data with rows.

#### Response Example
```json
{
  "ReportID": "00000000-0000-0000-0000-000000000000",
  "ReportName": "Report",
  "ReportTitles": [],
  "Rows": []
}
```
```

--------------------------------

### GET /Timesheets

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Retrieves a list of timesheets.

```APIDOC
## GET /Timesheets

### Description
Retrieves a list of timesheets.

### Method
GET

### Endpoint
/Timesheets

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
#### Success Response (200)
- **Timesheets** - The response body contains a Timesheets object.

#### Error Statuses
- 400

```

--------------------------------

### GET /Superfunds

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Retrieves a list of superfunds.

```APIDOC
## GET /Superfunds

### Description
Retrieves a list of superfunds.

### Method
GET

### Endpoint
/Superfunds

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
#### Success Response (200)
- **SuperFunds** - The response body contains a SuperFunds object.

#### Error Statuses
- 400

```

--------------------------------

### View local file with Docker

Source: https://github.com/xeroapi/xero-openapi/blob/master/README.md

View a local OpenAPI file via Docker. Mounts the current directory and serves the UI on port 8080.

```bash
docker run -p 8080:8080 -e SWAGGER_JSON=/local/xero_accounting.yaml -v $PWD:/local docker.swagger.io/swaggerapi/swagger-ui
```

--------------------------------

### POST /Benefits

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-uk.md

Creates a new benefit. Requires the Xero-Tenant-Id header and the payroll.settings scope.

```APIDOC
## POST /Benefits

### Description
Creates a new benefit.

### Method
POST

### Endpoint
/Benefits

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

#### Request Body
- **Benefit** - Required - Benefit object

### Auth Scopes
payroll.settings

### Response
#### Success Response (200)
- **BenefitObject** - Created benefit object

### Error Statuses
- 400
```

--------------------------------

### GET /Employees

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Retrieves a list of employees.

```APIDOC
## GET /Employees

### Description
Retrieves a list of employees.

### Method
GET

### Endpoint
/Employees

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
#### Success Response (200)
- **Employees** - The response body contains an Employees object.

#### Error Statuses
- 400

```

--------------------------------

### GET /Settings

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-uk.md

Retrieves payroll settings. Requires payroll.settings or payroll.settings.read scope.

```APIDOC
## GET /Settings

### Description
Retrieves payroll settings.

### Method
GET

### Endpoint
/Settings

### Response
#### Success Response (200)
- **Settings** - The payroll settings.

#### Response Example
{
  "Settings": {
    "accountCodes": {},
    "taxRates": []
  }
}
```

--------------------------------

### POST /FeedConnections

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/bankfeeds.md

Creates one or more feed connections. Requires the bankfeeds scope and the Xero-Tenant-Id header.

```APIDOC
## POST /FeedConnections

### Description
Creates one or more feed connections.

### Method
POST

### Endpoint
/FeedConnections

### Parameters
#### Request Body
- **FeedConnections** (object) - Required - The feed connections to create.

#### Headers
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant.

### Response
#### Success Response (200)
- **FeedConnections** (object) - The created feed connections.

#### Response Example
{
  "feedConnections": []
}
```

--------------------------------

### GET /PaySlips

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/endpoints.md

Retrieves a list of pay slips.

```APIDOC
## GET /PaySlips

### Description
Retrieves a list of pay slips.

### Method
GET

### Endpoint
/PaySlips

### Response
#### Success Response (200)
- **paySlips** (array) - List of pay slip objects.
```

--------------------------------

### POST /Employees/{EmployeeID}/OpeningBalances

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Creates opening balances for an employee. Requires the payroll.employees scope.

```APIDOC
## POST /Employees/{EmployeeID}/OpeningBalances

### Description
Creates opening balances for an employee.

### Method
POST

### Endpoint
/Employees/{EmployeeID}/OpeningBalances

### Parameters
#### Path Parameters
- **EmployeeID** (string) - Required - The unique identifier of the employee

#### Headers
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant

#### Request Body
- **EmployeeOpeningBalances** (object) - Required - Opening balances details

### Request Example
```json
{
  "employeeOpeningBalances": {}
}
```

### Response
#### Success Response (200)
- **EmployeeOpeningBalancesObject** - The created opening balances

#### Response Example
```json
{
  "employeeOpeningBalances": {}
}
```
```

--------------------------------

### GET /PaySlips

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Retrieves a list of pay slips.

```APIDOC
## GET /PaySlips

### Description
Retrieves a list of pay slips.

### Method
GET

### Endpoint
/PaySlips

### Response
#### Success Response (200)
- **PaySlips** - A collection of pay slip objects.

```

--------------------------------

### GET /StatutoryDeductions

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/endpoints.md

Retrieves a list of statutory deductions.

```APIDOC
## GET /StatutoryDeductions

### Description
Retrieves a list of statutory deductions.

### Method
GET

### Endpoint
/StatutoryDeductions

### Response
#### Success Response (200)
- **statutoryDeductions** (array) - List of statutory deduction objects.
```

--------------------------------

### GET /Prepayments

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-bank-and-payments.md

Retrieves a list of prepayments. This endpoint requires the accounting.transactions or accounting.transactions.read scope.

```APIDOC
## GET /Prepayments

### Description
Retrieves a list of prepayments.

### Method
GET

### Endpoint
/Prepayments

### Response
#### Success Response (200)
- **Prepayments** (array) - The list of prepayments.
```

--------------------------------

### POST /Employees

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-uk.md

Creates a new employee. Requires the Xero-Tenant-Id header and the payroll.employees scope.

```APIDOC
## POST /Employees

### Description
Creates a new employee.

### Method
POST

### Endpoint
/Employees

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

#### Request Body
- **Employee** - Required - Employee object

### Auth Scopes
payroll.employees

### Response
#### Success Response (200)
- **EmployeeObject** - Created employee object

### Error Statuses
- 400
```

--------------------------------

### GET /PayRuns

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Retrieves a list of pay runs.

```APIDOC
## GET /PayRuns

### Description
Retrieves a list of pay runs.

### Method
GET

### Endpoint
/PayRuns

### Response
#### Success Response (200)
- **PayRuns** - A collection of pay run objects.

```

--------------------------------

### PUT /Accounts

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-bank-and-payments.md

Creates a new account.

```APIDOC
## PUT /Accounts

### Description
Creates a new account.

### Method
PUT

### Endpoint
/Accounts

### Parameters
#### Request Body
- **Account** (object) - Required - The account to create.

### Request Example
{
  "Code": "200",
  "Name": "Sales",
  "Type": "REVENUE"
}

### Response
#### Success Response (200)
- **Accounts** (array) - The created account.

#### Response Example
{
  "Accounts": [
    {
      "AccountID": "00000000-0000-0000-0000-000000000000",
      "Code": "200",
      "Name": "Sales",
      "Type": "REVENUE"
    }
  ]
}

### Error Statuses
- 400 Bad Request
```

--------------------------------

### GET /LeaveTypes

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Retrieves a list of leave types.

```APIDOC
## GET /LeaveTypes

### Description
Retrieves a list of leave types.

### Method
GET

### Endpoint
/LeaveTypes

### Response
#### Success Response (200)
- **LeaveTypes** - A collection of leave type objects.

```

--------------------------------

### GET /EarningsRates

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Retrieves a list of earnings rates.

```APIDOC
## GET /EarningsRates

### Description
Retrieves a list of earnings rates.

### Method
GET

### Endpoint
/EarningsRates

### Response
#### Success Response (200)
- **EarningsRates** - A collection of earnings rate objects.

```

--------------------------------

### POST /Employees/{EmployeeID}/paytemplateearnings

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-uk.md

Creates multiple earnings templates for a specific employee. Requires the Xero-Tenant-Id header and the payroll.employees scope.

```APIDOC
## POST /Employees/{EmployeeID}/paytemplateearnings

### Description
Creates multiple earnings templates for a specific employee.

### Method
POST

### Endpoint
/Employees/{EmployeeID}/paytemplateearnings

### Parameters
#### Path Parameters
- **EmployeeID** (string) - Required - The unique identifier of the employee

#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

#### Request Body
- **EarningsTemplates** - Required - List of earnings templates

### Auth Scopes
payroll.employees

### Response
#### Success Response (200)
- **EmployeePayTemplates** - Employee pay templates

### Error Statuses
- 400
```

--------------------------------

### GET /BrandingThemes

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves a list of branding themes. Requires the accounting.settings or accounting.settings.read scope.

```APIDOC
## GET /BrandingThemes

### Description
Retrieves a list of branding themes.

### Method
GET

### Endpoint
/BrandingThemes

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **BrandingThemes** (array) - List of branding themes.

#### Response Example
{
  "BrandingThemes": []
}
```

--------------------------------

### POST /BrandingThemes/{BrandingThemeID}/PaymentServices

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Creates a payment service for a branding theme. Requires the paymentservices scope. May return a 400 error.

```APIDOC
## POST /BrandingThemes/{BrandingThemeID}/PaymentServices

### Description
Creates a payment service for a branding theme.

### Method
POST

### Endpoint
/BrandingThemes/{BrandingThemeID}/PaymentServices

### Parameters
#### Path Parameters
- **BrandingThemeID** (string) - Required - The unique identifier of the branding theme.

#### Query Parameters
None

#### Request Body
- **PaymentServices** (object) - Required - Payment service details.

### Request Example
{
  "PaymentServices": {}
}

### Response
#### Success Response (200)
- **PaymentServices** (object) - The created payment service.

#### Response Example
{
  "PaymentServices": {}
}

#### Error Response (400)
- **Error** (object) - Error details.
```

--------------------------------

### GET /Reports/ProfitAndLoss

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves the Profit and Loss report.

```APIDOC
## GET /Reports/ProfitAndLoss

### Description
Retrieves the Profit and Loss report.

### Method
GET

### Endpoint
/Reports/ProfitAndLoss

### Parameters
#### Query Parameters
- **fromDate** (string) - Optional - Start date.
- **toDate** (string) - Optional - End date.
- **periods** (integer) - Optional - Number of periods.
- **timeframe** (string) - Optional - Timeframe (e.g., MONTH, QUARTER, YEAR).
- **trackingCategoryID** (string) - Optional - Tracking category ID.
- **trackingOptionID** (string) - Optional - Tracking option ID.
- **standardLayout** (boolean) - Optional - Use standard layout.
- **paymentsOnly** (boolean) - Optional - Show payments only.

### Response
#### Success Response (200)
- **ReportWithRows** (object) - The report data with rows.

#### Response Example
```json
{
  "ReportID": "00000000-0000-0000-0000-000000000000",
  "ReportName": "ProfitAndLoss",
  "ReportTitles": [],
  "Rows": []
}
```
```

--------------------------------

### GET /Reports/ExecutiveSummary

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves the Executive Summary report.

```APIDOC
## GET /Reports/ExecutiveSummary

### Description
Retrieves the Executive Summary report.

### Method
GET

### Endpoint
/Reports/ExecutiveSummary

### Parameters
#### Query Parameters
- **date** (string) - Optional - Report date.

### Response
#### Success Response (200)
- **ReportWithRows** (object) - The report data with rows.

#### Response Example
```json
{
  "ReportID": "00000000-0000-0000-0000-000000000000",
  "ReportName": "ExecutiveSummary",
  "ReportTitles": [],
  "Rows": []
}
```
```

--------------------------------

### GET /SuperfundProducts

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Retrieves a list of superfund products.

```APIDOC
## GET /SuperfundProducts

### Description
Retrieves a list of superfund products.

### Method
GET

### Endpoint
/SuperfundProducts

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
#### Success Response (200)
- **SuperFundProducts** - The response body contains a SuperFundProducts object.

#### Error Statuses
- 400

```

--------------------------------

### POST /PayRuns

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Creates a new pay run.

```APIDOC
## POST /PayRuns

### Description
Creates a new pay run.

### Method
POST

### Endpoint
/PayRuns

### Parameters
#### Request Body
- **PayRun** (object) - Required - The pay run details to create.

### Response
#### Success Response (200)
- **PayRunObject** - The created pay run object.

#### Error Response (400)
- Bad request.

```

--------------------------------

### GET,POST /PayRuns

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/endpoints.md

Retrieve a list of pay runs or create a new pay run.

```APIDOC
## GET /PayRuns

### Description
Retrieves a list of pay runs.

### Method
GET

### Endpoint
/PayRuns

### Response
#### Success Response (200)
- **payRuns** (array) - List of pay run objects.

## POST /PayRuns

### Description
Creates a new pay run.

### Method
POST

### Endpoint
/PayRuns

### Request Body
- **payRun** (object) - Pay run details.

### Response
#### Success Response (200)
- **payRun** (object) - The created pay run.
```

--------------------------------

### GET /Reports/BudgetSummary

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves the Budget Summary report.

```APIDOC
## GET /Reports/BudgetSummary

### Description
Retrieves the Budget Summary report.

### Method
GET

### Endpoint
/Reports/BudgetSummary

### Parameters
#### Query Parameters
- **date** (string) - Optional - Report date.
- **period** (integer) - Optional - Period number.
- **timeframe** (string) - Optional - Timeframe (e.g., MONTH, QUARTER, YEAR).

### Response
#### Success Response (200)
- **ReportWithRows** (object) - The report data with rows.

#### Response Example
```json
{
  "ReportID": "00000000-0000-0000-0000-000000000000",
  "ReportName": "BudgetSummary",
  "ReportTitles": [],
  "Rows": []
}
```
```

--------------------------------

### GET /Reports/{ReportID}

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves a report by its ID.

```APIDOC
## GET /Reports/{ReportID}

### Description
Retrieves a report by its ID.

### Method
GET

### Endpoint
/Reports/{ReportID}

### Parameters
#### Path Parameters
- **ReportID** (string) - Required - The unique identifier of the report.

### Response
#### Success Response (200)
- **ReportWithRows** (object) - The report data with rows.

#### Response Example
```json
{
  "ReportID": "00000000-0000-0000-0000-000000000000",
  "ReportName": "Report",
  "ReportTitles": [],
  "Rows": []
}
```
```

--------------------------------

### POST /Statements

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/bankfeeds.md

Creates one or more statements. Requires the bankfeeds scope and the Xero-Tenant-Id header.

```APIDOC
## POST /Statements

### Description
Creates one or more statements.

### Method
POST

### Endpoint
/Statements

### Parameters
#### Request Body
- **Statements** (object) - Required - The statements to create.

#### Headers
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant.

### Response
#### Success Response (200)
- **Statements** (object) - The created statements.

#### Response Example
{
  "statements": []
}
```

--------------------------------

### GET /Reports/BankSummary

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves the Bank Summary report.

```APIDOC
## GET /Reports/BankSummary

### Description
Retrieves the Bank Summary report.

### Method
GET

### Endpoint
/Reports/BankSummary

### Parameters
#### Query Parameters
- **date** (string) - Optional - Report date.
- **fromDate** (string) - Optional - Start date.
- **toDate** (string) - Optional - End date.

### Response
#### Success Response (200)
- **ReportWithRows** (object) - The report data with rows.

#### Response Example
```json
{
  "ReportID": "00000000-0000-0000-0000-000000000000",
  "ReportName": "BankSummary",
  "ReportTitles": [],
  "Rows": []
}
```
```

--------------------------------

### GET /Employees/{EmployeeID}/ukopeningbalances

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-uk.md

Retrieves opening balances for a specific employee. Requires the Xero-Tenant-Id header and appropriate payroll scopes.

```APIDOC
## GET /Employees/{EmployeeID}/ukopeningbalances

### Description
Retrieves opening balances for a specific employee.

### Method
GET

### Endpoint
/Employees/{EmployeeID}/ukopeningbalances

### Parameters
#### Path Parameters
- **EmployeeID** (string) - Required - The unique identifier of the employee

#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Auth Scopes
payroll.employees,payroll.employees.read

### Response
#### Success Response (200)
- **EmployeeOpeningBalancesObject** - Employee opening balances object
```

--------------------------------

### Run api-diff.test.sh unit tests

Source: https://github.com/xeroapi/xero-openapi/blob/master/scripts/api-diff/README.md

Executes the unit tests for conventional commit breaking marker detection.

```bash
./scripts/api-diff/api-diff.test.sh
```

--------------------------------

### GET /Reports/BalanceSheet

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-journals-and-reports.md

Retrieves the Balance Sheet report.

```APIDOC
## GET /Reports/BalanceSheet

### Description
Retrieves the Balance Sheet report.

### Method
GET

### Endpoint
/Reports/BalanceSheet

### Parameters
#### Query Parameters
- **date** (string) - Optional - Report date.
- **periods** (integer) - Optional - Number of periods.
- **timeframe** (string) - Optional - Timeframe (e.g., MONTH, QUARTER, YEAR).
- **trackingOptionID** (string) - Optional - Tracking option ID.
- **standardLayout** (boolean) - Optional - Use standard layout.
- **paymentsOnly** (boolean) - Optional - Show payments only.

### Response
#### Success Response (200)
- **ReportWithRows** (object) - The report data with rows.

#### Response Example
```json
{
  "ReportID": "00000000-0000-0000-0000-000000000000",
  "ReportName": "BalanceSheet",
  "ReportTitles": [],
  "Rows": []
}
```
```

--------------------------------

### GET /BankTransfers

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/accounting-bank-and-payments.md

Retrieves a list of bank transfers.

```APIDOC
## GET /BankTransfers

### Description
Retrieves a list of bank transfers.

### Method
GET

### Endpoint
/BankTransfers

### Parameters
#### Query Parameters
- **where** (string) - Optional - Filter results by a where clause.
- **order** (string) - Optional - Order results by a field.
- **page** (integer) - Optional - Page number.

### Response
#### Success Response (200)
- **BankTransfers** (array) - List of bank transfers.

#### Response Example
{
  "BankTransfers": [
    {
      "BankTransferID": "00000000-0000-0000-0000-000000000000",
      "Amount": 100.0
    }
  ]
}
```

--------------------------------

### POST /LeaveApplications

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Creates one or more leave applications.

```APIDOC
## POST /LeaveApplications

### Description
Creates one or more leave applications.

### Method
POST

### Endpoint
/LeaveApplications

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

#### Request Body
- **array<LeaveApplication>** - Required - The request body contains an array of LeaveApplication objects.

### Response
#### Success Response (200)
- **LeaveApplications** - The response body contains a LeaveApplications object.

#### Error Statuses
- 400

```

--------------------------------

### GET /PayRuns

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Retrieves a list of pay runs.

```APIDOC
## GET /PayRuns

### Description
Retrieves a list of pay runs.

### Method
GET

### Endpoint
/PayRuns

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
#### Success Response (200)
- **PayRuns** - The response body contains a PayRuns object.

#### Error Statuses
- 400

```

--------------------------------

### POST /Employees/{EmployeeID}/PayTemplateEarnings

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-nz.md

Creates multiple earnings templates for an employee. Requires the payroll.employees scope.

```APIDOC
## POST /Employees/{EmployeeID}/PayTemplateEarnings

### Description
Creates multiple earnings templates for an employee.

### Method
POST

### Endpoint
/Employees/{EmployeeID}/PayTemplateEarnings

### Parameters
#### Path Parameters
- **EmployeeID** (string) - Required - The unique identifier of the employee

#### Headers
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant

#### Request Body
- **EarningsTemplates** (object) - Required - List of earnings templates

### Request Example
```json
{
  "earningsTemplates": []
}
```

### Response
#### Success Response (200)
- **EmployeeEarningsTemplates** - The created earnings templates

#### Response Example
```json
{
  "employeeEarningsTemplates": []
}
```
```

--------------------------------

### GET /PayrollCalendars

Source: https://github.com/xeroapi/xero-openapi/blob/master/_autodocs/api-reference/payroll-au.md

Retrieves a list of payroll calendars.

```APIDOC
## GET /PayrollCalendars

### Description
Retrieves a list of payroll calendars.

### Method
GET

### Endpoint
/PayrollCalendars

### Parameters
#### Header Parameters
- **Xero-Tenant-Id** (string) - Required - Xero identifier for Tenant
- **Idempotency-Key** (string) - Optional - This allows you to safely retry requests without the risk of duplicate processing. 128 character max.

### Response
#### Success Response (200)
- **PayrollCalendars** - The response body contains a PayrollCalendars object.

#### Error Statuses
- 400

```
Tokens:
Raw