SynergiTech\Staffology\EmployerApi

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

Method	HTTP request	Description
applyYearEndEmployer()	PUT /employers/{id}/YearEnd	Make Year End Changes
calendarEmployer()	GET /employers/{id}/calendar	Get Employer Calendar
createEmployer()	POST /employers	Create an Employer
customPayslipEmployer()	GET /employers/{id}/custompayslip	Get Payslip Customisations
deleteEmployer()	DELETE /employers/{id}	Delete an Employer
getAutomationSettingsEmployer()	GET /employers/{id}/automation	Get Automation Settings
getEmployeesWithAccrualHolidaySchemeEmployer()	GET /employers/{id}/accrual-holiday-scheme/employee	Get List of Employees with Holiday Accrual Scheme
getEmployer()	GET /employers/{id}	Get an Employer
getEmployerOpeningBalancesEmployer()	GET /employers/{id}/openingbalances	Get EmployerOpeningBalances
getEvcOptInHistoryEmployer()	GET /employers/{id}/evc	Get EVC OptIn History
getGroupMembershipsEmployer()	GET /employers/{id}/groups	Get Employer Groups
getReenrolmentStatusEmployer()	GET /employers/reenrolmentstatus	Gets the re-enrolment status for the employer
getUserEmployerEmployer()	GET /employers/{id}/users/userEmployer	Get User Employer
importCsvEmployer()	POST /employers/import	Import CSV
indexEmployer()	GET /employers	List Employers
listUsersEmployer()	GET /employers/{id}/users	List Users
removeUserEmployer()	DELETE /employers/{id}/users/{userId}	Remove User
reviewYearEndEmployer()	GET /employers/{id}/YearEnd	Review Year End Changes
rtiRequiringAttentionEmployer()	GET /employers/{id}/rti/requiringattention	RTI Documents Requiring Attention
searchEmployeesEmployer()	GET /employers/employees/search	Search Employees
searchEmployer()	GET /employers/search	Search Employers
setEvcOptInEmployer()	PUT /employers/{id}/evc	Update EVC OptIn
setGroupMembershipsEmployer()	PUT /employers/{id}/groups	Set Employer Groups
setOwnerEmployer()	PUT /employers/{id}/users/owner	Set Owner
suggestPayCodeEmployer()	GET /employers/{id}/suggestPayrollCode	Suggest Payroll Code
updateAutomationSettingsEmployer()	PUT /employers/{id}/automation	Update Automation Settings
updateCustomPayslipEmployer()	POST /employers/{id}/custompayslip	Update Payslip Customisations
updateEmployer()	PUT /employers/{id}	Update an Employer
updateEmployerCanUsePremiumConnectorsEmployer()	PUT /employers/{id}/can-use-premium-connectors	Update Can Use Premium Connectors Setting
updateEmployerOpeningBalancesEmployer()	PUT /employers/{id}/openingbalances	Update EmployerOpeningBalances
updateLogoEmployer()	POST /employers/{id}/logo	Update Employer Logo

`applyYearEndEmployer()`

applyYearEndEmployer($id, $requestBody): \SynergiTech\Staffology\Model\YearEnd

Make Year End Changes

Apply the changes for the year end and start the next tax year for the employer.

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer
$requestBody = NULL; // array<string,mixed> | You can suppress the emailing of P60s and/or CIS Statements by supplying a value of true for dontEmailP60s and/or dontEmailCisStatements

