SynergiTech\Staffology\JournalTokenApi

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

Method	HTTP request	Description
createCostCentreJournalOverridesJournalToken()	POST /employers/{employerId}/journaltokens/{costCentreId}/costcentrejournaloverrides	Create CostCentre Journal Overrides
createDepartmentJournalOverridesJournalToken()	POST /employers/{employerId}/journaltokens/{departmentId}/departmentjournaloverrides	Create Department Journal Overrides
createJournalToken()	POST /employers/{employerId}/journaltokens	Create Journal Token
deleteJournalToken()	DELETE /employers/{employerId}/journaltokens/{id}	Delete Journal Token
getCostCentreJournalOverridesListJournalToken()	GET /employers/{employerId}/journaltokens/{costCentreId}/costcentrejournaloverrides	List CostCentre Journal Overrides
getDepartmentJournalOverridesListJournalToken()	GET /employers/{employerId}/journaltokens/{departmentId}/departmentjournaloverrides	List Department Journal Overrides
getJournalToken()	GET /employers/{employerId}/journaltokens/{id}	Get Journal Token
indexJournalToken()	GET /employers/{employerId}/journaltokens	List Journal Tokens
updateCostCentreJournalOverridesJournalToken()	PUT /employers/{employerId}/journaltokens/{costCentreId}/costcentrejournaloverrides	Update CostCentre Journal Overrides
updateDepartmentJournalOverridesJournalToken()	PUT /employers/{employerId}/journaltokens/{departmentId}/departmentjournaloverrides	Update Department Journal Overrides
updateJournalToken()	PUT /employers/{employerId}/journaltokens/{id}	Update Journal Token

`createCostCentreJournalOverridesJournalToken()`

createCostCentreJournalOverridesJournalToken($employerId, $costCentreId, $contractCostCentreJournalOverridesRequest): \SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesResponse[]

Create CostCentre Journal Overrides

