SynergiTech\Staffology\PensionApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
createPension()	POST /employers/{employerId}/employees/{employeeId}/pension	Create Pension
getDeprecatedPension()	GET /employers/{employerId}/employees/{employeeId}/pension	Get Pension (deprecated)
getPension()	GET /employers/{employerId}/employees/{employeeId}/pension/{id}	Get Pension
lastPayRunEntryWithPensionYtdValuesForEmployeePension()	GET /employers/{employerId}/employees/{employeeId}/pension/{pensionUniqueId}/{taxYear}/pensionytd	Get last PayRunEntry for a Pension (deprecated)
listPension()	GET /employers/{employerId}/employees/{employeeId}/pension/list	List Pensions
removeDeprecatedPension()	DELETE /employers/{employerId}/employees/{employeeId}/pension	Remove Pension (deprecated)
removePension()	DELETE /employers/{employerId}/employees/{employeeId}/pension/{id}	Remove Pension
updateDeprecatedPension()	PUT /employers/{employerId}/employees/{employeeId}/pension	Update Pension (deprecated)
updatePension()	PUT /employers/{employerId}/employees/{employeeId}/pension/{id}	Update Pension

`createPension()`

createPension($employerId, $employeeId, $pension): \SynergiTech\Staffology\Model\Pension

Create Pension

Creates a Pension for an Employee.

Example

