### Initiate Employee Self Setup

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

Use this endpoint to start the employee self-service onboarding process. Requires the business ID.

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

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

### Initiate Employee Self-Service Endpoint

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

The endpoint for initiating the employee self-service setup process. Use this endpoint to start the onboarding flow for a new or existing employee.

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

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

### 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 specified payrun. Ensure the payrun is unfinalised and requires payment approval.

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

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

### Install Award

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

Installs an award. This operation is typically used for initial setup or updates to award configurations.

```APIDOC
## PUT /install/award

### Description
Installs or updates an award configuration.

### Method
PUT

### Endpoint
/install/award
```

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

### Get Business Request

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

Example of a GET request to retrieve business details by ID.

```http
GET http:///api/v2/business/{businessId}
```

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

### Initiate Employee Self Setup

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

Initiates the self-service setup process for an employee.

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

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

### Method
POST

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

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

### Initiate Self Service API Endpoint

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

The POST endpoint for initiating employee self-service setup. Use this to start the onboarding process for a new or existing employee.

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

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

### Install Award

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

Installs an award using the AwardInstallResponse resource. This method allows for the installation of awards, potentially with overridden employee rates.

```APIDOC
## PUT /awards/install

### Description
Installs an award using the AwardInstallResponse resource. This method allows for the installation of awards, potentially with overridden employee rates.

### Method
PUT

### Endpoint
/awards/install

### 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
```

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

### Initiate Employee Self Setup

Source: https://api.keypay.com.au/malaysia/reference.html

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

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

### Description
Initiates the employee self-service setup process.

### Method
POST

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

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

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

### Start Approval Process

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

Starts the approval process for a pay run.

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

### Description
Starts the approval process for a pay run.

### Method
POST

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

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The ID of the business.
- **payRunId** (string) - Required - The ID of the pay run.
```

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

### 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

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

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

#### Response Example
{
  "example": "response body"
}
```

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

### Start Payment Approval Process

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

Starts the payment approval process for a pay run.

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

### Description
Starts the payment approval process for a pay run.

### Method
GET

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

### Parameters
#### Path Parameters
- **businessId** (string) - Required - The ID of the business.
- **payRunId** (string) - Required - The ID of the pay run.
```

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

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

Source: https://api.keypay.com.au/malaysia/reference.html

Initiates the employee self-setup process.

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

### Description
Initiates the employee self-setup process.

### Method
POST

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

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

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

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

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

Initiates the self-setup process for an employee. If an employee ID is provided and matches an existing record, their details will be updated. If no ID is provided, a new employee record will be created.

```APIDOC
## POST /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
/business/{businessId}/employeeonboarding/initiateselfservice

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

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

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

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

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

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

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

Initiates the self-setup process for an employee. If the employee has an existing record, the ID should be specified. If the email and mobile provided differ from the employee record, they will be updated. If no employee record exists, one will be created with the provided details.

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

### Description
Initiates the self-setup process for an employee. If the employee has an existing record, the ID should be specified. If the email and mobile provided differ from the employee record, they will be updated. If no employee record exists, one will be created with the provided details.

### Method
POST

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

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

#### Request Body
- **email** (string) - String
- **emergencyContactDetailsRequired** (boolean) - Boolean
- **employingEntityId** (int32) - Nullable
- **firstName** (string) - String
- **id** (int32) - Nullable
- **mobile** (string) - String
- **onboardingStarterType** (string) - Nullable Possible values are:
  * `NewStarterKiwiSaverEligible`
  * `NewStarterKiwiSaverIneligible`
  * `ExistingEmployeeKiwiStarterEligible`
  * `ExistingEmployeeKiwiStarterIneligible`
- **qualificationsRequired** (boolean) - Boolean
- **surname** (string) - String
- **title** (int32) - Nullable

### Response
#### Success Response (200)
OK

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

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

### Get Occupational Absence

Source: https://api.keypay.com.au/united-kingdom/reference/employee/uk-occupational-absence--get-osp.html

Retrieves occupational absence records for a specific employee. You can filter the results by providing a start date range.

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

### Description
Retrieves occupational absence records for a specific employee. You can filter the results by providing a start date range.

### Method
GET

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

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

#### Query Parameters
- **earliestStartDate** (date-time) - Optional - The earliest start date for filtering absence records.
- **latestStartDate** (date-time) - Optional - The latest start date for filtering absence records.

### Response
#### Success Response (200)
- **PeriodOfLeaveModel** - Returns occupational absence records.
```

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

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

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

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

```APIDOC
## POST /business/{businessId}/manager/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
/business/{businessId}/manager/employeeonboarding/initiateselfservice

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

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

### Request Example
```json
{
    "email": "string",
    "emergencyContactDetailsRequired": true,
    "firstName": "string",
    "id": 0,
    "mobile": "string",
    "qualificationsRequired": true,
    "surname": "string",
    "title": 0
}
```

