### Initiate Employee Self Setup

Source: https://api.keypay.com.au/australia/reference/employee-onboarding.html

Use this endpoint to start the employee self-setup process. It requires the business ID.

```HTTP
POST /api/v2/business/{businessId}/employeeonboarding/initiateselfservice
```

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

### Initiate Employee Self Setup Endpoint

Source: https://api.keypay.com.au/australia/reference/manager/au-manager-employee-onboarding--manager-initiate-self-service.html

The POST endpoint to initiate the employee self-setup process. Use this to start the onboarding flow for an employee.

```http
POST http:///api/v2/business/{businessId}/manager/employeeonboarding/initiateselfservice
```

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

### Get Opening Balances

Source: https://api.keypay.com.au/australia/reference/employee.html

Retrieves the opening balances for an employee. This is typically used for initial setup or historical data.

```HTTP
GET /api/v2/business/{businessId}/employee/{employeeId}/openingbalances
```

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

### Get Employee Lookup Data Request

Source: https://api.keypay.com.au/australia/reference/manager/au-manager-time-and-attendance--get-lookup-data.html

Example GET request to retrieve employee lookup data. Ensure to replace placeholders with actual IDs.

```http
GET http:///api/v2/business/{businessId}/manager/kiosk/{kioskId}/lookupdata/{employeeId}
```

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

### Start Payment Approval Process Request

Source: https://api.keypay.com.au/australia/reference/pay-run/payment-approval--start-payment-approval-process.html

Use this GET request to initiate the payment approval process for a payrun that is unfinalised and requires payment approval. Default notification users configured on the pay schedule will be notified.

```http
GET http:///api/v2/business/{businessId}/payrun/{payRunId}/paymentapproval/start
```

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

### Initiate Employee Self Setup

Source: https://api.keypay.com.au/australia/reference/employee-onboarding.html

Initiates the employee self-service setup process for a given business.

```APIDOC
## POST /api/v2/business/{businessId}/employeeonboarding/initiateselfservice

### Description
Initiates the employee self-service setup process for a given business.

### Method
POST

### Endpoint
/api/v2/business/{businessId}/employeeonboarding/initiateselfservice

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The ID of the business for which to initiate employee onboarding.
```

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

### Install Award

Source: https://api.keypay.com.au/australia/reference/award/au-award--install-award.html

Installs an award for the specified business. This operation is asynchronous and returns a job ID that can be used to track the installation progress.

```APIDOC
## PUT /api/v2/business/{businessId}/award/{awardId}/install

### Description
Installs an award for the specified business. This operation is asynchronous and returns a job ID that can be used to track the installation progress.

### Method
PUT

### Endpoint
/api/v2/business/{businessId}/award/{awardId}/install

### Parameters
#### Path Parameters
- **awardId** (int32) - Required - The ID of the award to install
- **businessId** (string) - Required - 

#### Request Body
- **awardPackageVersionId** (int32) - Nullable
- **preserveAutoProgressionSettings** (boolean) - Nullable
- **preserveCustomEmploymentAgreements** (boolean) - Nullable
- **preserveCustomLeaveAllowanceTemplates** (boolean) - Nullable
- **preserveCustomPayCategories** (boolean) - Nullable
- **preserveCustomPayRateTemplates** (boolean) - Nullable
- **preserveCustomRuleSetPeriod** (boolean) - Nullable
- **preserveCustomRules** (boolean) - Nullable
- **preserveCustomWorkTypes** (boolean) - Nullable
- **preserveDisabledRules** (boolean) - Nullable
- **reApplyLeaveAllowanceTemplates** (boolean) - Nullable
- **updatePayRates** (boolean) - Nullable
- **updateRuleSets** (boolean) - Nullable

### Response
#### Success Response (200)
- **AwardInstallResponse** - 

#### Error Response (400)
- **ProblemDetails** - 

#### Error Response (500)
- Internal Server Error
```

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

### Install Award

Source: https://api.keypay.com.au/australia/reference/award.html

Installs an award for a specific business.

```APIDOC
## PUT /api/v2/business/{businessId}/award/{awardId}/install

### Description
Installs an award for a specific business.

### Method
PUT

### Endpoint
/api/v2/business/{businessId}/award/{awardId}/install

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The ID of the business.
- **awardId** (string) - Required - The ID of the award to install.
```

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

### Get Initial Service Date

Source: https://api.keypay.com.au/australia/reference/pay-conditions-comparison/au-pay-condition-comparison--get-service-date.html

Fetches the initial service date for a given employee's pay condition comparison. This is useful for determining the start date for various pay-related calculations.

```APIDOC
## GET /api/v2/business/{businessId}/employee/{employeeId}/payconditionscomparison/initialservicedate

### Description
Gets the initial service date for the specified employee's pay condition comparison.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/employee/{employeeId}/payconditionscomparison/initialservicedate

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The ID of the business.
- **employeeId** (string) - Required - The ID of the employee.

### Response
#### Success Response (200)
- **InitialServiceDateResponse** - The response resource containing the initial service date.
```

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

### Get Initial Tax Year

Source: https://api.keypay.com.au/australia/reference/business.html

Retrieves the initial financial year set for a business. Use this to determine the starting tax year.

```HTTP
GET /api/v2/business/{businessId}/initialfinancialyear
```

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

### Install Award

Source: https://api.keypay.com.au/australia/resources/awardinstallrequest.html

Installs an award by updating its settings and configurations. This method allows for granular control over which settings are preserved or updated during the installation process.