<?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\PensionApi(
    // 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 for which you want to create a Pension
$pension = new \SynergiTech\Staffology\Model\Pension(); // \SynergiTech\Staffology\Model\Pension

try {
    $result = $apiInstance->createPension($employerId, $employeeId, $pension);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PensionApi->createPension: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Employee belongs
employeeId	string	The Id of the Employee for which you want to create a Pension
pension	\SynergiTech\Staffology\Model\Pension		[optional]

Return type

\SynergiTech\Staffology\Model\Pension

Authorization

Basic

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getDeprecatedPension()`

getDeprecatedPension($employerId, $employeeId): \SynergiTech\Staffology\Model\Pension

Get Pension (deprecated)

This endpoint is now deprecated. You should use the alternative end points that require an ID to be specified. Until it is removed, this endpoint will work only for employees with a single pension Returns the Pension, if any, for an Employee

Example

<?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\PensionApi(
    // 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 for which you want to retrieve the Pension

try {
    $result = $apiInstance->getDeprecatedPension($employerId, $employeeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PensionApi->getDeprecatedPension: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Employee belongs
employeeId	string	The Id of the Employee for which you want to retrieve the Pension

Return type

\SynergiTech\Staffology\Model\Pension

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getPension()`

getPension($employerId, $employeeId, $id): \SynergiTech\Staffology\Model\Pension

Get Pension

Returns a Pension for an Employee

Example

<?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\PensionApi(
    // 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 for which you want to retrieve the Pension
$id = 'id_example'; // string | The Id of the Pension

try {
    $result = $apiInstance->getPension($employerId, $employeeId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PensionApi->getPension: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
employerId	string	The Id of the Employer to which the Employee belongs
employeeId	string	The Id of the Employee for which you want to retrieve the Pension
id	string	The Id of the Pension

Return type

\SynergiTech\Staffology\Model\Pension

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`lastPayRunEntryWithPensionYtdValuesForEmployeePension()`

lastPayRunEntryWithPensionYtdValuesForEmployeePension($employerId, $employeeId, $pensionUniqueId, $taxYear): \SynergiTech\Staffology\Model\PayRunEntry

Get last PayRunEntry for a Pension (deprecated)

This endpoint is now deprecated. You should use the alternative GET end point from PayRun Gets a last PayRunEntry for a Pension.

Example

<?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\PensionApi(
    // 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 you want to get pay run entry for
$pensionUniqueId = 'pensionUniqueId_example'; // string
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear

try {
    $result = $apiInstance->lastPayRunEntryWithPensionYtdValuesForEmployeePension($employerId, $employeeId, $pensionUniqueId, $taxYear);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PensionApi->lastPayRunEntryWithPensionYtdValuesForEmployeePension: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
employerId	string	The Id of the Employer to which the Employee belongs
employeeId	string	The Id of the Employee you want to get pay run entry for
pensionUniqueId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear

Return type

\SynergiTech\Staffology\Model\PayRunEntry

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listPension()`

listPension($employerId, $employeeId): \SynergiTech\Staffology\Model\Item[]

List Pensions

Returns a list of Item representing any Pensions for the given employee

Example

<?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\PensionApi(
    // 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 for which you want to list Pensions

try {
    $result = $apiInstance->listPension($employerId, $employeeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PensionApi->listPension: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Employee belongs
employeeId	string	The Id of the Employee for which you want to list Pensions

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`removeDeprecatedPension()`

removeDeprecatedPension($employerId, $employeeId)

Remove Pension (deprecated)

This endpoint is now deprecated. You should use the alternative end points that require an ID to be specified. Until it is removed, this endpoint will work only for employees with a single pension Removes the Pension for an Employee. For AE Pensions this will remove the employee from the pension and delete any associated AeAssessments

Example

<?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\PensionApi(
    // 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 for which you want to remove the Pension

try {
    $apiInstance->removeDeprecatedPension($employerId, $employeeId);
} catch (Exception $e) {
    echo 'Exception when calling PensionApi->removeDeprecatedPension: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Employee belongs
employeeId	string	The Id of the Employee for which you want to remove the Pension

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`removePension()`

removePension($employerId, $employeeId, $id)

Remove Pension

Removes a Pension for an Employee.

Example

<?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\PensionApi(
    // 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 for which you want to remove the Pension
$id = 'id_example'; // string | The Id of the Pension

try {
    $apiInstance->removePension($employerId, $employeeId, $id);
} catch (Exception $e) {
    echo 'Exception when calling PensionApi->removePension: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
employerId	string	The Id of the Employer to which the Employee belongs
employeeId	string	The Id of the Employee for which you want to remove the Pension
id	string	The Id of the Pension

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateDeprecatedPension()`

updateDeprecatedPension($employerId, $employeeId, $pension): \SynergiTech\Staffology\Model\Pension

Update Pension (deprecated)

This endpoint is now deprecated. You should use the alternative end points that require an ID to be specified. Until it is removed, this endpoint will work only for employees with a single pension Updates the Pension for an Employee.

Example

<?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\PensionApi(
    // 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 for which you want to update the Pension
$pension = new \SynergiTech\Staffology\Model\Pension(); // \SynergiTech\Staffology\Model\Pension

try {
    $result = $apiInstance->updateDeprecatedPension($employerId, $employeeId, $pension);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PensionApi->updateDeprecatedPension: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Employee belongs
employeeId	string	The Id of the Employee for which you want to update the Pension
pension	\SynergiTech\Staffology\Model\Pension		[optional]

Return type

\SynergiTech\Staffology\Model\Pension

Authorization

Basic

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updatePension()`

updatePension($employerId, $employeeId, $id, $pension): \SynergiTech\Staffology\Model\Pension

Update Pension

Updates the Pension for an Employee.

Example

<?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\PensionApi(
    // 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 for which you want to update the Pension
$id = 'id_example'; // string | The Id of the Pension
$pension = new \SynergiTech\Staffology\Model\Pension(); // \SynergiTech\Staffology\Model\Pension

try {
    $result = $apiInstance->updatePension($employerId, $employeeId, $id, $pension);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling PensionApi->updatePension: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer to which the Employee belongs
employeeId	string	The Id of the Employee for which you want to update the Pension
id	string	The Id of the Pension
pension	\SynergiTech\Staffology\Model\Pension		[optional]

Return type

\SynergiTech\Staffology\Model\Pension

Authorization

Basic

HTTP request headers

Content-Type: application/json-patch+json, application/json, text/json, application/*+json
Accept: text/plain, application/json, text/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

PensionApi.md

Latest commit

History

PensionApi.md

File metadata and controls

SynergiTech\Staffology\PensionApi

createPension()

Example

Parameters

Return type

Authorization

HTTP request headers

getDeprecatedPension()

Example

Parameters

Return type

Authorization

HTTP request headers

getPension()

Example

Parameters

Return type

Authorization

HTTP request headers

lastPayRunEntryWithPensionYtdValuesForEmployeePension()

Example

Parameters

Return type

Authorization

HTTP request headers

listPension()

Example

Parameters

Return type

Authorization

HTTP request headers

removeDeprecatedPension()

Example

Parameters

Return type

Authorization

HTTP request headers

removePension()

Example

Parameters

Return type

Authorization

HTTP request headers

updateDeprecatedPension()

Example

Parameters

Return type

Authorization

HTTP request headers

updatePension()

Example

Parameters

Return type

Authorization

HTTP request headers

`createPension()`

`getDeprecatedPension()`

`getPension()`

`lastPayRunEntryWithPensionYtdValuesForEmployeePension()`

`listPension()`

`removeDeprecatedPension()`

`removePension()`

`updateDeprecatedPension()`

`updatePension()`