### Response
#### Success Response (200)
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 and end time for the shifts.

```APIDOC
## POST /api/v2/business/{businessId}/employmentagreement/{id}/shiftperiods

### 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 - 

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

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

### Get Shift Periods for Employee

Source: https://api.keypay.com.au/new-zealand/resources/getshiftperiodsmodel.html

Retrieves shift periods for an employee using a POST request. The request body should contain the start and end times for the shifts.

```APIDOC
## POST /GetShiftPeriodsModel

### Description
Retrieves shift periods for an employee. This method requires the start and end times of the shifts to be provided in the request body.

### Method
POST

### Endpoint
/GetShiftPeriodsModel

### Request Body
- **firstShiftStartTime** (date-time) - Nullable - The start time of the first shift.
- **lastShiftStartTime** (date-time) - Nullable - The end time of the last shift.

### Response
#### Success Response (200)
- **firstShiftStartTime** (date-time) - Nullable - The start time of the first shift.
- **lastShiftStartTime** (date-time) - Nullable - The end time of the last shift.
```

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

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

Source: https://api.keypay.com.au/new-zealand/reference/employee-onboarding/nz-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 uses the existing record. If no ID is provided, a new employee record is created.

```APIDOC
## POST /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 in source.

#### Request Body
- **email** (string) - Description not specified in source.
- **emergencyContactDetailsRequired** (boolean) - Description not specified in source.
- **employingEntityId** (int32) - Nullable - Description not specified in source.
- **firstName** (string) - Description not specified in source.
- **id** (int32) - Nullable - Description not specified in source.
- **mobile** (string) - Description not specified in source.
- **onboardingStarterType** (string) - Nullable - Possible values are: `NewStarterKiwiSaverEligible`, `NewStarterKiwiSaverIneligible`, `ExistingEmployeeKiwiStarterEligible`, `ExistingEmployeeKiwiStarterIneligible`.
- **qualificationsRequired** (boolean) - Description not specified in source.
- **surname** (string) - Description not specified in source.
- **title** (int32) - Nullable - Description not specified in source.

### Response
#### Success Response (200)
- **OKOK** - Description not specified in source.

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

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

### POST /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 matches an existing record, the employee's details (email, mobile) will be updated. If no ID is provided, a new employee record will be created.

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

### Description
Initiates the self-setup process for an employee. If the employee has an existing record, the ID should be specified. If the provided email and mobile differ from the existing record, they will be updated. If no employee record exists, one will be created with the provided details.

### Method
POST

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

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

#### Request Body
- **email** (string) - The email address of the employee.
- **emergencyContactDetailsRequired** (boolean) - Indicates if emergency contact details are required.
- **employingEntityId** (int32) - Nullable - The ID of the employing entity.
- **firstName** (string) - The first name of the employee.
- **id** (int32) - Nullable - The ID of the employee if they already exist.
- **mobile** (string) - The mobile number of the employee.
- **qualificationsRequired** (boolean) - Indicates if qualifications are required.
- **surname** (string) - The surname of the employee.
- **title** (int32) - Nullable - The title of the employee.

### Response
#### Success Response (200)
OK

#### Error Response
- **404** - Not Found: Indicates a problem with the provided resources.
```

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

### Get Satisfaction Survey Results

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

Retrieves the current Employee Satisfaction Survey results. This method returns the latest survey value and the start date of the week it pertains to.

```APIDOC
## GET /esssatisfactionsurvey

### Description
Retrieves the current Employee Satisfaction Survey results.

### Method
GET

### Endpoint
/esssatisfactionsurvey

### Response
#### Success Response (200)
- **value** (string) - EmployeeSatisfactionValue Possible values are: `NotSet`, `Happy`, `Neutral`, `Sad`.
- **weekStartDate** (date-time) - DateTime
```

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

### Initiate Employee Self Setup

Source: https://api.keypay.com.au/new-zealand/resources/nzinitiateemployeeonboardingapimodel.html

Initiates the employee self-setup process. This method allows for the creation of a new employee record and the commencement of their onboarding journey.

```APIDOC
## POST /nz/initiateEmployeeOnboarding

### Description
Initiates the employee self-setup process. This method allows for the creation of a new employee record and the commencement of their onboarding journey.

### Method
POST

### Endpoint
/nz/initiateEmployeeOnboarding