```APIDOC
## PUT /awardinstallrequest

### Description
Installs an award by updating its settings and configurations. This method allows for granular control over which settings are preserved or updated during the installation process.

### Method
PUT

### Endpoint
/awardinstallrequest

### Parameters
#### Request Body
- **awardPackageVersionId** (int32) - Nullable - The ID of the award package version to install.
- **preserveAutoProgressionSettings** (boolean) - Nullable - Whether to preserve auto-progression settings.
- **preserveCustomEmploymentAgreements** (boolean) - Nullable - Whether to preserve custom employment agreements.
- **preserveCustomLeaveAllowanceTemplates** (boolean) - Nullable - Whether to preserve custom leave allowance templates.
- **preserveCustomPayCategories** (boolean) - Nullable - Whether to preserve custom pay categories.
- **preserveCustomPayRateTemplates** (boolean) - Nullable - Whether to preserve custom pay rate templates.
- **preserveCustomRuleSetPeriod** (boolean) - Nullable - Whether to preserve custom rule set periods.
- **preserveCustomRules** (boolean) - Nullable - Whether to preserve custom rules.
- **preserveCustomWorkTypes** (boolean) - Nullable - Whether to preserve custom work types.
- **preserveDisabledRules** (boolean) - Nullable - Whether to preserve disabled rules.
- **reApplyLeaveAllowanceTemplates** (boolean) - Nullable - Whether to re-apply leave allowance templates.
- **updatePayRates** (boolean) - Nullable - Whether to update pay rates.
- **updateRuleSets** (boolean) - Nullable - Whether to update rule sets.

### Request Example
{
  "awardPackageVersionId": 123,
  "preserveAutoProgressionSettings": true,
  "preserveCustomEmploymentAgreements": false,
  "preserveCustomLeaveAllowanceTemplates": true,
  "preserveCustomPayCategories": false,
  "preserveCustomPayRateTemplates": true,
  "preserveCustomRuleSetPeriod": false,
  "preserveCustomRules": true,
  "preserveCustomWorkTypes": false,
  "preserveDisabledRules": true,
  "reApplyLeaveAllowanceTemplates": false,
  "updatePayRates": true,
  "updateRuleSets": false
}

### Response
#### Success Response (200)
(No specific response schema provided in the source, typically indicates success or returns updated resource details)

#### Response Example
(No example provided in the source)
```

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

### Start Payment Approval Process

Source: https://api.keypay.com.au/australia/reference/pay-run/payment-approval--start-payment-approval-process.html

Starts the payment approval process for a specified payrun within a business.

```APIDOC
## GET /api/v2/business/{businessId}/payrun/{payRunId}/paymentapproval/start

### Description
Starts the payment approval process for a specified payrun within a business. This is applicable for unfinalised payruns that require payment approval.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/payrun/{payRunId}/paymentapproval/start

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The ID of the business.
- **payRunId** (int32) - Required - The ID of the payrun.

#### Response
#### Success Response (200)
OKOK
```

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

### Start Approval Process

Source: https://api.keypay.com.au/australia/reference/pay-run/pay-run-approval--start-approval-process.html

Starts the approval process for a pay run, notifying the default contacts for this pay schedule.

```APIDOC
## POST /api/v2/business/{businessId}/payrun/{payRunId}/approval/start

### Description
Starts the approval process for a pay run, notifying the default contacts for this pay schedule.

### Method
POST

### Endpoint
/api/v2/business/{businessId}/payrun/{payRunId}/approval/start

### Parameters
#### Path Parameters
- **payRunId** (int32) - Required - 
- **businessId** (string) - Required - 

### Response
#### Success Response (200)
OKOK
```

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

### Install Award API Endpoint

Source: https://api.keypay.com.au/australia/reference/award.html

Use this endpoint to install an award for a specific business. Requires the business ID and award ID.

```HTTP
PUT /api/v2/business/{businessId}/award/{awardId}/install
```

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

### Install Award

Source: https://api.keypay.com.au/australia/resources/awardinstallresponse.html

Installs an award by updating the AwardInstallResponse resource. This method allows for specifying employees with overridden rates and a job ID.

```APIDOC
## PUT /websites/api_keypay_au_australia/AwardInstallResponse

### Description
Installs an award by updating the AwardInstallResponse resource. This method allows for specifying employees with overridden rates and a job ID.

### Method
PUT

### Endpoint
/websites/api_keypay_au_australia/AwardInstallResponse

### Request Body
- **employeesWithOverriddenRate** (array) - Optional - List of employees with overridden rates.
  - **firstName** (string) - Optional - String
  - **id** (int32) - Optional - Int32
  - **middleName** (string) - Optional - String
  - **name** (string) - Optional - String
  - **otherName** (string) - Optional - String
  - **surname** (string) - Optional - String
- **jobId** (uuid) - Optional - Nullable

### Response
#### Success Response (200)
- **employeesWithOverriddenRate** (array) - List of employees with overridden rates.
  - **firstName** (string) - String
  - **id** (int32) - Int32
  - **middleName** (string) - String
  - **name** (string) - String
  - **otherName** (string) - String
  - **surname** (string) - String
- **jobId** (uuid) - Nullable
```

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

### Install Award

Source: https://api.keypay.com.au/australia/resources/problemdetails.html

Installs an award within the system. This operation is typically used to set up award structures for employee pay calculations.

