All URIs are relative to http://localhost, except if the operation defines another base path.
| Method | HTTP request | Description |
|---|---|---|
| assessAeEmployeeAssessment() | POST /employers/{employerId}/aeassessments/employees/{employeeId}/assess | Process AE Assessment for Employee during PayRun |
| createAeEmployeeAssessmentAeEmployeeAssessment() | POST /employers/{employerId}/aeassessments/employees/{employeeId}/create | Create employee auto enrolment assessment |
| emailAeLetterAeEmployeeAssessment() | POST /employers/{employerId}/aeassessments/employees/{employeeId}/{id}/letter/email | Email AeLetter |
| getAeEmployeeAssessmentsAeEmployeeAssessment() | GET /employers/{employerId}/aeassessments/employees/{employeeId}/aeEmployeeAssessments | List employee auto enrolment assessment |
| getAeLetterAeEmployeeAssessment() | GET /employers/{employerId}/aeassessments/employees/{employeeId}/{id}/letter | Get AeLetter |
| getEmployeeAeAssessmentsHistoryAeEmployeeAssessment() | GET /employers/{employerId}/aeassessments/employees/{employeeId}/assessments | Get Ae Assessments for an employee. |
| getEmployeeLettersAeEmployeeAssessment() | GET /employers/{employerId}/aeassessments/employees/{employeeId}/letters/{taxYear} | Get letters for an employee based on tax year |
| getLatestAeEmployeeAssessmentByRoleAeEmployeeAssessment() | GET /employers/{employerId}/aeassessments/employees/{employeeId}/aeEmployeeAssessments/roles/{employeeRoleId} | Gets employee AE assessment for a specific role. |
| getPendingLettersAeEmployeeAssessment() | GET /employers/{employerId}/aeassessments/letters/pending | Get pending letters for an employer |
| getPendingLettersCountAeEmployeeAssessment() | GET /employers/{employerId}/aeassessments/letters/pending/count | Get count of pending pension letters for an employer |
| getReenrolmentDatesAeEmployeeAssessment() | GET /employers/{employerId}/aeassessments/reenrolmentdates | Gets a list of re-enrolment dates for the employer |
| markAeLetterAsSentAeEmployeeAssessment() | PUT /employers/{employerId}/aeassessments/employees/{employeeId}/{id}/letter/sent | Mark Letter as Sent |
| markAeLettersAsSentAeEmployeeAssessment() | PUT /employers/{employerId}/aeassessments/letters/sent | Mark All Letters as Sent |
assessAeEmployeeAssessment($employerId, $employeeId, $payRunId): \SynergiTech\Staffology\Model\ContractAeEmployeeAssessmentHistoryResponse[]Process AE Assessment for Employee during PayRun
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer
$employeeId = 'employeeId_example'; // string | The Id of the Employee
$payRunId = 'payRunId_example'; // string | The Id of the PayRun being assessed
try {
$result = $apiInstance->assessAeEmployeeAssessment($employerId, $employeeId, $payRunId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->assessAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer | |
| employeeId | string | The Id of the Employee | |
| payRunId | string | The Id of the PayRun being assessed | [optional] |
\SynergiTech\Staffology\Model\ContractAeEmployeeAssessmentHistoryResponse[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
createAeEmployeeAssessmentAeEmployeeAssessment($employerId, $employeeId, $contractAeEmployeeAssessmentHistoryRequest): mixedCreate employee auto enrolment assessment
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer
$employeeId = 'employeeId_example'; // string | The Id of the Employee
$contractAeEmployeeAssessmentHistoryRequest = new \SynergiTech\Staffology\Model\ContractAeEmployeeAssessmentHistoryRequest(); // \SynergiTech\Staffology\Model\ContractAeEmployeeAssessmentHistoryRequest | The request containing all data required for the employee assessment
try {
$result = $apiInstance->createAeEmployeeAssessmentAeEmployeeAssessment($employerId, $employeeId, $contractAeEmployeeAssessmentHistoryRequest);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->createAeEmployeeAssessmentAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer | |
| employeeId | string | The Id of the Employee | |
| contractAeEmployeeAssessmentHistoryRequest | \SynergiTech\Staffology\Model\ContractAeEmployeeAssessmentHistoryRequest | The request containing all data required for the employee assessment | [optional] |
mixed
- Content-Type:
application/*+json,application/json,application/json-patch+json,text/json - Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
emailAeLetterAeEmployeeAssessment($employerId, $employeeId, $id): \SynergiTech\Staffology\Model\EmployerEmailEmail AeLetter
Send via email letter that needs to be sent to an employee as a result of the assessment.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer to which the Employee belongs
$employeeId = 'employeeId_example'; // string | The Id of the Employee the assessment is for
$id = 'id_example'; // string | The Id of the AeEmployeeAssessmentHistory
try {
$result = $apiInstance->emailAeLetterAeEmployeeAssessment($employerId, $employeeId, $id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->emailAeLetterAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer to which the Employee belongs | |
| employeeId | string | The Id of the Employee the assessment is for | |
| id | string | The Id of the AeEmployeeAssessmentHistory |
\SynergiTech\Staffology\Model\EmployerEmail
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAeEmployeeAssessmentsAeEmployeeAssessment($employerId, $employeeId): \SynergiTech\Staffology\Model\ContractAeEmployeeAssessmentHistoryResponse[]List employee auto enrolment assessment
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer
$employeeId = 'employeeId_example'; // string | The Id of the Employee
try {
$result = $apiInstance->getAeEmployeeAssessmentsAeEmployeeAssessment($employerId, $employeeId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->getAeEmployeeAssessmentsAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer | |
| employeeId | string | The Id of the Employee |
\SynergiTech\Staffology\Model\ContractAeEmployeeAssessmentHistoryResponse[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getAeLetterAeEmployeeAssessment($employerId, $employeeId, $id, $accept): \SynergiTech\Staffology\Model\ReportResponseGet AeLetter
Returns PDF letter that needs to be sent to an employee as a result of the assessment. The same ReportResponse model that is used for reports is used here.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer to which the Employee belongs
$employeeId = 'employeeId_example'; // string | The Id of the Employee the assessment is for
$id = 'id_example'; // string | The Id of the Assessment
$accept = 'accept_example'; // string
try {
$result = $apiInstance->getAeLetterAeEmployeeAssessment($employerId, $employeeId, $id, $accept);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->getAeLetterAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer to which the Employee belongs | |
| employeeId | string | The Id of the Employee the assessment is for | |
| id | string | The Id of the Assessment | |
| accept | string | [optional] |
\SynergiTech\Staffology\Model\ReportResponse
- Content-Type: Not defined
- Accept:
application/json,application/octet-stream,application/pdf,text/html
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getEmployeeAeAssessmentsHistoryAeEmployeeAssessment($employerId, $employeeId): \SynergiTech\Staffology\Model\AeEmployeeAssessment[]Get Ae Assessments for an employee.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer
$employeeId = 'employeeId_example'; // string | The Id of the Employee
try {
$result = $apiInstance->getEmployeeAeAssessmentsHistoryAeEmployeeAssessment($employerId, $employeeId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->getEmployeeAeAssessmentsHistoryAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer | |
| employeeId | string | The Id of the Employee |
\SynergiTech\Staffology\Model\AeEmployeeAssessment[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getEmployeeLettersAeEmployeeAssessment($employerId, $employeeId, $taxYear): \SynergiTech\Staffology\Model\ContractAeEmployeeLetterResponse[]Get letters for an employee based on tax year
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer
$employeeId = 'employeeId_example'; // string | The Id of the Employee
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear | The TaxYear for which you want to list the pension letters
try {
$result = $apiInstance->getEmployeeLettersAeEmployeeAssessment($employerId, $employeeId, $taxYear);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->getEmployeeLettersAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer | |
| employeeId | string | The Id of the Employee | |
| taxYear | \SynergiTech\Staffology\Model\TaxYear | The TaxYear for which you want to list the pension letters |
\SynergiTech\Staffology\Model\ContractAeEmployeeLetterResponse[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getLatestAeEmployeeAssessmentByRoleAeEmployeeAssessment($employerId, $employeeId, $employeeRoleId): \SynergiTech\Staffology\Model\ContractAeEmployeeAssessmentHistoryResponseGets employee AE assessment for a specific role.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer
$employeeId = 'employeeId_example'; // string | The Id of the Employee
$employeeRoleId = 'employeeRoleId_example'; // string | The Id of the Employee Role
try {
$result = $apiInstance->getLatestAeEmployeeAssessmentByRoleAeEmployeeAssessment($employerId, $employeeId, $employeeRoleId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->getLatestAeEmployeeAssessmentByRoleAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer | |
| employeeId | string | The Id of the Employee | |
| employeeRoleId | string | The Id of the Employee Role |
\SynergiTech\Staffology\Model\ContractAeEmployeeAssessmentHistoryResponse
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getPendingLettersAeEmployeeAssessment($employerId): \SynergiTech\Staffology\Model\ContractAeEmployeeLetterResponse[]Get pending letters for an employer
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer
try {
$result = $apiInstance->getPendingLettersAeEmployeeAssessment($employerId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->getPendingLettersAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer |
\SynergiTech\Staffology\Model\ContractAeEmployeeLetterResponse[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getPendingLettersCountAeEmployeeAssessment($employerId): intGet count of pending pension letters for an employer
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer
try {
$result = $apiInstance->getPendingLettersCountAeEmployeeAssessment($employerId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->getPendingLettersCountAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer |
int
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
getReenrolmentDatesAeEmployeeAssessment($employerId): \DateTime[]Gets a list of re-enrolment dates for the employer
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer
try {
$result = $apiInstance->getReenrolmentDatesAeEmployeeAssessment($employerId);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->getReenrolmentDatesAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer |
\DateTime[]
- Content-Type: Not defined
- Accept:
application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
markAeLetterAsSentAeEmployeeAssessment($employerId, $employeeId, $id)Mark Letter as Sent
Update an Assessment to mark the letter as sent. This is done automatically if you send the letter via email so you'd only need to use this is you are printing/posting the letter.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer to which the Employee belongs
$employeeId = 'employeeId_example'; // string | The Id of the Employee the assessment is for
$id = 'id_example'; // string | The Id of the Assessment
try {
$apiInstance->markAeLetterAsSentAeEmployeeAssessment($employerId, $employeeId, $id);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->markAeLetterAsSentAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer to which the Employee belongs | |
| employeeId | string | The Id of the Employee the assessment is for | |
| id | string | The Id of the Assessment |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]
markAeLettersAsSentAeEmployeeAssessment($employerId)Mark All Letters as Sent
Update an Assessments to mark all the letter as sent. This is done automatically if you send the letter via email so you'd only need to use this is you are printing/posting the letter.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure HTTP basic authorization: Basic
$config = SynergiTech\Staffology\Configuration::getDefaultConfiguration()
->setUsername('YOUR_USERNAME')
->setPassword('YOUR_PASSWORD');
$apiInstance = new SynergiTech\Staffology\Api\AeEmployeeAssessmentApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$employerId = 'employerId_example'; // string | The Id of the Employer to which the Employee belongs
try {
$apiInstance->markAeLettersAsSentAeEmployeeAssessment($employerId);
} catch (Exception $e) {
echo 'Exception when calling AeEmployeeAssessmentApi->markAeLettersAsSentAeEmployeeAssessment: ', $e->getMessage(), PHP_EOL;
}| Name | Type | Description | Notes |
|---|---|---|---|
| employerId | string | The Id of the Employer to which the Employee belongs |
void (empty response body)
- Content-Type: Not defined
- Accept: Not defined
[Back to top] [Back to API list] [Back to Model list] [Back to README]