OpenAPI\Client\VATsApi

All URIs are relative to https://topal.vitan.ch:9001, except if the operation defines another base path.

Method	HTTP request	Description
vATsGet()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/vats	Get list of VATs (depricated: use vats/bydate instead )
vATsGetByCode()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/vats/bycode/{code}	Get VAT by code
vATsGetByCode_0()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/vatPeriods/{vatPeriodId}/vats/bycode/{code}	Get VAT by code
vATsGetByVatPeriod()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/vatPeriods/{vatPeriodId}/vats	Get list of VATs by vatPeriodId
vATsGet_0()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/vats/bydate	Get list of VATs of period of given date
vATsGet_1()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/vats/{id}	Get VAT by id
vATsGet_2()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/vatPeriods/{vatPeriodId}/vats/{id}	Get VAT by id

`vATsGet()`

vATsGet($client_id, $fiscal_year_id): \OpenAPI\Client\Model\VAT[]

Get list of VATs (depricated: use vats/bydate instead )

Example

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



$apiInstance = new OpenAPI\Client\Api\VATsApi(
    // 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()
);
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

\OpenAPI\Client\Model\VAT[]

Authorization

No authorization required

HTTP request headers

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

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

`vATsGetByCode()`

vATsGetByCode($code, $client_id, $fiscal_year_id): \OpenAPI\Client\Model\VAT

Get VAT by code

Example

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



$apiInstance = new OpenAPI\Client\Api\VATsApi(
    // 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()
);
$code = 'code_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

try {
    $result = $apiInstance->vATsGetByCode($code, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VATsApi->vATsGetByCode: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
code	string
client_id	string
fiscal_year_id	string

Return type

\OpenAPI\Client\Model\VAT

Authorization

No authorization required

HTTP request headers

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

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

`vATsGetByCode_0()`

vATsGetByCode_0($vat_period_id, $code, $client_id, $fiscal_year_id): \OpenAPI\Client\Model\VAT

Get VAT by code

Example

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



$apiInstance = new OpenAPI\Client\Api\VATsApi(
    // 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()
);
$vat_period_id = 56; // int
$code = 'code_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

try {
    $result = $apiInstance->vATsGetByCode_0($vat_period_id, $code, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VATsApi->vATsGetByCode_0: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
vat_period_id	int
code	string
client_id	string
fiscal_year_id	string

Return type

\OpenAPI\Client\Model\VAT

Authorization

No authorization required

HTTP request headers

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

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

`vATsGetByVatPeriod()`

vATsGetByVatPeriod($vat_period_id, $client_id, $fiscal_year_id): \OpenAPI\Client\Model\VAT[]

Get list of VATs by vatPeriodId

Example

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



$apiInstance = new OpenAPI\Client\Api\VATsApi(
    // 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()
);
$vat_period_id = 56; // int
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

try {
    $result = $apiInstance->vATsGetByVatPeriod($vat_period_id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VATsApi->vATsGetByVatPeriod: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
vat_period_id	int
client_id	string
fiscal_year_id	string

Return type

\OpenAPI\Client\Model\VAT[]

Authorization

No authorization required

HTTP request headers

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

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

`vATsGet_0()`

vATsGet_0($date, $client_id, $fiscal_year_id): \OpenAPI\Client\Model\VAT[]

Get list of VATs of period of given date

Example

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



$apiInstance = new OpenAPI\Client\Api\VATsApi(
    // 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()
);
$date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

try {
    $result = $apiInstance->vATsGet_0($date, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VATsApi->vATsGet_0: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
date	\DateTime
client_id	string
fiscal_year_id	string

Return type

\OpenAPI\Client\Model\VAT[]

Authorization

No authorization required

HTTP request headers

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

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

`vATsGet_1()`

vATsGet_1($id, $client_id, $fiscal_year_id): \OpenAPI\Client\Model\VAT

Get VAT by id

Example

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



$apiInstance = new OpenAPI\Client\Api\VATsApi(
    // 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()
);
$id = 56; // int
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

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

Parameters

Name	Type	Description	Notes
id	int
client_id	string
fiscal_year_id	string

Return type

\OpenAPI\Client\Model\VAT

Authorization

No authorization required

HTTP request headers

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

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

`vATsGet_2()`

vATsGet_2($vat_period_id, $id, $client_id, $fiscal_year_id): \OpenAPI\Client\Model\VAT

Get VAT by id

Example

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



$apiInstance = new OpenAPI\Client\Api\VATsApi(
    // 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()
);
$vat_period_id = 56; // int
$id = 56; // int
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string

try {
    $result = $apiInstance->vATsGet_2($vat_period_id, $id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VATsApi->vATsGet_2: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
vat_period_id	int
id	int
client_id	string
fiscal_year_id	string

Return type

\OpenAPI\Client\Model\VAT

Authorization

No authorization required

HTTP request headers

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

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

Files

VATsApi.md

Latest commit

History

VATsApi.md

File metadata and controls

OpenAPI\Client\VATsApi

vATsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

vATsGetByCode()

Example

Parameters

Return type

Authorization

HTTP request headers

vATsGetByCode_0()

Example

Parameters

Return type

Authorization

HTTP request headers

vATsGetByVatPeriod()

Example

Parameters

Return type

Authorization

HTTP request headers

vATsGet_0()

Example

Parameters

Return type

Authorization

HTTP request headers

vATsGet_1()

Example

Parameters

Return type

Authorization

HTTP request headers

vATsGet_2()

Example

Parameters

Return type

Authorization

HTTP request headers

`vATsGet()`

`vATsGetByCode()`

`vATsGetByCode_0()`

`vATsGetByVatPeriod()`

`vATsGet_0()`

`vATsGet_1()`

`vATsGet_2()`