```APIDOC
## PUT Install Award

### Description
Installs an award within the system.

### Method
PUT

### Endpoint
/awards

### Parameters
#### Request Body
- **award** (object) - Required - The award object to install.
```

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

### POST /api/v2/business/{businessId}/employeeonboarding/initiateselfservice

Source: https://api.keypay.com.au/australia/reference/employee-onboarding/au-business-employee-onboarding--initiate-self-service.html

Initiates the self-setup process for an employee. If an employee ID is provided and the email/mobile match, it proceeds. If no ID is provided, a new employee record is created.

```APIDOC
## POST /api/v2/business/{businessId}/employeeonboarding/initiateselfservice

### Description
Initiates the Self Setup process for an Employee. If the employee has an existing employee record, the id should be specified. If the Email and Mobile provided are not the same as those on the employee record, they will be updated. If the employee does not yet have an employee record do not specify an id, one will be created with the details provided.

### Method
POST

### Endpoint
/api/v2/business/{businessId}/employeeonboarding/initiateselfservice

### Parameters
#### Path Parameters
- **businessId** (string) - Required - Description not specified

#### Request Body
- **email** (string) - Required - String
- **emergencyContactDetailsRequired** (boolean) - Required - Boolean
- **employingEntityId** (int32) - Optional - Nullable
- **firstName** (string) - Required - String
- **id** (int32) - Optional - Nullable
- **mobile** (string) - Required - String
- **qualificationsRequired** (boolean) - Required - Boolean
- **surname** (string) - Required - String
- **title** (int32) - Optional - Nullable

### Response
#### Success Response (200)
OKOK - Description not specified

#### Error Response
- **404** - Not FoundNot Found - ProblemDetails
```

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

### Get Enabled Features

Source: https://api.keypay.com.au/australia/reference/employee-self-setup/au-ess-employee--features.html

Retrieves details about the Employee Self Setup (ESS) features that are enabled for a given business.

```APIDOC
## GET /api/v2/ess/{employeeId}/security/features

### Description
Gets details as to which ESS features are enabled for the business.

### Method
GET

### Endpoint
/api/v2/ess/{employeeId}/security/features

### Parameters
#### Path Parameters
- **employeeId** (string) - Required - Description for employeeId

### Response
#### Success Response (200)
- **AuFeaturesModel** - Description for AuFeaturesModel
```

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

### POST /api/v2/business/{businessId}/manager/employeeonboarding/initiateselfservice

Source: https://api.keypay.com.au/australia/reference/manager/au-manager-employee-onboarding--manager-initiate-self-service.html

Initiates the self-setup process for an employee. If an employee ID is provided and the employee exists, their record will be updated with the provided email and mobile. If no ID is provided, a new employee record will be created.

```APIDOC
## POST /api/v2/business/{businessId}/manager/employeeonboarding/initiateselfservice

### Description
Initiates the self-setup process for an employee. If an employee ID is provided and the employee exists, their record will be updated with the provided email and mobile. If no ID is provided, a new employee record will be created.

### Method
POST

### Endpoint
/api/v2/business/{businessId}/manager/employeeonboarding/initiateselfservice

### Parameters
#### Path Parameters
- **businessId** (string) - Required - Description for businessId

#### Request Body
- **email** (string) - Required - String
- **emergencyContactDetailsRequired** (boolean) - Required - Boolean
- **employingEntityId** (int32) - Optional - Nullable
- **firstName** (string) - Required - String
- **id** (int32) - Optional - Nullable
- **mobile** (string) - Required - String
- **qualificationsRequired** (boolean) - Required - Boolean
- **surname** (string) - Required - String
- **title** (int32) - Optional - Nullable

### Response
#### Success Response (200)
- **OKOK** - Description for OKOK

#### Error Response
- **404** - Not FoundNot Found - ProblemDetails
```

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

### Get Shift Periods

Source: https://api.keypay.com.au/australia/reference/employment-agreement/au-employment-agreement--shift-periods.html

Retrieves all shift periods for a specified employment agreement. You can optionally filter by a start time range for the shifts.

```APIDOC
## Get Shift Periods

### Description
Gets all the shift periods for the employment agreement with the specified ID.

### Method
POST

### Endpoint
/api/v2/business/{businessId}/employmentagreement/{id}/shiftperiods

### Parameters
#### Path Parameters
- **id** (int32) - Required - 
- **businessId** (string) - Required - 

#### Request Body
- **firstShiftStartTime** (date-time) - Nullable - 
- **lastShiftStartTime** (date-time) - Nullable - 

### Request Example
{
  "firstShiftStartTime": "date-time",
  "lastShiftStartTime": "date-time"
}

### Response
#### Success Response (200)
- **ShiftPeriodModel** - 

#### Response Example
{
  "example": "ShiftPeriodModel"
}
```

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

### Initiate Employee Self Setup

Source: https://api.keypay.com.au/australia/resources/auinitiateemployeeonboardingapimodel.html

Initiates the employee self-setup process. This method allows for the creation of a new employee record or the initiation of their onboarding workflow.