### Request Body
- **email** (string) - Required - The email address of the employee.
- **emergencyContactDetailsRequired** (boolean) - Required - Specifies if emergency contact details are required.
- **employingEntityId** (int32) - Optional - The ID of the employing entity.
- **firstName** (string) - Required - The first name of the employee.
- **mobile** (string) - Required - The mobile number of the employee.
- **onboardingStarterType** (string) - Required - The type of onboarding starter. Possible values are: `NewStarterKiwiSaverEligible`, `NewStarterKiwiSaverIneligible`, `ExistingEmployeeKiwiStarterEligible`, `ExistingEmployeeKiwiStarterIneligible`.
- **qualificationsRequired** (boolean) - Required - Specifies if qualifications are required.
- **surname** (string) - Required - The surname of the employee.
- **title** (int32) - Optional - The title of the employee.

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

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

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

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

### Making Authenticated API Requests

Source: https://api.keypay.com.au/australia/guides/OAuth2.html

Include the obtained access token in the 'Authorization: Bearer' header for all API requests. This example shows a GET request to the user endpoint.

```http
GET /api/v2/user HTTP/1.1
Host: api.yourpayroll.com.au
Authorization: Bearer 1/fFBGRNJru1FQd44AzqT3Zg


```

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

### Initiate Employee Self Setup

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

Initiates the self-setup process for an employee. If an employee record exists, its ID should be provided. Email and mobile will be updated if they differ from the existing record. 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 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}/manager/employeeonboarding/initiateselfservice

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

#### 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** - 

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

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

### Get ESS Employee Details

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

Retrieves the Employee Self Setup (ESS) details for a given employee ID. This endpoint is useful for accessing an employee's self-setup information.

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

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

### Method
GET

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

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

### Response
#### Success Response (200)
- **EssEmployeeDetailsModel** - Contains the ESS details for the employee.
```

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

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

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

Initiates the self-service setup process for an employee. If the employee has an existing record, their ID should be provided. If the email and mobile number differ from the existing record, they will be updated. For new employees, omit the ID to create a new record.

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

### Description
Initiates the self-service setup process for an employee. If the employee has an existing 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 - 

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

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

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

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

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

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

Initiates the self-setup process for an employee. If an employee ID is provided, the existing record is updated. If not, a new employee record is created with the provided details. Email and mobile numbers will be updated if they differ from the existing record.

```APIDOC
## POST /api/v2/business/{businessId}/manager/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}/manager/employeeonboarding/initiateselfservice

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

#### 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

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

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

### Get Employee Roster Shifts

Source: https://api.keypay.com.au/singapore/reference/employee-self-setup/sg-ess-shift--get-shifts.html

Retrieves a list of an employee's roster shifts within a specified date range. Requires the employee's ID and the start and end dates for the query.

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

### Description
Gets the employee's roster shifts within the date range.

### Method
GET

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

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

#### Query Parameters
- **fromDate** (date-time) - Optional - The start date for the shift range.
- **toDate** (date-time) - Optional - The end date for the shift range.

### Response
#### Success Response (200)
- **SgEssRosterShiftModel** - The model representing the roster shifts.
```

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

### GET /api/v2/business/{businessId}/report/p60/{employeeId}

Source: https://api.keypay.com.au/united-kingdom/reference/reporting/uk-reports-p60--get.html

Fetches the P60 summary for a given employee. Requires business and employee IDs. Optional filters include location ID, start date, and end date.

```APIDOC
## GET /api/v2/business/{businessId}/report/p60/{employeeId}

### Description
Retrieves the P60 summary for a specific employee within a business.

### Method
GET

### Endpoint
/api/v2/business/{businessId}/report/p60/{employeeId}

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

#### Query Parameters
- **locationId** (int32) - Optional - The ID of the location to filter by.
- **startDate** (date-time) - Optional - The start date for the reporting period.
- **endDate** (date-time) - Optional - The end date for the reporting period.

### Response
#### Success Response (200)
- **UkP60SummaryForEmployeeDto** - The P60 summary data for the employee.
```

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

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

Source: https://api.keypay.com.au/malaysia/reference/manager.html

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

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

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

### Method
POST

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

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

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

### Initiate Employee Self Setup

Source: https://api.keypay.com.au/singapore/resources/sginitiateemployeeonboardingapimodel.html

Initiates the employee self-setup process. This method allows for the creation of a new employee record with essential details.

```APIDOC
## POST /employees/self-setup

### Description
Initiates the employee self-setup process by creating a new employee record with provided details.

### Method
POST

### Endpoint
/employees/self-setup

### 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.
- **mobile** (string) - Required - The employee's mobile number.
- **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",
  "mobile": "+1234567890",
  "qualificationsRequired": false,
  "surname": "Doe",
  "title": 1
}

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

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

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

### post - Get Shift Periods for Employee

Source: https://api.keypay.com.au/singapore/resources/getshiftperiodsmodel.html

Retrieves the first and last shift start times for a given employee. This method is useful for understanding an employee's work schedule within a specified period.