try {
    $result = $apiInstance->applyYearEndEmployer($id, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->applyYearEndEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer
requestBody	array<string,mixed>	You can suppress the emailing of P60s and/or CIS Statements by supplying a value of true for dontEmailP60s and/or dontEmailCisStatements	[optional]

Return type

\SynergiTech\Staffology\Model\YearEnd

Authorization

Basic

HTTP request headers

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]

`calendarEmployer()`

calendarEmployer($id, $from, $to): \SynergiTech\Staffology\Model\CalendarEntry[]

Get Employer Calendar

Get a list of upcoming CalendarEntry for the Employer.

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer.
$from = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$to = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime

try {
    $result = $apiInstance->calendarEmployer($id, $from, $to);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->calendarEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer.
from	\DateTime		[optional]
to	\DateTime		[optional]

Return type

\SynergiTech\Staffology\Model\CalendarEntry[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`createEmployer()`

createEmployer($contractEmployerRequest): \SynergiTech\Staffology\Model\ContractEmployerResponse

Create an Employer

Use this method to create a new Employer The only required field is the Employer name.

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\EmployerApi(
    // 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
);
$contractEmployerRequest = new \SynergiTech\Staffology\Model\ContractEmployerRequest(); // \SynergiTech\Staffology\Model\ContractEmployerRequest

try {
    $result = $apiInstance->createEmployer($contractEmployerRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->createEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
contractEmployerRequest	\SynergiTech\Staffology\Model\ContractEmployerRequest		[optional]

Return type

\SynergiTech\Staffology\Model\ContractEmployerResponse

Authorization

Basic

HTTP request headers

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]

`customPayslipEmployer()`

customPayslipEmployer($id): \SynergiTech\Staffology\Model\PayslipCustomisation

Get Payslip Customisations

Get the settings used to customise PaySlips for this Employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want customisations for.

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want customisations for.

Return type

\SynergiTech\Staffology\Model\PayslipCustomisation

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`deleteEmployer()`

deleteEmployer($id)

Delete an Employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to delete.

try {
    $apiInstance->deleteEmployer($id);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->deleteEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to delete.

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]

`getAutomationSettingsEmployer()`

getAutomationSettingsEmployer($id): \SynergiTech\Staffology\Model\AutomationSettings

Get Automation Settings

Returns the AutomationSettings for the Employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer

Return type

\SynergiTech\Staffology\Model\AutomationSettings

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getEmployeesWithAccrualHolidaySchemeEmployer()`

getEmployeesWithAccrualHolidaySchemeEmployer($id): \SynergiTech\Staffology\Model\Item[]

Get List of Employees with Holiday Accrual Scheme

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getEmployer()`

getEmployer($id): \SynergiTech\Staffology\Model\ContractEmployerResponse

Get an Employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to retrieve.

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to retrieve.

Return type

\SynergiTech\Staffology\Model\ContractEmployerResponse

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getEmployerOpeningBalancesEmployer()`

getEmployerOpeningBalancesEmployer($id): \SynergiTech\Staffology\Model\EmployerOpeningBalances

Get EmployerOpeningBalances

Returns the EmployerOpeningBalances for the Employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer

Return type

\SynergiTech\Staffology\Model\EmployerOpeningBalances

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getEvcOptInHistoryEmployer()`

getEvcOptInHistoryEmployer($id): \SynergiTech\Staffology\Model\EmployerEvcOptInHistory[]

Get EVC OptIn History

Gets the history of changes to the EVC OptIn setting for the employer.

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer

Return type

\SynergiTech\Staffology\Model\EmployerEvcOptInHistory[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getGroupMembershipsEmployer()`

getGroupMembershipsEmployer($id): \SynergiTech\Staffology\Model\EmployerGroupMembership[]

Get Employer Groups

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to retrieve Groups for.

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to retrieve Groups for.

Return type

\SynergiTech\Staffology\Model\EmployerGroupMembership[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getReenrolmentStatusEmployer()`

getReenrolmentStatusEmployer($id): \SynergiTech\Staffology\Model\ReenrolmentStatus

Gets the re-enrolment status for the employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	string		[optional]

Return type

\SynergiTech\Staffology\Model\ReenrolmentStatus

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`getUserEmployerEmployer()`

getUserEmployerEmployer($id): \SynergiTech\Staffology\Model\UserEmployer

Get User Employer

Returns a UserEmployer for the given Employer Id

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to get the User from.

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to get the User from.

Return type

\SynergiTech\Staffology\Model\UserEmployer

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`importCsvEmployer()`

importCsvEmployer($previewOnly, $file): \SynergiTech\Staffology\Model\Item[]

Import CSV

Import employers from a CSV file.

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\EmployerApi(
    // 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
);
$previewOnly = false; // bool | Set to true and nothing will be imported but you'll be shown a preview of the data.
$file = '/path/to/file.txt'; // \SplFileObject

try {
    $result = $apiInstance->importCsvEmployer($previewOnly, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->importCsvEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
previewOnly	bool	Set to true and nothing will be imported but you'll be shown a preview of the data.	[optional] [default to false]
file	\SplFileObject\SplFileObject		[optional]

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

`indexEmployer()`

indexEmployer($employerGroupCode, $searchTerm, $employerListType, $pageNum, $pageSize, $sortBy, $sortDescending): \SynergiTech\Staffology\Model\Item[]

List Employers

Return a list of employers with pagination options. If no pagination parameters are provided, return all applicable employers based on the search.

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\EmployerApi(
    // 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
);
$employerGroupCode = 'employerGroupCode_example'; // string | Optionally specify the code of an EmployerGroup to only see employers that are a member of that group.
$searchTerm = 'searchTerm_example'; // string | Filters the employer list by Processor Name, Employer Name, Customer #, Alt ID and Employer GUID.
$employerListType = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\EmployerListType(); // \SynergiTech\Staffology\Model\EmployerListType | Filters the employer list type.
$pageNum = 56; // int | Zero-based index indicating the current page.
$pageSize = 56; // int | Number of items per page.
$sortBy = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\EmployerSortBy(); // \SynergiTech\Staffology\Model\EmployerSortBy | Field to sort employers by.
$sortDescending = True; // bool | Indicates descending sort order.

try {
    $result = $apiInstance->indexEmployer($employerGroupCode, $searchTerm, $employerListType, $pageNum, $pageSize, $sortBy, $sortDescending);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->indexEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerGroupCode	string	Optionally specify the code of an EmployerGroup to only see employers that are a member of that group.	[optional]
searchTerm	string	Filters the employer list by Processor Name, Employer Name, Customer #, Alt ID and Employer GUID.	[optional]
employerListType	\SynergiTech\Staffology\Model\EmployerListType	Filters the employer list type.	[optional]
pageNum	int	Zero-based index indicating the current page.	[optional]
pageSize	int	Number of items per page.	[optional]
sortBy	\SynergiTech\Staffology\Model\EmployerSortBy	Field to sort employers by.	[optional]
sortDescending	bool	Indicates descending sort order.	[optional]

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`listUsersEmployer()`

listUsersEmployer($id): \SynergiTech\Staffology\Model\Item[]

List Users

Returns a list of Users that have access to the given Employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want a list of Users for.

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want a list of Users for.

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`removeUserEmployer()`

removeUserEmployer($id, $userId)

Remove User

Removes a User from an Employer. You cannot remove Users that are marked as the owner of the Employer. You must be the owner of the Employer in order to remove other Users.

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to remove the User from.
$userId = 'userId_example'; // string | The Id of the User you want to remove.

try {
    $apiInstance->removeUserEmployer($id, $userId);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->removeUserEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to remove the User from.
userId	string	The Id of the User you want to remove.

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]

`reviewYearEndEmployer()`

reviewYearEndEmployer($id): \SynergiTech\Staffology\Model\YearEnd

Review Year End Changes

View the changes that will be made when you start the next tax year for the employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer

Return type

\SynergiTech\Staffology\Model\YearEnd

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`rtiRequiringAttentionEmployer()`

rtiRequiringAttentionEmployer($id): \SynergiTech\Staffology\Model\Item[]

RTI Documents Requiring Attention

Returns all RTI documents that have a Submission Status of NotSubmitted or ErrorResponse

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`searchEmployeesEmployer()`

searchEmployeesEmployer($query, $exludeCisSubContactors): \SynergiTech\Staffology\Model\Item[]

Search Employees

Search all employers for an employee based on their name or payroll code. Ensure your query is at least 3 characters long or you wont get any results.

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\EmployerApi(
    // 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
);
$query = 'query_example'; // string | The search string (at least 3 characters).
$exludeCisSubContactors = false; // bool | If set to true, then we'll only search employees that aren't labeled as CIS Subcontractors

try {
    $result = $apiInstance->searchEmployeesEmployer($query, $exludeCisSubContactors);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->searchEmployeesEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
query	string	The search string (at least 3 characters).	[optional]
exludeCisSubContactors	bool	If set to true, then we'll only search employees that aren't labeled as CIS Subcontractors	[optional] [default to false]

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`searchEmployer()`

searchEmployer($query): \SynergiTech\Staffology\Model\Item[]

Search Employers

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\EmployerApi(
    // 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
);
$query = 'query_example'; // string

try {
    $result = $apiInstance->searchEmployer($query);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->searchEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
query	string		[optional]

Return type

\SynergiTech\Staffology\Model\Item[]

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`setEvcOptInEmployer()`

setEvcOptInEmployer($id, $body)

Update EVC OptIn

Sets the EVC OptIn setting for the employer. A boolean value needs to be sent in the body to indicate if the employer is opted in. So sending false would result in the employer being opted out.

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer
$body = True; // bool

try {
    $apiInstance->setEvcOptInEmployer($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->setEvcOptInEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer
body	bool		[optional]

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

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

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

`setGroupMembershipsEmployer()`

setGroupMembershipsEmployer($id, $employerGroupMembership): \SynergiTech\Staffology\Model\EmployerGroupMembership[]

Set Employer Groups

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to set Groups for.
$employerGroupMembership = array(new \SynergiTech\Staffology\Model\EmployerGroupMembership()); // \SynergiTech\Staffology\Model\EmployerGroupMembership[]

try {
    $result = $apiInstance->setGroupMembershipsEmployer($id, $employerGroupMembership);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->setGroupMembershipsEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to set Groups for.
employerGroupMembership	\SynergiTech\Staffology\Model\EmployerGroupMembership[]		[optional]

Return type

\SynergiTech\Staffology\Model\EmployerGroupMembership[]

Authorization

Basic

HTTP request headers

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]

`setOwnerEmployer()`

setOwnerEmployer($id, $body)

Set Owner

Sets the owner for the employer. You must be the owner of the Employer to set this value. The user you are setting as the owner must already have the role Admin. You can get a list of users from the ListUsers endpoint.

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to change the ownership of.
$body = 'body_example'; // string | The Id of the User you want a change ownership to. They must already be a user for this employer and have the admin role assigned to them.

try {
    $apiInstance->setOwnerEmployer($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->setOwnerEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to change the ownership of.
body	string	The Id of the User you want a change ownership to. They must already be a user for this employer and have the admin role assigned to them.	[optional]

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

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

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

`suggestPayCodeEmployer()`

suggestPayCodeEmployer($id): string

Suggest Payroll Code

This helper method returns a unique code for the next Employee that you create for the specified Employer. You don't have to use the value provided, you can use any value that is unique across Employees for the Employer.

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want a suggestion for.

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

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want a suggestion for.

Return type

string

Authorization

Basic

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`updateAutomationSettingsEmployer()`

updateAutomationSettingsEmployer($id, $automationSettings): \SynergiTech\Staffology\Model\AutomationSettings

Update Automation Settings

Updates the AutomationSettings for the Employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer
$automationSettings = new \SynergiTech\Staffology\Model\AutomationSettings(); // \SynergiTech\Staffology\Model\AutomationSettings

try {
    $result = $apiInstance->updateAutomationSettingsEmployer($id, $automationSettings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->updateAutomationSettingsEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer
automationSettings	\SynergiTech\Staffology\Model\AutomationSettings		[optional]

Return type

\SynergiTech\Staffology\Model\AutomationSettings

Authorization

Basic

HTTP request headers

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]

`updateCustomPayslipEmployer()`

updateCustomPayslipEmployer($id, $payslipCustomisation): \SynergiTech\Staffology\Model\PayslipCustomisation

Update Payslip Customisations

Set the settings used to customise PaySlips for this Employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want customisations for.
$payslipCustomisation = new \SynergiTech\Staffology\Model\PayslipCustomisation(); // \SynergiTech\Staffology\Model\PayslipCustomisation

try {
    $result = $apiInstance->updateCustomPayslipEmployer($id, $payslipCustomisation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->updateCustomPayslipEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want customisations for.
payslipCustomisation	\SynergiTech\Staffology\Model\PayslipCustomisation		[optional]

Return type

\SynergiTech\Staffology\Model\PayslipCustomisation

Authorization

Basic

HTTP request headers

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]

`updateEmployer()`

updateEmployer($id, $contractEmployerRequest): \SynergiTech\Staffology\Model\ContractEmployerResponse

Update an Employer

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to update.
$contractEmployerRequest = new \SynergiTech\Staffology\Model\ContractEmployerRequest(); // \SynergiTech\Staffology\Model\ContractEmployerRequest

try {
    $result = $apiInstance->updateEmployer($id, $contractEmployerRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->updateEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to update.
contractEmployerRequest	\SynergiTech\Staffology\Model\ContractEmployerRequest		[optional]

Return type

\SynergiTech\Staffology\Model\ContractEmployerResponse

Authorization

Basic

HTTP request headers

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]

`updateEmployerCanUsePremiumConnectorsEmployer()`

updateEmployerCanUsePremiumConnectorsEmployer($id, $body)

Update Can Use Premium Connectors Setting

Sets Can Use Premium Connectors Setting A boolean value needs to be sent in the body to indicate if the employer can use premium connectors. So sending false would result in the employer not being able to use the premium connectors.

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to update.
$body = True; // bool

try {
    $apiInstance->updateEmployerCanUsePremiumConnectorsEmployer($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->updateEmployerCanUsePremiumConnectorsEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to update.
body	bool		[optional]

Return type

void (empty response body)

Authorization

Basic

HTTP request headers

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

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

`updateEmployerOpeningBalancesEmployer()`

updateEmployerOpeningBalancesEmployer($id, $employerOpeningBalances): \SynergiTech\Staffology\Model\EmployerOpeningBalances

Update EmployerOpeningBalances

Updates the EmployerOpeningBalances for the Employer for their StartYear

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer
$employerOpeningBalances = new \SynergiTech\Staffology\Model\EmployerOpeningBalances(); // \SynergiTech\Staffology\Model\EmployerOpeningBalances

try {
    $result = $apiInstance->updateEmployerOpeningBalancesEmployer($id, $employerOpeningBalances);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->updateEmployerOpeningBalancesEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer
employerOpeningBalances	\SynergiTech\Staffology\Model\EmployerOpeningBalances		[optional]

Return type

\SynergiTech\Staffology\Model\EmployerOpeningBalances

Authorization

Basic

HTTP request headers

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]

`updateLogoEmployer()`

updateLogoEmployer($id, $file): \SynergiTech\Staffology\Model\ContractEmployerResponse

Update Employer Logo

If you already have a URL for the employer Logo then you can just set the LogoUrl property of the Employer. Alternatively, submit a logo here and we'll upload it and set the LogoUrl for you.

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\EmployerApi(
    // 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
);
$id = 'id_example'; // string | The Id of the Employer you want to update.
$file = '/path/to/file.txt'; // \SplFileObject

try {
    $result = $apiInstance->updateLogoEmployer($id, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EmployerApi->updateLogoEmployer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string	The Id of the Employer you want to update.
file	\SplFileObject\SplFileObject		[optional]

Return type

\SynergiTech\Staffology\Model\ContractEmployerResponse

Authorization

Basic

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

FilesExpand file tree

EmployerApi.md

Latest commit

History

EmployerApi.md

File metadata and controls

SynergiTech\Staffology\EmployerApi

applyYearEndEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

calendarEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

createEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

customPayslipEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

getAutomationSettingsEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

getEmployeesWithAccrualHolidaySchemeEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

getEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

getEmployerOpeningBalancesEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

getEvcOptInHistoryEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

getGroupMembershipsEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

getReenrolmentStatusEmployer()

Example

Parameters

Return type

Authorization

HTTP request headers

getUserEmployerEmployer()

`applyYearEndEmployer()`

`calendarEmployer()`

`createEmployer()`

`customPayslipEmployer()`

`deleteEmployer()`

`getAutomationSettingsEmployer()`

`getEmployeesWithAccrualHolidaySchemeEmployer()`

`getEmployer()`

`getEmployerOpeningBalancesEmployer()`

`getEvcOptInHistoryEmployer()`

`getGroupMembershipsEmployer()`

`getReenrolmentStatusEmployer()`

`getUserEmployerEmployer()`

`importCsvEmployer()`

`indexEmployer()`

`listUsersEmployer()`

`removeUserEmployer()`

`reviewYearEndEmployer()`

`rtiRequiringAttentionEmployer()`

`searchEmployeesEmployer()`

`searchEmployer()`

`setEvcOptInEmployer()`

`setGroupMembershipsEmployer()`