```APIDOC
## POST /api/v1/employees/onboarding/au/initiate

### Description
Initiates the employee self-setup process by providing employee details.

### Method
POST

### Endpoint
/api/v1/employees/onboarding/au/initiate

### Parameters
#### Request Body
- **email** (string) - Required - The employee's email address.
- **emergencyContactDetailsRequired** (boolean) - Required - Indicates if emergency contact details are required.
- **employingEntityId** (int32) - Optional - The ID of the employing entity.
- **firstName** (string) - Required - The employee's first name.
- **qualificationsRequired** (boolean) - Required - Indicates if qualifications are required.
- **surname** (string) - Required - The employee's surname.
- **title** (int32) - Optional - The employee's title.

### Request Example
{
  "email": "john.doe@example.com",
  "emergencyContactDetailsRequired": true,
  "employingEntityId": 123,
  "firstName": "John",
  "qualificationsRequired": false,
  "surname": "Doe",
  "title": 1
}

### Response
#### Success Response (200)
- **id** (int32) - The unique identifier for the initiated employee onboarding.

#### Response Example
{
  "id": 456
}
```

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

### Start Approval Process

Source: https://api.keypay.com.au/australia/reference/pay-run.html

Initiates the approval process for a pay run.

```http
POST /api/v2/business/{businessId}/payrun/{payRunId}/approval/start
```

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

### Get Shift Conditions

Source: https://api.keypay.com.au/australia/reference/employee-self-setup/au-ess-lookup--shift-condition.html

Retrieves all shift conditions associated with a specific employee. This endpoint is part of the Employee Self Setup (ESS) lookup functionality for Australia.

```APIDOC
## GET /api/v2/ess/{employeeId}/lookup/shiftcondition

### Description
Gets all the shift conditions for the employee.

### Method
GET

### Endpoint
/api/v2/ess/{employeeId}/lookup/shiftcondition

### Parameters
#### Path Parameters
- **employeeId** (string) - Required - Description for employeeId

### Response
#### Success Response (200)
- **AuWorkTypeModel** - Description for AuWorkTypeModel
```

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

### Single Sign On

Source: https://api.keypay.com.au/australia/reference/authentication.html

Initiate Single Sign-On process.

```APIDOC
## Single Sign On

### Description
Initiate Single Sign-On process.

### Method
POST

### Endpoint
/api/v2/singlesignon
```

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

### Create Payslip Configuration

Source: https://api.keypay.com.au/australia/reference/business.html

Sets up the payslip configuration for a business. Use this to define how payslips are generated.

```HTTP
POST /api/v2/business/{businessId}/payslip
```

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

### Get Initial Service Date

Source: https://api.keypay.com.au/australia/resources/initialservicedateresponse.html

Retrieves the initial service start date and its associated type. This endpoint allows clients to fetch crucial date information related to service commencement.

```APIDOC
## GET /initialservicedate

### Description
Retrieves the initial service start date and its associated type.

### Method
GET

### Endpoint
/initialservicedate

### Response
#### Success Response (200)
- **serviceStartDate** (date-time) - Nullable
- **serviceStartDateType** (string) - Possible values are: `EmployeeStartDate`, `SpecifiedDate`

### Response Example
```json
{
  "serviceStartDate": "2023-10-27T10:00:00Z",
  "serviceStartDateType": "EmployeeStartDate"
}
```
```

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

### Create New Business

Source: https://api.keypay.com.au/australia/reference/business/au-business--post.html

Creates a new business entity with specified details and optional setup data.

```APIDOC
## POST /api/v2/business

### Description
Creates a new business entity with specified details and optional setup data.

### Method
POST

### Endpoint
/api/v2/business

### Query Parameters
- **setupDefaultData** (boolean) - Optional - If true, default data will be set up for the new business.

### Request Body
The request body accepts an AuBusinessExportModel resource with the following writable properties:
- **abn** (string) - The Australian Business Number.
- **addressLine1** (string) - The first line of the business address.
- **addressLine2** (string) - The second line of the business address.
- **budgetEntryMethod** (string) - The method for budget entry.
- **budgetWarningPercent** (double) - The percentage for budget warnings.
- **contactEmailAddress** (string) - The email address of the business contact.
- **contactFaxNumber** (string) - The fax number of the business contact.
- **contactName** (string) - The name of the business contact.
- **contactPhoneNumber** (string) - The phone number of the business contact.
- **dateCreated** (date-time) - The date the business was created.
- **endOfWeek** (string) - The day of the week the business week ends on.
- **externalId** (string) - An external identifier for the business.
- **foreignEntityCountry** (string) - The country of the foreign entity, if applicable.
- **id** (int32) - The unique identifier for the business.
- **industryName** (string) - The name of the industry the business operates in.
- **initialFinancialYearStart** (int32) - The starting year of the initial financial year.
- **isForeignEntity** (boolean) - Flag indicating if the entity is foreign.
- **journalService** (string) - The journal service used by the business.
- **leaveAccrualStartDateType** (string) - The type of start date for leave accrual.
- **leaveYearStart** (date-time) - The start date of the leave year.
- **legalName** (string) - The legal name of the business.
- **managementSoftwareId** (string) - The ID of the management software used.
- **managersCanEditRosterBudgets** (boolean) - Flag indicating if managers can edit roster budgets.
- **name** (string) - The name of the business.
- **numberOfEmployees** (string) - The number of employees in the business.
- **payCycleFrequency** (string) - The frequency of pay cycles.
- **postCode** (string) - The postal code of the business address.
- **promoCode** (string) - A promotional code associated with the business.
- **region** (string) - The region where the business is located.
- **source** (string) - The source of the business data.
- **standardHoursPerDay** (double) - The standard number of hours worked per day.
- **state** (string) - The state where the business is located.
- **suburb** (string) - The suburb of the business address.
- **whiteLabelId** (int32) - The ID of the white label.
- **whiteLabelName** (string) - The name of the white label.

### Request Example
```json
{
    "abn": "12345678901",
    "addressLine1": "123 Main St",
    "addressLine2": "Suite 100",
    "budgetEntryMethod": "Manual",
    "budgetWarningPercent": 80.0,
    "contactEmailAddress": "contact@example.com",
    "contactFaxNumber": "+61 2 1234 5678",
    "contactName": "John Doe",
    "contactPhoneNumber": "+61 2 9876 5432",
    "dateCreated": "2023-01-15T10:00:00Z",
    "endOfWeek": "Sunday",
    "externalId": "EXT123",
    "foreignEntityCountry": "",
    "id": 1,
    "industryName": "Technology",
    "initialFinancialYearStart": 2023,
    "isForeignEntity": false,
    "journalService": "Standard",
    "leaveAccrualStartDateType": "EmploymentStart",
    "leaveYearStart": "2023-07-01T00:00:00Z",
    "legalName": "Example Pty Ltd",
    "managementSoftwareId": "MS456",
    "managersCanEditRosterBudgets": true,
    "name": "Example Business",
    "numberOfEmployees": "10-50",
    "payCycleFrequency": "Weekly",
    "postCode": "2000",
    "promoCode": "SUMMER2023",
    "region": "NSW",
    "source": "Manual",
    "standardHoursPerDay": 7.5,
    "state": "NSW",
    "suburb": "Sydney",
    "whiteLabelId": 101,
    "whiteLabelName": "Example White Label"
}
```

### Response
#### Success Response (200)
- **id** (int32) - The unique identifier of the newly created business.
- **name** (string) - The name of the newly created business.

#### Response Example
```json
{
    "id": 123,
    "name": "Example Business"
}
```
```

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