```APIDOC
## post Get Shift Periods for Employee

### Description
Retrieves the first and last shift start times for an employee.

### Method
POST

### Endpoint
/getShiftPeriodsModel

### Request Body
```json
{
    "firstShiftStartTime": "date-time",
    "lastShiftStartTime": "date-time"
}
```

### Response
#### Success Response (200)
- **firstShiftStartTime** (date-time) - Nullable
- **lastShiftStartTime** (date-time) - Nullable
```

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

### Initiate Employee Self Setup

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

Initiates the self-setup process for an employee. If an employee ID is provided and matches an existing record, the employee's details (email, mobile) will be updated. If no ID is provided, a new employee record will be created.

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

### Description
Initiates the self-setup process for an employee. If the employee has an existing record, the ID should be specified. If the provided email and mobile do not match the employee record, they will be updated. If the employee does not have a record, one will be created with the provided details.

### Method
POST

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

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

#### Request Body
- **email** (string) - The email address of the employee.
- **emergencyContactDetailsRequired** (boolean) - Indicates if emergency contact details are required.
- **firstName** (string) - The first name of the employee.
- **id** (int32) - Nullable - The ID of the employee. If not provided, a new employee record will be created.
- **mobile** (string) - The mobile number of the employee.
- **qualificationsRequired** (boolean) - Indicates if qualifications are required.
- **surname** (string) - The surname of the employee.
- **title** (int32) - Nullable - The title of the employee.

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

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

### Estimate Leave Hours API Endpoint

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

This GET request estimates the number of leave hours required. It requires the employee ID in the path and leave category, start date, and end date as query parameters.

```http
GET http:///api/v2/ess/{employeeId}/leave/estimate
```

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

### Get Initial Service Date

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

Retrieves the initial service date for a specified employee's pay condition comparison. This endpoint is useful for understanding an employee's tenure or eligibility based on their start date within the system.

```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.
```

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

### Initiate Employee Self Setup

Source: https://api.keypay.com.au/malaysia/resources/myinitiateemployeeonboardingapimodel.html

Initiates the employee self-setup process. This method allows for the creation of a new employee record and triggers the onboarding workflow.

```APIDOC
## POST /employees/initiate

### Description
Initiates the employee self-setup process. This method allows for the creation of a new employee record and triggers the onboarding workflow.

### Method
POST

### Endpoint
/employees/initiate

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

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

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

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

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

### Get Shift Periods for Employee

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

Retrieves the shift periods for a specified employee within a given date range. This endpoint requires the business ID and employee ID, and accepts a request body to define the start and end times for the shift period search.

```APIDOC
## POST /api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftperiods

### Description
Gets the shift periods for the specified employee.

### Method
POST

### Endpoint
/api/v2/business/{businessId}/employee/{employeeId}/timesheet/shiftperiods

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

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

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

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

### 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, the existing record is updated; otherwise, a new record is created. Email and mobile numbers can also be updated.

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

### Description
Initiates the self-setup process for an employee. If an employee ID is provided, the existing record is updated; otherwise, a new record is created. Email and mobile numbers can also be updated.

### Method
POST

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

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

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

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

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

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

### Employee Self Setup

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

Endpoints for initiating employee self-setup.

```APIDOC
## POST /employees/self-setup/initiate

### Description
Initiates the employee self-setup process.

### Method
POST

### Endpoint
/employees/self-setup/initiate
```

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

### Get Employee Details Report (GET)

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

Retrieves employee details using a GET request for a specified business.

```HTTP
GET /api/v2/business/{businessId}/report/employeedetails
```

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

### Single Sign On (General)

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

Initiate general Single Sign-On.

```APIDOC
## Single Sign On (General)

### Description
Initiate general Single Sign-On.

### Method
POST

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

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

### Initiate Employee Self Service

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

Initiates the employee self-setup process for onboarding.

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

### Description
Initiates the employee self-setup process for onboarding.

### Method
POST

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

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

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

### Install Award

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

Installs a specific version of an award package. This operation allows for granular control over which settings are preserved or updated during the installation process.

```APIDOC
## PUT /awards/{id}/install

### Description
Installs a specific version of an award package.

### Method
PUT

### Endpoint
/awards/{id}/install

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the award to install.

#### 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 period.
- **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 text.)

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

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

### Award Install Request Body

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

The request body for the award installation operation. It includes various settings to preserve or update during the installation process.

```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"
}
```

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

### 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
```

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

### Single Sign On (Global)

Source: https://api.keypay.com.au/singapore/reference.html

Initiate Single Sign-On globally.

```APIDOC
## POST /api/v2/singlesignon

### Description
Initiate Single Sign-On globally.

### Method
POST

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

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

### Start Approval Process API Endpoint

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

Use this POST request to initiate the approval process for a specific pay run. Ensure you replace placeholder values with your actual business and pay run IDs.

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

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

### 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.
```