OpenAPI\Client\Class20230301Api

All URIs are relative to https://api.affixapi.com.

Method	HTTP request	Description
xhrCompanies20230301()	GET /2023-03-01/xhr/company	Company
xhrEmployees20230301()	GET /2023-03-01/xhr/employees	Employees
xhrGroups20230301()	GET /2023-03-01/xhr/groups	Groups
xhrIdentity20230301()	GET /2023-03-01/xhr/identity	Identity
xhrPayruns20230301()	GET /2023-03-01/xhr/payruns	Payruns
xhrPayslips20230301()	GET /2023-03-01/xhr/payruns/{payrun_id}	Payslips
xhrTimeOffBalances20230301()	GET /2023-03-01/xhr/time-off-balances	Time off balances
xhrTimeOffEntries20230301()	GET /2023-03-01/xhr/time-off-entries	Time off entries
xhrTimesheets20230301()	GET /2023-03-01/xhr/timesheets	Timesheets
xhrWorkLocations20230301()	GET /2023-03-01/xhr/work-locations	Work locations

`xhrCompanies20230301()`

xhrCompanies20230301(): \OpenAPI\Client\Model\CompanyResponse[]

Company

Retrieve company information

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\CompanyResponse[]

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`xhrEmployees20230301()`

xhrEmployees20230301($employment_status): \OpenAPI\Client\Model\EmployeeResponse[]

Employees

List the individuals (employees, contractors, accountants, and others) listed in the HRIS/Payroll software

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);
$employment_status = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\EmploymentStatusNotNullNotNullable(); // \OpenAPI\Client\Model\EmploymentStatusNotNullNotNullable | Optional query parameter. Use to enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set)

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

Parameters

Name	Type	Description	Notes
employment_status	\OpenAPI\Client\Model\EmploymentStatusNotNullNotNullable	Optional query parameter. Use to enable server-side filtering of the `employment_status` attribute. Will only include individuals with that attribute explicitly set (ie if an individuals has a `null`, it will not be returned if this parameter is set)	[optional]

Return type

\OpenAPI\Client\Model\EmployeeResponse[]

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`xhrGroups20230301()`

xhrGroups20230301(): \OpenAPI\Client\Model\GroupResponse[]

Groups

The Group object is used to represent any subset of employees, such as PayGroup, Team, or Department. Employees can be in multiple Groups.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\GroupResponse[]

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`xhrIdentity20230301()`

xhrIdentity20230301(): \OpenAPI\Client\Model\IdentityResponse

Identity

List information of the user for the respective account

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\IdentityResponse

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`xhrPayruns20230301()`

xhrPayruns20230301($start_date, $end_date): \OpenAPI\Client\Model\PayrunResponse[]

Payruns

List all the pay runs that occurred during the respective period. Supported integrations: - brain payroll - brightpay connect - deel - gusto - justworks - moorepay - onpay - oyster - parolla.ie - paycircle - payfit - pento.io - quickbooks online - remote.com - sageone - shape payroll - simplepay.ie - staffology - xero uk

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The start date of the search period
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The end date of the search period

try {
    $result = $apiInstance->xhrPayruns20230301($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Class20230301Api->xhrPayruns20230301: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
start_date	\DateTime	The start date of the search period
end_date	\DateTime	The end date of the search period

Return type

\OpenAPI\Client\Model\PayrunResponse[]

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`xhrPayslips20230301()`

xhrPayslips20230301($payrun_id): \OpenAPI\Client\Model\PayslipResponse[]

Payslips

Retrieves payslips from a specific payrun. Supported integrations: - brain payroll - brightpay connect - deel - gusto - justworks - moorepay - onpay - oyster - parolla.ie - paycircle - payfit - pento.io - quickbooks online - remote.com - sageone - shape payroll - simplepay.ie - staffology - xero uk

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);
$payrun_id = 'payrun_id_example'; // string | The id of the payrun.

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

Parameters

Name	Type	Description	Notes
payrun_id	string	The id of the payrun.

Return type

\OpenAPI\Client\Model\PayslipResponse[]

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`xhrTimeOffBalances20230301()`

xhrTimeOffBalances20230301(): \OpenAPI\Client\Model\TimeOffBalanceResponse[]

Time off balances

Retrieve all time off balances.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\TimeOffBalanceResponse[]

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`xhrTimeOffEntries20230301()`

xhrTimeOffEntries20230301($start_date, $end_date): \OpenAPI\Client\Model\TimeOffEntryResponse[]

Time off entries

Retrieve time off / absence entries

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The start date of the search period
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The end date of the search period

try {
    $result = $apiInstance->xhrTimeOffEntries20230301($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Class20230301Api->xhrTimeOffEntries20230301: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
start_date	\DateTime	The start date of the search period
end_date	\DateTime	The end date of the search period

Return type

\OpenAPI\Client\Model\TimeOffEntryResponse[]

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`xhrTimesheets20230301()`

xhrTimesheets20230301($start_date, $end_date): \OpenAPI\Client\Model\TimesheetResponse[]

Timesheets

Retrieve Timesheets

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);
$start_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The start date of the search period
$end_date = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The end date of the search period

try {
    $result = $apiInstance->xhrTimesheets20230301($start_date, $end_date);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Class20230301Api->xhrTimesheets20230301: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
start_date	\DateTime	The start date of the search period
end_date	\DateTime	The end date of the search period

Return type

\OpenAPI\Client\Model\TimesheetResponse[]

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`xhrWorkLocations20230301()`

xhrWorkLocations20230301(): \OpenAPI\Client\Model\LocationResponse[]

Work locations

The Location object is used to represent an address that can be associated with an employee

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: access-token
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\Class20230301Api(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\LocationResponse[]

Authorization

access-token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

Class20230301Api.md

Latest commit

History

Class20230301Api.md

File metadata and controls

OpenAPI\Client\Class20230301Api

xhrCompanies20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

xhrEmployees20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

xhrGroups20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

xhrIdentity20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

xhrPayruns20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

xhrPayslips20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

xhrTimeOffBalances20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

xhrTimeOffEntries20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

xhrTimesheets20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

xhrWorkLocations20230301()

Example

Parameters

Return type

Authorization

HTTP request headers

`xhrCompanies20230301()`

`xhrEmployees20230301()`

`xhrGroups20230301()`

`xhrIdentity20230301()`

`xhrPayruns20230301()`

`xhrPayslips20230301()`

`xhrTimeOffBalances20230301()`

`xhrTimeOffEntries20230301()`

`xhrTimesheets20230301()`

`xhrWorkLocations20230301()`