### Start Payment Approval Process

Source: https://api.keypay.com.au/australia/reference/pay-run.html

Initiates the payment approval process for a pay run.

```http
GET /api/v2/business/{businessId}/payrun/{payRunId}/paymentapproval/start
```

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

### Copy Business Settings From Template

Source: https://api.keypay.com.au/australia/reference/business.html

Copies business settings from a specified template. Useful for setting up new businesses with pre-defined configurations.

```HTTP
POST /api/v2/business/{businessId}/{businessTemplateId}
```

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

### Initiate Single Sign On

Source: https://api.keypay.com.au/australia/reference/authentication.html

Endpoint for initiating the Single Sign On process.

```http
POST /api/v2/singlesignon
```

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

### Create Pay Run (Async)

Source: https://api.keypay.com.au/australia/reference/pay-run.html

Creates a new pay run asynchronously for a business.

```HTTP
POST /api/v2/business/{businessId}/payrun/async
```

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

### Award Install Request Body

Source: https://api.keypay.com.au/australia/reference/award/au-award--install-award.html

The request body for the install award operation. It specifies which settings and configurations to preserve or update during the award installation.

```JSON
{
    "awardPackageVersionId": "int32",
    "preserveAutoProgressionSettings": "boolean",
    "preserveCustomEmploymentAgreements": "boolean",
    "preserveCustomLeaveAllowanceTemplates": "boolean",
    "preserveCustomPayCategories": "boolean",
    "preserveCustomPayRateTemplates": "boolean",
    "preserveCustomRuleSetPeriod": "boolean",
    "preserveCustomRules": "boolean",
    "preserveCustomWorkTypes": "boolean",
    "preserveDisabledRules": "boolean",
    "reApplyLeaveAllowanceTemplates": "boolean",
    "updatePayRates": "boolean",
    "updateRuleSets": "boolean"
}
```

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

### Create New User

Source: https://api.keypay.com.au/australia/reference/user.html

Creates a new user in the system.

```APIDOC
## POST /api/v2/user

### Description
Creates a new user in the system.

### Method
POST

### Endpoint
/api/v2/user
```

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

### Get User Details

Source: https://api.keypay.com.au/australia/reference/user/user--get.html

Gets details about the user.

```APIDOC
## GET /api/v2/user

### Description
Gets details about the user.

### Method
GET

### Endpoint
/api/v2/user

### Response
#### Success Response (200)
- **UserModel** (object) - OKOK
```

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

### Start Break

Source: https://api.keypay.com.au/australia/reference/employee-self-setup.html

Records the start of a break for the employee.

```APIDOC
## POST /api/v2/ess/{employeeId}/timeandattendance/startbreak

### Description
Records the start of a break for the employee.

### Method
POST

### Endpoint
/api/v2/ess/{employeeId}/timeandattendance/startbreak
```

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

### POST Request for Async Pay Run Creation

Source: https://api.keypay.com.au/australia/reference/pay-run/au-pay-run-.html

Use this endpoint to initiate the asynchronous creation of a pay run. The request returns immediately, and the pay run is created in the background.

```http
POST http:///api/v2/business/{businessId}/payrun/async
```

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

### Get Kiosk by ID

Source: https://api.keypay.com.au/australia/reference/time-and-attendance/kiosk--get.html

Gets the kiosk with the specified ID.

```APIDOC
## GET /api/v2/business/{businessId}/kiosk/{id}

### Description
Gets the kiosk with the specified ID.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/kiosk/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - 
- **businessId** (string) - Required - 

### Response
#### Success Response (200)
- **TimeAndAttendanceKioskModel** - OKOK
```

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

### Get Qualification by ID

Source: https://api.keypay.com.au/australia/reference/qualifications/qualification--get-qualification.html

