SynergiTech\Staffology\FpsApi

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

Method	HTTP request	Description
createFps()	POST /employers/{employerId}/rti/fps/{taxYear}	Create FPS
deleteFps()	DELETE /employers/{employerId}/rti/fps/{taxYear}/{id}	Delete FPS
getFps()	GET /employers/{employerId}/rti/fps/{taxYear}/{id}	Get FPS
getXmlRequestFps()	GET /employers/{employerId}/rti/fps/{taxYear}/{id}/xml/request	Get XML Request
listFps()	GET /employers/{employerId}/rti/fps/{taxYear}	List FPS
markAsAcceptedFps()	POST /employers/{employerId}/rti/fps/{taxYear}/{id}/markasaccepted	Mark as Sent
mostRecentForEmployeeFps()	GET /employers/{employerId}/rti/fps/{taxYear}/mostrecentforemployee/{employeeId}	Get most recent FPS for Employee
requiringAttentionFps()	GET /employers/{employerId}/rti/fps/requiringattention	FPS Requiring Attention
submitFps()	POST /employers/{employerId}/rti/fps/{taxYear}/{id}/submit	Submit FPS
updateFps()	PUT /employers/{employerId}/rti/fps/{taxYear}/{id}	Update FPS

`createFps()`

createFps($employerId, $taxYear, $fps): \SynergiTech\Staffology\Model\Fps

Create FPS

Creates a new Full Payment Submission. This is limited to corrections, to a previous year, for a single 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\FpsApi(
    // 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
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear
$fps = new \SynergiTech\Staffology\Model\Fps(); // \SynergiTech\Staffology\Model\Fps

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

Parameters

Name	Type	Notes
employerId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear
fps	\SynergiTech\Staffology\Model\Fps	[optional]

Return type

\SynergiTech\Staffology\Model\Fps

Authorization

Basic

HTTP request headers

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

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

`deleteFps()`

deleteFps($employerId, $taxYear, $id)

Delete FPS

Not implemented, FPSes cannot be deleted

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\FpsApi(
    // 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
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear
$id = 'id_example'; // string

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

Parameters

Name	Type	Description	Notes
employerId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear
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]

`getFps()`

getFps($employerId, $taxYear, $id): \SynergiTech\Staffology\Model\Fps

Get FPS

Retrieves the Full Payment Submission specified

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\FpsApi(
    // 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
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear
$id = 'id_example'; // string

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

Parameters

Name	Type	Description	Notes
employerId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear
id	string

Return type

\SynergiTech\Staffology\Model\Fps

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]

`getXmlRequestFps()`

getXmlRequestFps($employerId, $taxYear, $id, $compressed): string

Get XML Request

Returns the XML request that was or will be sent to HMRC for this RTI document. Although the value is XML, it is returned as a JSON string.

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\FpsApi(
    // 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
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear
$id = 'id_example'; // string
$compressed = false; // bool | Indicates whether the FPS XML should be in compressed format.

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

Parameters

Name	Type	Description	Notes
employerId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear
id	string
compressed	bool	Indicates whether the FPS XML should be in compressed format.	[optional] [default to false]

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]

`listFps()`

listFps($employerId, $taxYear): \SynergiTech\Staffology\Model\Item[]

List FPS

Returns all Full Payment Submissions for the given tax year.

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\FpsApi(
    // 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
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear

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

Parameters

Name	Type	Description	Notes
employerId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear

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]

`markAsAcceptedFps()`

markAsAcceptedFps($employerId, $taxYear, $id): \SynergiTech\Staffology\Model\Fps

Mark as Sent

Marks an Full Payment Submission as having been sent to HMRC and accepted by them. You only use this method if the FPS has been submitted via an external system. It will automatically be updated as Sent and/or Accepted if it's submitted via this API.

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\FpsApi(
    // 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
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear
$id = 'id_example'; // string

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

Parameters

Name	Type	Description	Notes
employerId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear
id	string

Return type

\SynergiTech\Staffology\Model\Fps

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]

`mostRecentForEmployeeFps()`

mostRecentForEmployeeFps($employerId, $taxYear, $employeeId, $correction): \SynergiTech\Staffology\Model\Item

Get most recent FPS for Employee

Returns the most recent Full Payment Submission that includes the specified 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\FpsApi(
    // 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
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear
$employeeId = 'employeeId_example'; // string
$correction = false; // bool | Only search for FPS's submitted as a correction to a previous year

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

Parameters

Name	Type	Description	Notes
employerId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear
employeeId	string
correction	bool	Only search for FPS's submitted as a correction to a previous year	[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]

`requiringAttentionFps()`

requiringAttentionFps($employerId): \SynergiTech\Staffology\Model\Item[]

FPS Requiring Attention

Returns all Full Payment Submissions 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\FpsApi(
    // 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

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

Parameters

Name	Type	Description	Notes
employerId	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]

`submitFps()`

submitFps($employerId, $taxYear, $id, $force): \SynergiTech\Staffology\Model\Fps

Submit FPS

Submits an existing Full Payment Submission to HMRC.

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\FpsApi(
    // 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
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear
$id = 'id_example'; // string
$force = false; // bool | If the FPS has already been accepted then you will need to set this to true to force it to be resubmitted

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

Parameters

Name	Type	Description	Notes
employerId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear
id	string
force	bool	If the FPS has already been accepted then you will need to set this to true to force it to be resubmitted	[optional] [default to false]

Return type

\SynergiTech\Staffology\Model\Fps

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]

`updateFps()`

updateFps($employerId, $taxYear, $id, $fps): \SynergiTech\Staffology\Model\Fps

Update FPS

Updates an existing Full Payment Submission.

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\FpsApi(
    // 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
$taxYear = new \SynergiTech\Staffology\Model\\SynergiTech\Staffology\Model\TaxYear(); // \SynergiTech\Staffology\Model\TaxYear
$id = 'id_example'; // string
$fps = new \SynergiTech\Staffology\Model\Fps(); // \SynergiTech\Staffology\Model\Fps

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

Parameters

Name	Type	Notes
employerId	string
taxYear	\SynergiTech\Staffology\Model\TaxYear
id	string
fps	\SynergiTech\Staffology\Model\Fps	[optional]

Return type

\SynergiTech\Staffology\Model\Fps

Authorization

Basic

HTTP request headers

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

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

Files

FpsApi.md

Latest commit

History

FpsApi.md

File metadata and controls

SynergiTech\Staffology\FpsApi

createFps()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteFps()

Example

Parameters

Return type

Authorization

HTTP request headers

getFps()

Example

Parameters

Return type

Authorization

HTTP request headers

getXmlRequestFps()

Example

Parameters

Return type

Authorization

HTTP request headers

listFps()

Example

Parameters

Return type

Authorization

HTTP request headers

markAsAcceptedFps()

Example

Parameters

Return type

Authorization

HTTP request headers

mostRecentForEmployeeFps()

Example

Parameters

Return type

Authorization

HTTP request headers

requiringAttentionFps()

Example

Parameters

Return type

Authorization

HTTP request headers

submitFps()

Example

Parameters

Return type

Authorization

HTTP request headers

updateFps()

Example

Parameters

Return type

Authorization

HTTP request headers

`createFps()`

`deleteFps()`

`getFps()`

`getXmlRequestFps()`

`listFps()`

`markAsAcceptedFps()`

`mostRecentForEmployeeFps()`

`requiringAttentionFps()`

`submitFps()`

`updateFps()`