Create Journal Overrides for an CostCentre.

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\JournalTokenApi(
    // 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 for which you want to create Journal Overrides
$costCentreId = 'costCentreId_example'; // string | The Id of the CostCentre for which you want to create Journal Overrides
$contractCostCentreJournalOverridesRequest = array(new \SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesRequest()); // \SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesRequest[]

try {
    $result = $apiInstance->createCostCentreJournalOverridesJournalToken($employerId, $costCentreId, $contractCostCentreJournalOverridesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JournalTokenApi->createCostCentreJournalOverridesJournalToken: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer for which you want to create Journal Overrides
costCentreId	string	The Id of the CostCentre for which you want to create Journal Overrides
contractCostCentreJournalOverridesRequest	\SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesRequest[]		[optional]

Return type

\SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesResponse[]

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]

`createDepartmentJournalOverridesJournalToken()`

createDepartmentJournalOverridesJournalToken($employerId, $departmentId, $contractDepartmentJournalOverridesRequest): \SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesResponse[]

Create Department Journal Overrides

Create Journal Overrides for an Department.

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\JournalTokenApi(
    // 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 for which you want to create Journal Overrides
$departmentId = 'departmentId_example'; // string | The Id of the Department for which you want to create Journal Overrides
$contractDepartmentJournalOverridesRequest = array(new \SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesRequest()); // \SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesRequest[]

try {
    $result = $apiInstance->createDepartmentJournalOverridesJournalToken($employerId, $departmentId, $contractDepartmentJournalOverridesRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JournalTokenApi->createDepartmentJournalOverridesJournalToken: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer for which you want to create Journal Overrides
departmentId	string	The Id of the Department for which you want to create Journal Overrides
contractDepartmentJournalOverridesRequest	\SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesRequest[]		[optional]

Return type

\SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesResponse[]

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]

`createJournalToken()`

createJournalToken($employerId, $contractJournalTokenRequest): \SynergiTech\Staffology\Model\ContractJournalTokenResponse

Create Journal Token

Create Journal Token for 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\JournalTokenApi(
    // 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 for which you want to create Journal Token
$contractJournalTokenRequest = new \SynergiTech\Staffology\Model\ContractJournalTokenRequest(); // \SynergiTech\Staffology\Model\ContractJournalTokenRequest

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

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer for which you want to create Journal Token
contractJournalTokenRequest	\SynergiTech\Staffology\Model\ContractJournalTokenRequest		[optional]

Return type

\SynergiTech\Staffology\Model\ContractJournalTokenResponse

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]

`deleteJournalToken()`

deleteJournalToken($employerId, $id)

Delete Journal Token

Deletes the specified Journal Token.

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

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

Parameters

Name	Type	Description	Notes
employerId	string
id	string

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]

`getCostCentreJournalOverridesListJournalToken()`

getCostCentreJournalOverridesListJournalToken($employerId, $costCentreId): \SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesResponseItem[]

List CostCentre Journal Overrides

List Journal Overrides for an CostCentre.

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\JournalTokenApi(
    // 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 for which you want list of Journal Overrides
$costCentreId = 'costCentreId_example'; // string | The Id of the CostCentre for which you want list of Journal Overrides

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

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer for which you want list of Journal Overrides
costCentreId	string	The Id of the CostCentre for which you want list of Journal Overrides

Return type

\SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesResponseItem[]

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]

`getDepartmentJournalOverridesListJournalToken()`

getDepartmentJournalOverridesListJournalToken($employerId, $departmentId): \SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesResponseItem[]

List Department Journal Overrides

List Journal Overrides for an Department.

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\JournalTokenApi(
    // 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 for which you want list of Journal Overrides
$departmentId = 'departmentId_example'; // string | The Id of the Department for which you want list of Journal Overrides

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

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer for which you want list of Journal Overrides
departmentId	string	The Id of the Department for which you want list of Journal Overrides

Return type

\SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesResponseItem[]

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]

`getJournalToken()`

getJournalToken($employerId, $id): \SynergiTech\Staffology\Model\ContractJournalTokenResponse

Get Journal Token

Get Specified Journal Token for 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\JournalTokenApi(
    // 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 for which you want to get Journal Token
$id = 'id_example'; // string | The Id of the Journal Tokens for which you want to get Journal Token

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

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer for which you want to get Journal Token
id	string	The Id of the Journal Tokens for which you want to get Journal Token

Return type

\SynergiTech\Staffology\Model\ContractJournalTokenResponse

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]

`indexJournalToken()`

indexJournalToken($employerId): \SynergiTech\Staffology\Model\ContractJournalTokenResponseItem[]

List Journal Tokens

List Journal Tokens for 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\JournalTokenApi(
    // 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 for which you want list of Journal Tokens

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

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer for which you want list of Journal Tokens

Return type

\SynergiTech\Staffology\Model\ContractJournalTokenResponseItem[]

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]

`updateCostCentreJournalOverridesJournalToken()`

updateCostCentreJournalOverridesJournalToken($employerId, $costCentreId, $contractCostCentreJournalOverridesUpdateRequest): \SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesResponse[]

Update CostCentre Journal Overrides

Updates Journal Overrides for the CostCentre.

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\JournalTokenApi(
    // 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 for which you want to update Journal Overrides
$costCentreId = 'costCentreId_example'; // string | The Id of the CostCentre for which you want to update Journal Overrides
$contractCostCentreJournalOverridesUpdateRequest = array(new \SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesUpdateRequest()); // \SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesUpdateRequest[]

try {
    $result = $apiInstance->updateCostCentreJournalOverridesJournalToken($employerId, $costCentreId, $contractCostCentreJournalOverridesUpdateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JournalTokenApi->updateCostCentreJournalOverridesJournalToken: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer for which you want to update Journal Overrides
costCentreId	string	The Id of the CostCentre for which you want to update Journal Overrides
contractCostCentreJournalOverridesUpdateRequest	\SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesUpdateRequest[]		[optional]

Return type

\SynergiTech\Staffology\Model\ContractCostCentreJournalOverridesResponse[]

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]

`updateDepartmentJournalOverridesJournalToken()`

updateDepartmentJournalOverridesJournalToken($employerId, $departmentId, $contractDepartmentJournalOverridesUpdateRequest): \SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesResponse[]

Update Department Journal Overrides

Updates Journal Overrides for the Department.

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\JournalTokenApi(
    // 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 for which you want to update Journal Overrides
$departmentId = 'departmentId_example'; // string | The Id of the Department for which you want to update Journal Overrides
$contractDepartmentJournalOverridesUpdateRequest = array(new \SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesUpdateRequest()); // \SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesUpdateRequest[]

try {
    $result = $apiInstance->updateDepartmentJournalOverridesJournalToken($employerId, $departmentId, $contractDepartmentJournalOverridesUpdateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling JournalTokenApi->updateDepartmentJournalOverridesJournalToken: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
employerId	string	The Id of the Employer for which you want to update Journal Overrides
departmentId	string	The Id of the Department for which you want to update Journal Overrides
contractDepartmentJournalOverridesUpdateRequest	\SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesUpdateRequest[]		[optional]

Return type

\SynergiTech\Staffology\Model\ContractDepartmentJournalOverridesResponse[]

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]

`updateJournalToken()`

updateJournalToken($employerId, $id, $contractJournalTokenRequest): \SynergiTech\Staffology\Model\ContractJournalTokenResponse

Update Journal Token

Updates Specified Journal Token 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\JournalTokenApi(
    // 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
$id = 'id_example'; // string
$contractJournalTokenRequest = new \SynergiTech\Staffology\Model\ContractJournalTokenRequest(); // \SynergiTech\Staffology\Model\ContractJournalTokenRequest

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

Parameters

Name	Type	Notes
employerId	string
id	string
contractJournalTokenRequest	\SynergiTech\Staffology\Model\ContractJournalTokenRequest	[optional]

Return type

\SynergiTech\Staffology\Model\ContractJournalTokenResponse

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

JournalTokenApi.md

Latest commit

History

JournalTokenApi.md

File metadata and controls

SynergiTech\Staffology\JournalTokenApi

createCostCentreJournalOverridesJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

createDepartmentJournalOverridesJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

createJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

getCostCentreJournalOverridesListJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

getDepartmentJournalOverridesListJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

getJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

indexJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

updateCostCentreJournalOverridesJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

updateDepartmentJournalOverridesJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

updateJournalToken()

Example

Parameters

Return type

Authorization

HTTP request headers

`createCostCentreJournalOverridesJournalToken()`

`createDepartmentJournalOverridesJournalToken()`

`createJournalToken()`

`deleteJournalToken()`

`getCostCentreJournalOverridesListJournalToken()`

`getDepartmentJournalOverridesListJournalToken()`

`getJournalToken()`

`indexJournalToken()`

`updateCostCentreJournalOverridesJournalToken()`

`updateDepartmentJournalOverridesJournalToken()`

`updateJournalToken()`