Gets the qualification with the specified ID.

```APIDOC
## GET /api/v2/business/{businessId}/qualification/{id}

### Description
Gets the qualification with the specified ID.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/qualification/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - 
- **businessId** (string) - Required - 

### Response
#### Success Response (200)
- **QualificationModel** - 

#### Response Example
{
  "example": "QualificationModel"
}
```

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

### Create Pay Run (Async)

Source: https://api.keypay.com.au/australia/reference/pay-run/au-pay-run-.html

Creates a new pay run for a business asynchronously. The request returns immediately, and the pay run is created in the background.

```APIDOC
## POST /api/v2/business/{businessId}/payrun/async

### Description
Creates a new pay run for this business asynchronously (the request will return before the pay run is created).

### Method
POST

### Endpoint
/api/v2/business/{businessId}/payrun/async

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The ID of the business for which to create the pay run.

#### Request Body
- **adhoc** (boolean) - Optional - Indicates if this is an ad-hoc pay run.
- **callbackUrl** (string) - Optional - A URL to receive notifications about the pay run status.
- **createWithEmptyPays** (boolean) - Optional - Whether to create the pay run even if there are no employees to pay.
- **datePaid** (date-time) - Required - The date the pay run was paid.
- **externalId** (string) - Optional - An external identifier for the pay run.
- **includeTerminatedEmployees** (boolean) - Optional - Whether to include terminated employees in the pay run.
- **payPeriodEnding** (date-time) - Required - The end date of the pay period.
- **payScheduleId** (int32) - Required - The ID of the pay schedule.
- **timesheetImportOption** (string) - Optional - The option for importing timesheets. Possible values: `None`, `ThisPayPeriod`, `AllOutstanding`, `CustomPeriod`.

### Request Example
```json
{
  "adhoc": false,
  "callbackUrl": "https://example.com/callback",
  "createWithEmptyPays": false,
  "datePaid": "2023-10-27T10:00:00Z",
  "externalId": "PAYRUN-12345",
  "includeTerminatedEmployees": false,
  "payPeriodEnding": "2023-10-27T10:00:00Z",
  "payScheduleId": 1,
  "timesheetImportOption": "ThisPayPeriod"
}
```

### Response
#### Success Response (200)
- **PayRunJobModel** - Represents the status and details of the asynchronous pay run job.
```

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

### Get Pay Rates

Source: https://api.keypay.com.au/australia/reference/employee/au-employee-pay-rates--get.html

Gets the pay rates for this employee.

```APIDOC
## GET /api/v2/business/{businessId}/employee/{employeeId}/payrate

### Description
Gets the pay rates for this employee.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/employee/{employeeId}/payrate

### Parameters
#### Path Parameters
- **businessId** (string) - Required - 
- **employeeId** (string) - Required - 

### Response
#### Success Response (200)
- **AuEmployeePayRateModel** - 
```

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

### Get Employee By ID

Source: https://api.keypay.com.au/australia/reference/employee/au-employee--get-employee-by-id.html

Gets the employee with the specified ID.

```APIDOC
## GET /api/v2/business/{businessId}/employee/unstructured/{employeeId}

### Description
Gets the employee with the specified ID.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/employee/unstructured/{employeeId}

### Parameters
#### Path Parameters
- **employeeId** (int32) - Required - 
- **businessId** (string) - Required - 

### Response
#### Success Response (200)
- **AuUnstructuredEmployeeModel** - 

#### Error Response (404)
- **ProblemDetails** - 
```

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

### Get Dimension by ID

Source: https://api.keypay.com.au/australia/reference/dimensions/reporting-dimension--get.html

Gets the dimension with the specified ID.

```APIDOC
## GET /api/v2/business/{businessId}/dimension/{id}

### Description
Gets the dimension with the specified ID.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/dimension/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - 
- **businessId** (string) - Required - 

### Response
#### Success Response (200)
- **ReportingDimensionApiModel** - 

#### Error Response (404)
- **ProblemDetails** - 
```

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

### Initiate Self Service API Endpoint

Source: https://api.keypay.com.au/australia/reference/employee-onboarding/au-business-employee-onboarding--initiate-self-service.html

Use this POST endpoint to initiate the employee self-service setup. Specify the business ID in the path.

```http
POST http:///api/v2/business/{businessId}/employeeonboarding/initiateselfservice
```

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

### Start Break

Source: https://api.keypay.com.au/australia/reference/employee-self-setup.html

Records the start of a break for time and attendance.

```http
POST /api/v2/ess/{employeeId}/timeandattendance/startbreak
```

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

### Get Personal Details

Source: https://api.keypay.com.au/australia/reference/employee-self-setup/au-ess-employee--get-ess-details.html

Gets Personal details for the specified employee.

```APIDOC
## GET /api/v2/ess/{employeeId}/personaldetails

### Description
Gets Personal details for the specified employee.

### Method
GET

### Endpoint
/api/v2/ess/{employeeId}/personaldetails

### Parameters
#### Path Parameters
- **employeeId** (string) - Required - Description of the employee ID

### Response
#### Success Response (200)
- **AuEssEmployeeDetailsViewModel** - Description of the response resource
```

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

### Create payslip configuration

Source: https://api.keypay.com.au/australia/reference/business.html

Creates a payslip configuration for a business.

```APIDOC
## POST /api/v2/business/{businessId}/payslip

### Description
Creates a payslip configuration for a business.

### Method
POST

### Endpoint
/api/v2/business/{businessId}/payslip

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The unique identifier of the business.
```

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

