# Fortnox\FortnoxPredefinedVoucherSeriesApi



All URIs are relative to https://api.fortnox.se, except if the operation defines another base path.

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**preDefinedVoucherSeriesControllerDoIndex()**](FortnoxPredefinedVoucherSeriesApi.md#preDefinedVoucherSeriesControllerDoIndex) | **GET** /3/predefinedvoucherseries | Retrieve a list of predefined voucher series |
| [**preDefinedVoucherSeriesControllerDoShow()**](FortnoxPredefinedVoucherSeriesApi.md#preDefinedVoucherSeriesControllerDoShow) | **GET** /3/predefinedvoucherseries/{Name} | Retrieve a specific predefined voucher series |
| [**preDefinedVoucherSeriesControllerDoUpdate()**](FortnoxPredefinedVoucherSeriesApi.md#preDefinedVoucherSeriesControllerDoUpdate) | **PUT** /3/predefinedvoucherseries/{Name} | Update a predefined voucher series |


## `preDefinedVoucherSeriesControllerDoIndex()`

```php
preDefinedVoucherSeriesControllerDoIndex(): \Fortnox\Model\FortnoxBfPreDefinedVoucherSeriesListItemWrap
```

Retrieve a list of predefined voucher series

Get pre defined voucher series collection

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPredefinedVoucherSeriesApi(
    // 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()
);

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

### Parameters

This endpoint does not need any parameter.

### Return type

[**\Fortnox\Model\FortnoxBfPreDefinedVoucherSeriesListItemWrap**](../Model/FortnoxBfPreDefinedVoucherSeriesListItemWrap.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `preDefinedVoucherSeriesControllerDoShow()`

```php
preDefinedVoucherSeriesControllerDoShow($name): \Fortnox\Model\FortnoxBfPreDefinedVoucherSeriesSingleItemWrap
```

Retrieve a specific predefined voucher series

Retrieve a pre defined voucher series

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPredefinedVoucherSeriesApi(
    // 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()
);
$name = 'name_example'; // string | identifies the predefined voucher series

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **name** | **string**| identifies the predefined voucher series | |

### Return type

[**\Fortnox\Model\FortnoxBfPreDefinedVoucherSeriesSingleItemWrap**](../Model/FortnoxBfPreDefinedVoucherSeriesSingleItemWrap.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `preDefinedVoucherSeriesControllerDoUpdate()`

```php
preDefinedVoucherSeriesControllerDoUpdate($name, $predefined_voucher_series): \Fortnox\Model\FortnoxBfPreDefinedVoucherSeriesSingleItemWrap
```

Update a predefined voucher series

Update a pre defined voucher series

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPredefinedVoucherSeriesApi(
    // 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()
);
$name = 'name_example'; // string | identifies the predefined voucher series
$predefined_voucher_series = new \Fortnox\Model\FortnoxBfPreDefinedVoucherSeriesSinglePayloadItemWrap(); // \Fortnox\Model\FortnoxBfPreDefinedVoucherSeriesSinglePayloadItemWrap | Request body for update pre defined voucher series

try {
    $result = $apiInstance->preDefinedVoucherSeriesControllerDoUpdate($name, $predefined_voucher_series);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxPredefinedVoucherSeriesApi->preDefinedVoucherSeriesControllerDoUpdate: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **name** | **string**| identifies the predefined voucher series | |
| **predefined_voucher_series** | [**\Fortnox\Model\FortnoxBfPreDefinedVoucherSeriesSinglePayloadItemWrap**](../Model/FortnoxBfPreDefinedVoucherSeriesSinglePayloadItemWrap.md)| Request body for update pre defined voucher series | [optional] |

### Return type

[**\Fortnox\Model\FortnoxBfPreDefinedVoucherSeriesSingleItemWrap**](../Model/FortnoxBfPreDefinedVoucherSeriesSingleItemWrap.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
