# Fortnox\WarehouseCustomOutboundDocumentApi



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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**get13()**](WarehouseCustomOutboundDocumentApi.md#get13) | **GET** /api/warehouse/documentdeliveries/custom/outbound-v1/{type}/{id} | Get custom outbound document |
| [**release5()**](WarehouseCustomOutboundDocumentApi.md#release5) | **PUT** /api/warehouse/documentdeliveries/custom/outbound-v1/{type}/{id}/release | Release custom outbound document |
| [**save1()**](WarehouseCustomOutboundDocumentApi.md#save1) | **PUT** /api/warehouse/documentdeliveries/custom/outbound-v1/{type}/{id} | Save a custom outbound document |
| [**voidDocument3()**](WarehouseCustomOutboundDocumentApi.md#voidDocument3) | **PUT** /api/warehouse/documentdeliveries/custom/outbound-v1/{type}/{id}/void | Void custom outbound document |


## `get13()`

```php
get13($type, $id): \Fortnox\Model\WarehouseCustomOutboundDocument
```

Get custom outbound document

### Example

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



$apiInstance = new Fortnox\Api\WarehouseCustomOutboundDocumentApi(
    // 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()
);
$type = 'type_example'; // string | document type
$id = 'id_example'; // string | document id

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **type** | **string**| document type | |
| **id** | **string**| document id | |

### Return type

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

## `release5()`

```php
release5($type, $id)
```

Release custom outbound document

### Example

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



$apiInstance = new Fortnox\Api\WarehouseCustomOutboundDocumentApi(
    // 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()
);
$type = 'type_example'; // string | document type
$id = 'id_example'; // string | document id

try {
    $apiInstance->release5($type, $id);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseCustomOutboundDocumentApi->release5: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **type** | **string**| document type | |
| **id** | **string**| document id | |

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

## `save1()`

```php
save1($type, $id, $document): \Fortnox\Model\WarehouseCustomOutboundDocument
```

Save a custom outbound document

<br>  If type is not known, it will be registered as belonging to the OUTBOUND category.<br>  If type is an existing custom document type of category INBOUND an error is thrown.<br>  If type is invalid an error is thrown.<br>

### Example

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



$apiInstance = new Fortnox\Api\WarehouseCustomOutboundDocumentApi(
    // 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()
);
$type = 'type_example'; // string | the type of the custom outbound document, min 1 character, max 25 characters, may contain letters A-Z, digits 0-9, underscore (_), and dash (-). Always stored as upper case.
$id = 'id_example'; // string | the id of the custom outbound document, min 1 character, max 25 characters, may only contain digits 0-9
$document = new \Fortnox\Model\WarehouseCustomOutboundDocument(); // \Fortnox\Model\WarehouseCustomOutboundDocument | the <code>CustomOutboundDocument</code> to create

try {
    $result = $apiInstance->save1($type, $id, $document);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseCustomOutboundDocumentApi->save1: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **type** | **string**| the type of the custom outbound document, min 1 character, max 25 characters, may contain letters A-Z, digits 0-9, underscore (_), and dash (-). Always stored as upper case. | |
| **id** | **string**| the id of the custom outbound document, min 1 character, max 25 characters, may only contain digits 0-9 | |
| **document** | [**\Fortnox\Model\WarehouseCustomOutboundDocument**](../Model/WarehouseCustomOutboundDocument.md)| the &lt;code&gt;CustomOutboundDocument&lt;/code&gt; to create | [optional] |

### Return type

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

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: `application/json`
- **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)

## `voidDocument3()`

```php
voidDocument3($type, $id, $force)
```

Void custom outbound document

### Example

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



$apiInstance = new Fortnox\Api\WarehouseCustomOutboundDocumentApi(
    // 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()
);
$type = 'type_example'; // string | document type
$id = 'id_example'; // string | document id
$force = True; // bool | true if the document should be voided even if the document has connected outbounds, defaults to false.

try {
    $apiInstance->voidDocument3($type, $id, $force);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseCustomOutboundDocumentApi->voidDocument3: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **type** | **string**| document type | |
| **id** | **string**| document id | |
| **force** | **bool**| true if the document should be voided even if the document has connected outbounds, defaults to false. | [optional] |

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