### post - Create New User

Source: https://api.keypay.com.au/australia/resources/newusermodel.html

Creates a new user with the provided details. This method allows for the creation of user accounts within the system.

```APIDOC
## POST /users

### Description
Creates a new user with the provided details. This method allows for the creation of user accounts within the system.

### Method
POST

### Endpoint
/users

### Parameters
#### Request Body
- **apiOnly** (boolean) - Optional - Boolean
- **displayName** (string) - Optional - String
- **email** (string) - Optional - String
- **emailConfirmed** (boolean) - Optional - Boolean
- **timeZone** (string) - Optional - String
- **username** (string) - Optional - String

### Request Example
{
  "apiOnly": false,
  "displayName": "John Doe",
  "email": "john.doe@example.com",
  "emailConfirmed": false,
  "timeZone": "UTC",
  "username": "johndoe"
}

### Response
#### Success Response (200)
- **apiOnly** (boolean) - Boolean
- **displayName** (string) - String
- **email** (string) - String
- **emailConfirmed** (boolean) - Boolean
- **timeZone** (string) - String
- **username** (string) - String

#### Response Example
{
  "apiOnly": false,
  "displayName": "John Doe",
  "email": "john.doe@example.com",
  "emailConfirmed": false,
  "timeZone": "UTC",
  "username": "johndoe"
}
```

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

### Get Qualification Details

Source: https://api.keypay.com.au/australia/reference/employee-qualifications/employee-qualification--get.html

Gets the details for the qualification with a specific ID.

```APIDOC
## GET /api/v2/business/{businessId}/employee/{employeeId}/qualification/{id}

### Description
Gets the details for the qualification with a specific ID.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/employee/{employeeId}/qualification/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - 
- **businessId** (string) - Required - 
- **employeeId** (string) - Required - 

### Response
#### Success Response (200)
- **EmployeeQualificationModel** - OKOK
```

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

### Get Standard Hours for Employee

Source: https://api.keypay.com.au/australia/reference/employee/au-employee-standard-hours--get.html

Gets the standard hours for this employee.

```APIDOC
## GET /api/v2/business/{businessId}/employee/{employeeId}/standardhours

### Description
Gets the standard hours for this employee.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/employee/{employeeId}/standardhours

### Parameters
#### Path Parameters
- **businessId** (string) - Required - Description not specified
- **employeeId** (string) - Required - Description not specified

### Response
#### Success Response (200)
- **AuStandardHoursModel** - Description not specified
```

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

### Create New User

Source: https://api.keypay.com.au/australia/reference/user.html

Use this endpoint to create a new user.

```http
POST /api/v2/user
```

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

### Start Break

Source: https://api.keypay.com.au/australia/reference/employee-self-setup/au-ess-time-and-attendance--start-shift-break.html

Starts a break for an employee who is currently clocked on for a shift. This operation records the start of a break, including optional details like location, time, and break type.

```APIDOC
## POST /api/v2/ess/{employeeId}/timeandattendance/startbreak

### Description
Starts a break for the employee who is clocked on for a shift.

### Method
POST

### Endpoint
/api/v2/ess/{employeeId}/timeandattendance/startbreak

### Parameters
#### Path Parameters
- **employeeId** (int32) - Required - The ID of the employee for whom the break is being started.

#### Request Body
- **employeeId** (int32) - Nullable - The ID of the employee.
- **image** (byte[]) - Byte array representing an image.
- **ipAddress** (string) - The IP address from which the request is made.
- **isAdminInitiated** (boolean) - Indicates if the break was initiated by an administrator.
- **isPaidBreak** (boolean) - Indicates if the break is a paid break.
- **kioskId** (int32) - Nullable - The ID of the kiosk used.
- **latitude** (double) - Nullable - The latitude coordinate.
- **longitude** (double) - Nullable - The longitude coordinate.
- **noteVisibility** (string) - Nullable - Visibility setting for notes. Possible values are: `Hidden`, `Visible`.
- **recordedTimeUtc** (date-time) - Nullable - The time the break was recorded in UTC.
- **utcOffset** (date-span) - Nullable - The UTC offset.

### Response
#### Success Response (200)
- **KioskEmployeeModel** - OKOK
```

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

### POST http:///api/v2/business/{businessId}/{businessTemplateId}

Source: https://api.keypay.com.au/australia/reference/business/au-business--copy-business-settings-from-template.html

Copies business settings from a specified template to a target business.

```APIDOC
## POST http:///api/v2/business/{businessId}/{businessTemplateId}

### Description
Copies business settings from a specified template to a target business.

### Method
POST

### Endpoint
http:///api/v2/business/{businessId}/{businessTemplateId}

### Parameters
#### Path Parameters
- **businessId** (int32) - Required - 
- **businessTemplateId** (int32) - Required - 

### Response
#### Success Response (200)
OKOK
```

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

### Get Pay Schedule by ID

Source: https://api.keypay.com.au/australia/reference/pay-schedules/au-pay-schedule--get.html

Gets the pay schedule with the specified ID.

```APIDOC
## GET /api/v2/business/{businessId}/payschedule/{id}

### Description
Gets the pay schedule with the specified ID.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/payschedule/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - 
- **businessId** (string) - Required - 

### Response
#### Success Response (200)
- **AuPayScheduleModel** - 

```

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

### Get Pay Run Details

