OpenAPI\Client\AccountsApi

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

Method	HTTP request	Description
accountsGet()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/accounts	Gets list of accounts
accountsGetByCode()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/accounts/bycode/{code}	Gets account by code
accountsGetStatement()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/accounts/{id}/statement	get account statement
accountsGetStatementDataView()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/accounts/{id}/statement/dataview	get account statement with filtering, sorting and pagination.
accountsGetSummary()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/accounts/{id}/summary	get account summary
accountsGet_0()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/accounts/{id}	Gets account by id

`accountsGet()`

accountsGet($client_id, $fiscal_year_id): \Topal\Client\Model\Account[]

Gets list of accounts

Example

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



$apiInstance = new Topal\Client\Api\AccountsApi(
    // 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->accountsGet($client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountsGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Account[]

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]

`accountsGetByCode()`

accountsGetByCode($code, $client_id, $fiscal_year_id): \Topal\Client\Model\Account

Gets account by code

Example

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



$apiInstance = new Topal\Client\Api\AccountsApi(
    // 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->accountsGetByCode($code, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountsGetByCode: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
code	string
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Account

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]

`accountsGetStatement()`

accountsGetStatement($id, $date_from, $date_until, $client_id, $fiscal_year_id, $select_contra_postings): \Topal\Client\Model\BalancePosting[]

get account statement

Example

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



$apiInstance = new Topal\Client\Api\AccountsApi(
    // 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
$date_from = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$date_until = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string
$select_contra_postings = True; // bool

try {
    $result = $apiInstance->accountsGetStatement($id, $date_from, $date_until, $client_id, $fiscal_year_id, $select_contra_postings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountsGetStatement: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
id	int
date_from	\DateTime
date_until	\DateTime
client_id	string
fiscal_year_id	string
select_contra_postings	bool	[optional]

Return type

\Topal\Client\Model\BalancePosting[]

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]

`accountsGetStatementDataView()`

accountsGetStatementDataView($id, $date_from, $date_until, $client_id, $fiscal_year_id, $data_view, $select_contra_postings): \Topal\Client\Model\DataViewBalancePosting

get account statement with filtering, sorting and pagination.

Example

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



$apiInstance = new Topal\Client\Api\AccountsApi(
    // 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
$date_from = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$date_until = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string
$data_view = new \Topal\Client\Model\DataViewBalancePosting(); // \Topal\Client\Model\DataViewBalancePosting
$select_contra_postings = True; // bool

try {
    $result = $apiInstance->accountsGetStatementDataView($id, $date_from, $date_until, $client_id, $fiscal_year_id, $data_view, $select_contra_postings);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountsGetStatementDataView: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
id	int
date_from	\DateTime
date_until	\DateTime
client_id	string
fiscal_year_id	string
data_view	\Topal\Client\Model\DataViewBalancePosting
select_contra_postings	bool	[optional]

Return type

\Topal\Client\Model\DataViewBalancePosting

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Accept: application/json, text/json, application/xml, text/xml

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

`accountsGetSummary()`

accountsGetSummary($id, $date_from, $date_until, $client_id, $fiscal_year_id): \Topal\Client\Model\AccountSummary

get account summary

Example

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



$apiInstance = new Topal\Client\Api\AccountsApi(
    // 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
$date_from = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$date_until = 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->accountsGetSummary($id, $date_from, $date_until, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountsGetSummary: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int
date_from	\DateTime
date_until	\DateTime
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\AccountSummary

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]

`accountsGet_0()`

accountsGet_0($id, $client_id, $fiscal_year_id): \Topal\Client\Model\Account

Gets account by id

Example

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



$apiInstance = new Topal\Client\Api\AccountsApi(
    // 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->accountsGet_0($id, $client_id, $fiscal_year_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountsApi->accountsGet_0: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Account

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

AccountsApi.md

Latest commit

History

AccountsApi.md

File metadata and controls

OpenAPI\Client\AccountsApi

accountsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

accountsGetByCode()

Example

Parameters

Return type

Authorization

HTTP request headers

accountsGetStatement()

Example

Parameters

Return type

Authorization

HTTP request headers

accountsGetStatementDataView()

Example

Parameters

Return type

Authorization

HTTP request headers

accountsGetSummary()

Example

Parameters

Return type

Authorization

HTTP request headers

accountsGet_0()

Example

Parameters

Return type

Authorization

HTTP request headers

`accountsGet()`

`accountsGetByCode()`

`accountsGetStatement()`

`accountsGetStatementDataView()`

`accountsGetSummary()`

`accountsGet_0()`