# Fortnox\FortnoxPricesApi



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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**priceControllerDoCreate()**](FortnoxPricesApi.md#priceControllerDoCreate) | **POST** /3/prices | Create a price |
| [**priceControllerDoDeleteWithId3()**](FortnoxPricesApi.md#priceControllerDoDeleteWithId3) | **DELETE** /3/prices/{PriceList}/{ArticleNumber}/{FromQuantity} | Delete a single price |
| [**priceControllerDoIndex()**](FortnoxPricesApi.md#priceControllerDoIndex) | **GET** /3/prices | Retrieve a list of prices |
| [**priceControllerDoShow()**](FortnoxPricesApi.md#priceControllerDoShow) | **GET** /3/prices/{PriceList}/{ArticleNumber} | Retrieve the first price for the specified article |
| [**priceControllerDoShowWithId3()**](FortnoxPricesApi.md#priceControllerDoShowWithId3) | **GET** /3/prices/{PriceList}/{ArticleNumber}/{FromQuantity} | Retrieve a price for a specified article |
| [**priceControllerDoSublistWithTwoParams()**](FortnoxPricesApi.md#priceControllerDoSublistWithTwoParams) | **GET** /3/prices/sublist/{PriceList}/{ArticleNumber} | Retrieve a list of articles with all their prices in the specified price list |
| [**priceControllerDoUpdate()**](FortnoxPricesApi.md#priceControllerDoUpdate) | **PUT** /3/prices/{PriceList}/{ArticleNumber} | Update the first price in the specified article |
| [**priceControllerDoUpdateWithId3()**](FortnoxPricesApi.md#priceControllerDoUpdateWithId3) | **PUT** /3/prices/{PriceList}/{ArticleNumber}/{FromQuantity} | Update a price |


## `priceControllerDoCreate()`

```php
priceControllerDoCreate($price): \Fortnox\Model\FortnoxPriceSingleItemWrap
```

Create a price

Create a price

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPricesApi(
    // 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()
);
$price = new \Fortnox\Model\FortnoxPriceSinglePayloadItemWrap(); // \Fortnox\Model\FortnoxPriceSinglePayloadItemWrap | Request body for create price

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **price** | [**\Fortnox\Model\FortnoxPriceSinglePayloadItemWrap**](../Model/FortnoxPriceSinglePayloadItemWrap.md)| Request body for create price | [optional] |

### Return type

[**\Fortnox\Model\FortnoxPriceSingleItemWrap**](../Model/FortnoxPriceSingleItemWrap.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)

## `priceControllerDoDeleteWithId3()`

```php
priceControllerDoDeleteWithId3($price_list, $article_number, $from_quantity)
```

Delete a single price

Delete a price

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPricesApi(
    // 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()
);
$price_list = 'price_list_example'; // string | Price list to delete from
$article_number = 'article_number_example'; // string | Number of article to delete the price for
$from_quantity = 'from_quantity_example'; // string | From quantity of price to delete

try {
    $apiInstance->priceControllerDoDeleteWithId3($price_list, $article_number, $from_quantity);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxPricesApi->priceControllerDoDeleteWithId3: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **price_list** | **string**| Price list to delete from | |
| **article_number** | **string**| Number of article to delete the price for | |
| **from_quantity** | **string**| From quantity of price to delete | |

### Return type

void (empty response body)

### 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)

## `priceControllerDoIndex()`

```php
priceControllerDoIndex($fromquantity): \Fortnox\Model\FortnoxPriceSingleItemWrap
```

Retrieve a list of prices

Retrieve a price

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPricesApi(
    // 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()
);
$fromquantity = 3.4; // float | Lists prices by from quantity

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **fromquantity** | **float**| Lists prices by from quantity | [optional] |

### Return type

[**\Fortnox\Model\FortnoxPriceSingleItemWrap**](../Model/FortnoxPriceSingleItemWrap.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)

## `priceControllerDoShow()`

```php
priceControllerDoShow($price_list, $article_number, $fromquantity): \Fortnox\Model\FortnoxPriceSingleItemWrap
```

Retrieve the first price for the specified article

Retrieve a price

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPricesApi(
    // 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()
);
$price_list = 'price_list_example'; // string | Price list of the price to show
$article_number = 'article_number_example'; // string | Article number of the price to show
$fromquantity = 3.4; // float | Get price by from quantity

try {
    $result = $apiInstance->priceControllerDoShow($price_list, $article_number, $fromquantity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxPricesApi->priceControllerDoShow: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **price_list** | **string**| Price list of the price to show | |
| **article_number** | **string**| Article number of the price to show | |
| **fromquantity** | **float**| Get price by from quantity | [optional] |

### Return type

[**\Fortnox\Model\FortnoxPriceSingleItemWrap**](../Model/FortnoxPriceSingleItemWrap.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)

## `priceControllerDoShowWithId3()`

```php
priceControllerDoShowWithId3($price_list, $article_number, $from_quantity): \Fortnox\Model\FortnoxPriceSingleItemWrap
```

Retrieve a price for a specified article

Retrieve a price

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPricesApi(
    // 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()
);
$price_list = 'price_list_example'; // string | Price list to get the price from
$article_number = 'article_number_example'; // string | Number of article to get the price for
$from_quantity = 'from_quantity_example'; // string | From quantity of price to show

try {
    $result = $apiInstance->priceControllerDoShowWithId3($price_list, $article_number, $from_quantity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxPricesApi->priceControllerDoShowWithId3: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **price_list** | **string**| Price list to get the price from | |
| **article_number** | **string**| Number of article to get the price for | |
| **from_quantity** | **string**| From quantity of price to show | |

### Return type

[**\Fortnox\Model\FortnoxPriceSingleItemWrap**](../Model/FortnoxPriceSingleItemWrap.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)

## `priceControllerDoSublistWithTwoParams()`

```php
priceControllerDoSublistWithTwoParams($price_list, $article_number, $fromquantity): \Fortnox\Model\FortnoxPriceListItemWrap
```

Retrieve a list of articles with all their prices in the specified price list

The list contains a slimmer version of the prices. To get a full entity, use the GET with a price list, article number and from quantity.

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPricesApi(
    // 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()
);
$price_list = 'price_list_example'; // string | Price list of the prices to list
$article_number = 'article_number_example'; // string | Article number of the prices to list
$fromquantity = 3.4; // float | Filter prices by from quantity

try {
    $result = $apiInstance->priceControllerDoSublistWithTwoParams($price_list, $article_number, $fromquantity);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxPricesApi->priceControllerDoSublistWithTwoParams: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **price_list** | **string**| Price list of the prices to list | |
| **article_number** | **string**| Article number of the prices to list | |
| **fromquantity** | **float**| Filter prices by from quantity | [optional] |

### Return type

[**\Fortnox\Model\FortnoxPriceListItemWrap**](../Model/FortnoxPriceListItemWrap.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)

## `priceControllerDoUpdate()`

```php
priceControllerDoUpdate($price_list, $article_number, $price): \Fortnox\Model\FortnoxPriceSingleItemWrap
```

Update the first price in the specified article

Update a price

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPricesApi(
    // 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()
);
$price_list = 'price_list_example'; // string | Price list to update the price for
$article_number = 'article_number_example'; // string | Number of article to update the price for
$price = new \Fortnox\Model\FortnoxPriceSinglePayloadItemWrap(); // \Fortnox\Model\FortnoxPriceSinglePayloadItemWrap | Request body for update price

try {
    $result = $apiInstance->priceControllerDoUpdate($price_list, $article_number, $price);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxPricesApi->priceControllerDoUpdate: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **price_list** | **string**| Price list to update the price for | |
| **article_number** | **string**| Number of article to update the price for | |
| **price** | [**\Fortnox\Model\FortnoxPriceSinglePayloadItemWrap**](../Model/FortnoxPriceSinglePayloadItemWrap.md)| Request body for update price | [optional] |

### Return type

[**\Fortnox\Model\FortnoxPriceSingleItemWrap**](../Model/FortnoxPriceSingleItemWrap.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)

## `priceControllerDoUpdateWithId3()`

```php
priceControllerDoUpdateWithId3($price_list, $article_number, $from_quantity, $price): \Fortnox\Model\FortnoxPriceSingleItemWrap
```

Update a price

Update a price

### Example

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



$apiInstance = new Fortnox\Api\FortnoxPricesApi(
    // 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()
);
$price_list = 'price_list_example'; // string | Price list to update the price for
$article_number = 'article_number_example'; // string | Number of article to update the price for
$from_quantity = 'from_quantity_example'; // string | From quantity of price to update
$price = new \Fortnox\Model\FortnoxPriceSinglePayloadItemWrap(); // \Fortnox\Model\FortnoxPriceSinglePayloadItemWrap | Request body for update price

try {
    $result = $apiInstance->priceControllerDoUpdateWithId3($price_list, $article_number, $from_quantity, $price);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxPricesApi->priceControllerDoUpdateWithId3: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **price_list** | **string**| Price list to update the price for | |
| **article_number** | **string**| Number of article to update the price for | |
| **from_quantity** | **string**| From quantity of price to update | |
| **price** | [**\Fortnox\Model\FortnoxPriceSinglePayloadItemWrap**](../Model/FortnoxPriceSinglePayloadItemWrap.md)| Request body for update price | [optional] |

### Return type

[**\Fortnox\Model\FortnoxPriceSingleItemWrap**](../Model/FortnoxPriceSingleItemWrap.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)
