Skip to content

Latest commit

 

History

History
executable file
·
241 lines (166 loc) · 6.64 KB

CurrenciesApi.md

File metadata and controls

executable file
·
241 lines (166 loc) · 6.64 KB

OpenAPI\Client\CurrenciesApi

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

Method HTTP request Description
currenciesGet() GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/currencies Retreives list of currencies
currenciesGetByCode() GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/currencies/bycode/{code} Get country by code
currenciesGet_0() GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/currencies/bydate/{date} Retreives list of currencies
currenciesGet_1() GET /api/v1/clients/{clientId}/fiscalYears/{fiscalYearId}/currencies/{id} Get country by id

currenciesGet()

currenciesGet($client_id, $fiscal_year_id): \Topal\Client\Model\Currency[]

Retreives list of currencies

Example

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



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

Parameters

Name Type Description Notes
client_id string
fiscal_year_id string

Return type

\Topal\Client\Model\Currency[]

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]

currenciesGetByCode()

currenciesGetByCode($code, $client_id, $fiscal_year_id): \Topal\Client\Model\Currency

Get country by code

Example

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



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

Parameters

Name Type Description Notes
code string
client_id string
fiscal_year_id string

Return type

\Topal\Client\Model\Currency

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]

currenciesGet_0()

currenciesGet_0($date, $client_id, $fiscal_year_id): \Topal\Client\Model\Currency[]

Retreives list of currencies

Example

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



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

Parameters

Name Type Description Notes
date \DateTime
client_id string
fiscal_year_id string

Return type

\Topal\Client\Model\Currency[]

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]

currenciesGet_1()

currenciesGet_1($id, $client_id, $fiscal_year_id): \Topal\Client\Model\Currency

Get country by id

Example

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



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

Parameters

Name Type Description Notes
id int
client_id string
fiscal_year_id string

Return type

\Topal\Client\Model\Currency

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]