OpenAPI\Client\TransactionsApi

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

Method	HTTP request	Description
transactionsCreatePosting()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/posting	create posting based on optinal parameters
transactionsDelete()	DELETE /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions/{id}	delete transaction
transactionsDeleteDocument()	DELETE /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions/{id}/document	delete document
transactionsDownloadDocument()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions/{id}/document	download document
transactionsGet()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions/{id}	get transaction by id
transactionsGetByDocNum()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions/bydocnum/{docNum}	get transaction by docNum
transactionsGetPendingDocuments()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions/documents/pending	get not procssed documents from dms
transactionsGetVatPosting()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/vatPosting	create posting with calculated vat amounts
transactionsGet_0()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions	get all transactions within fiscal year
transactionsLinkDocument()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions/{id}/document	link document
transactionsNew()	GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions/new/{transactionType}	creates new transaction of given type
transactionsPost()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions	saves transaction
transactionsUpload()	POST /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/transactions/documents	save document to DMS as unrecognized transaction

`transactionsCreatePosting()`

transactionsCreatePosting($client_id, $fiscal_year_id, $date, $account_code, $amount, $fc_amount, $exchange_rate, $vat_code, $is_inclusive): \Topal\Client\Model\Posting

create posting based on optinal parameters

Example

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



$apiInstance = new Topal\Client\Api\TransactionsApi(
    // 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
$date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime
$account_code = 'account_code_example'; // string
$amount = 3.4; // float
$fc_amount = 3.4; // float
$exchange_rate = 3.4; // float
$vat_code = 'vat_code_example'; // string
$is_inclusive = True; // bool

try {
    $result = $apiInstance->transactionsCreatePosting($client_id, $fiscal_year_id, $date, $account_code, $amount, $fc_amount, $exchange_rate, $vat_code, $is_inclusive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->transactionsCreatePosting: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
client_id	string
fiscal_year_id	string
date	\DateTime	[optional]
account_code	string	[optional]
amount	float	[optional]
fc_amount	float	[optional]
exchange_rate	float	[optional]
vat_code	string	[optional]
is_inclusive	bool	[optional]

Return type

\Topal\Client\Model\Posting

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]

`transactionsDelete()`

transactionsDelete($id, $client_id, $fiscal_year_id, $delete_doc): object

delete transaction

Example

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



$apiInstance = new Topal\Client\Api\TransactionsApi(
    // 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 = 'id_example'; // string
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string
$delete_doc = True; // bool | when not set and transaction has linked document return error

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_id	string
delete_doc	bool	when not set and transaction has linked document return error	[optional]

Return type

object

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]

`transactionsDeleteDocument()`

transactionsDeleteDocument($id, $client_id, $fiscal_year_id): object

delete document

Example

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



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

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_id	string

Return type

object

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]

`transactionsDownloadDocument()`

transactionsDownloadDocument($id, $client_id, $fiscal_year_id): object

download document

Example

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



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

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_id	string

Return type

object

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]

`transactionsGet()`

transactionsGet($id, $client_id, $fiscal_year_id): \Topal\Client\Model\Transaction

get transaction by id

Example

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



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

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Transaction

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]

`transactionsGetByDocNum()`

transactionsGetByDocNum($doc_num, $client_id, $fiscal_year_id): \Topal\Client\Model\Transaction

get transaction by docNum

Example

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



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

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

Parameters

Name	Type	Description	Notes
doc_num	int
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Transaction

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]

`transactionsGetPendingDocuments()`

transactionsGetPendingDocuments($client_id, $fiscal_year_id): \Topal\Client\Model\Document[]

get not procssed documents from dms

Example

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



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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Document[]

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]

`transactionsGetVatPosting()`

transactionsGetVatPosting($vat_code, $gross_amount, $gross_fc_amount, $client_id, $fiscal_year_id, $is_inclusive): \Topal\Client\Model\Posting

create posting with calculated vat amounts

Example

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



$apiInstance = new Topal\Client\Api\TransactionsApi(
    // 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_code = 'vat_code_example'; // string
$gross_amount = 3.4; // float
$gross_fc_amount = 3.4; // float
$client_id = 'client_id_example'; // string
$fiscal_year_id = 'fiscal_year_id_example'; // string
$is_inclusive = True; // bool

try {
    $result = $apiInstance->transactionsGetVatPosting($vat_code, $gross_amount, $gross_fc_amount, $client_id, $fiscal_year_id, $is_inclusive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling TransactionsApi->transactionsGetVatPosting: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
vat_code	string
gross_amount	float
gross_fc_amount	float
client_id	string
fiscal_year_id	string
is_inclusive	bool	[optional]

Return type

\Topal\Client\Model\Posting

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]

`transactionsGet_0()`

transactionsGet_0($client_id, $fiscal_year_id): \Topal\Client\Model\Transaction[]

get all transactions within fiscal year

Example

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



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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Transaction[]

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]

`transactionsLinkDocument()`

transactionsLinkDocument($id, $client_id, $fiscal_year_id): object

link document

Example

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



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

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

Parameters

Name	Type	Description	Notes
id	string
client_id	string
fiscal_year_id	string

Return type

object

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]

`transactionsNew()`

transactionsNew($transaction_type, $client_id, $fiscal_year_id): \Topal\Client\Model\Transaction

creates new transaction of given type

Example

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



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

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

Parameters

Name	Type	Description	Notes
transaction_type	int
client_id	string
fiscal_year_id	string

Return type

\Topal\Client\Model\Transaction

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]

`transactionsPost()`

transactionsPost($client_id, $fiscal_year_id, $transaction): \Topal\Client\Model\Transaction

saves transaction

Example

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



$apiInstance = new Topal\Client\Api\TransactionsApi(
    // 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
$transaction = new \Topal\Client\Model\Transaction(); // \Topal\Client\Model\Transaction

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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string
transaction	\Topal\Client\Model\Transaction

Return type

\Topal\Client\Model\Transaction

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]

`transactionsUpload()`

transactionsUpload($client_id, $fiscal_year_id): object

save document to DMS as unrecognized transaction

Example

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



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

Parameters

Name	Type	Description	Notes
client_id	string
fiscal_year_id	string

Return type

object

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]

FilesExpand file tree

TransactionsApi.md

Latest commit

History

TransactionsApi.md

File metadata and controls

OpenAPI\Client\TransactionsApi

transactionsCreatePosting()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsDeleteDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsDownloadDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsGet()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsGetByDocNum()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsGetPendingDocuments()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsGetVatPosting()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsGet_0()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsLinkDocument()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsNew()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsPost()

Example

Parameters

Return type

Authorization

HTTP request headers

transactionsUpload()

`transactionsCreatePosting()`

`transactionsDelete()`

`transactionsDeleteDocument()`

`transactionsDownloadDocument()`

`transactionsGet()`

`transactionsGetByDocNum()`

`transactionsGetPendingDocuments()`

`transactionsGetVatPosting()`

`transactionsGet_0()`

`transactionsLinkDocument()`

`transactionsNew()`

`transactionsPost()`

`transactionsUpload()`