Source: https://api.keypay.com.au/australia/reference/pay-run/au-pay-run-details--get.html

Gets the details for the specified pay run.

```APIDOC
## GET /api/v2/business/{businessId}/payrun/{payRunId}/details

### Description
Gets the details for the specified pay run.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/payrun/{payRunId}/details

### Parameters
#### Path Parameters
- **businessId** (string) - Required - 
- **payRunId** (int32) - Required - 

#### Response
#### Success Response (200)
- **AuPayRunDetailsModel** - 

```

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

### Get Signup Report

Source: https://api.keypay.com.au/australia/reference/white-label.html

Retrieves a report of signups for a specific white label. Requires the white label ID.

```HTTP
GET /api/v2/whitelabel/{whitelabelId}/reports/signups
```

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

### Get Qualification Details

Source: https://api.keypay.com.au/australia/reference/employee-self-setup/ess-qualification--get.html

Gets the details for the qualification with a specific EmployeeQualification ID.

```APIDOC
## GET /api/v2/ess/{employeeId}/qualification/{id}

### Description
Gets the details for the qualification with a specific EmployeeQualification ID.

### Method
GET

### Endpoint
/api/v2/ess/{employeeId}/qualification/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - 
- **employeeId** (string) - Required - 

### Response
#### Success Response (200)
- **EssEmployeeQualificationModel** - 

#### Error Response (404)
- **ProblemDetails** - 
```

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

### Copy Business Settings From Template

Source: https://api.keypay.com.au/australia/reference/business.html

Copies business settings from a specified template to a business.

```APIDOC
## POST /api/v2/business/{businessId}/{businessTemplateId}

### Description
Copies business settings from a specified template to a business.

### Method
POST

### Endpoint
/api/v2/business/{businessId}/{businessTemplateId}

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The unique identifier of the business.
- **businessTemplateId** (string) - Required - The unique identifier of the business template.
```

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

### Get Expense Request by ID

Source: https://api.keypay.com.au/australia/reference/employee-expense-requests/expense-request--get.html

Gets the expense request with the specified ID.

```APIDOC
## GET /api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}

### Description
Gets the expense request with the specified ID.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/employee/{employeeId}/expenserequest/{expenseRequestId}

### Parameters
#### Path Parameters
- **businessId** (string) - Required - 
- **employeeId** (int32) - Required - 
- **expenseRequestId** (int32) - Required - 

### Response
#### Success Response (200)
- **ExpenseRequestResponseModel** - OKOK
```

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

### GET Request to List Pay Run Warnings

Source: https://api.keypay.com.au/australia/reference/pay-run/au-pay-run--get-warnings.html

Use this GET request to retrieve a list of warnings for a given pay run. Ensure you replace placeholders with your actual business and pay run IDs.

```http
GET http:///api/v2/business/{businessId}/payrun/{payRunId}/warnings
```

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

### Get Deduction Category by ID

Source: https://api.keypay.com.au/australia/reference/deduction-categories/au-deduction-category--get.html

Gets the deduction category with the specified ID.

```APIDOC
## GET /api/v2/business/{businessId}/deductioncategory/{id}

### Description
Gets the deduction category with the specified ID.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/deductioncategory/{id}

### Parameters
#### Path Parameters
- **id** (int32) - Required - 
- **businessId** (string) - Required - 

### Response
#### Success Response (200)
- **AuDeductionCategoryModel** - 

#### Error Response (404)
- **ProblemDetails** - 
```

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

### Create Pay Run

Source: https://api.keypay.com.au/australia/reference/pay-run.html

Creates a new pay run for a business.

```HTTP
POST /api/v2/business/{businessId}/payrun
```

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

### Get STP Registration Details

Source: https://api.keypay.com.au/australia/reference/business/au-stp-registration--get.html

Fetches the ATO settings already applied for a business's STP registration.

```APIDOC
## GET /api/v2/business/{businessId}/stpregister

### Description
Gets the ATO settings already applied for this business.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/stpregister

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The ID of the business to retrieve STP registration details for.

### Response
#### Success Response (200)
- **AuStpRegistrationModel** - OKOK
```

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

### Get Payment Summary PDF

Source: https://api.keypay.com.au/australia/reference/employee-self-setup/au-ess-document--payment-summary.html

Gets the PDF for the payment summary with the specified ID.

```APIDOC
## GET /api/v2/ess/{employeeId}/document/paymentsummary/{documentId}

### Description
Gets the PDF for the payment summary with the specified ID.

### Method
GET

### Endpoint
/api/v2/ess/{employeeId}/document/paymentsummary/{documentId}

### Parameters
#### Path Parameters
- **documentId** (int32) - Required - 
- **employeeId** (string) - Required - 

### Response
#### Success Response (200)
- **Byte[]** - OKOK

#### Error Response
- **404** - Not FoundNot Found - ProblemDetails
```

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

### Get Employee Document Details

Source: https://api.keypay.com.au/australia/reference/employee-documents/employee-document--get.html

Gets the details for the employee document with the specified ID.

```APIDOC
## GET /api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}

### Description
Gets the details for the employee document with the specified ID.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/employee/{employeeId}/document/{employeeDocumentId}

### Parameters
#### Path Parameters
- **employeeDocumentId** (int32) - Required - 
- **businessId** (string) - Required - 
- **employeeId** (string) - Required - 

### Response
#### Success Response (200)
- **EmployeeDocumentModel** - 

#### Error Response (404)
- **ProblemDetails** - 
```