# Fortnox\WarehouseManualOutboundDocumentApi



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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**create1()**](WarehouseManualOutboundDocumentApi.md#create1) | **POST** /api/warehouse/deliveries-v1/outbounddeliveries | Create manual outbound document |
| [**get1()**](WarehouseManualOutboundDocumentApi.md#get1) | **GET** /api/warehouse/deliveries-v1/outbounddeliveries/{id} | Get manual outbound document |
| [**release1()**](WarehouseManualOutboundDocumentApi.md#release1) | **PUT** /api/warehouse/deliveries-v1/outbounddeliveries/{id}/release | Release manual outbound document |
| [**update1()**](WarehouseManualOutboundDocumentApi.md#update1) | **PUT** /api/warehouse/deliveries-v1/outbounddeliveries/{id} | Update manual outbound document |
| [**updateNote1()**](WarehouseManualOutboundDocumentApi.md#updateNote1) | **PATCH** /api/warehouse/deliveries-v1/outbounddeliveries/{id} | Update note on manual outbound document |
| [**voidDocument1()**](WarehouseManualOutboundDocumentApi.md#voidDocument1) | **PUT** /api/warehouse/deliveries-v1/outbounddeliveries/{id}/void | Void manual outbound document |


## `create1()`

```php
create1($manual_outbound_document): \Fortnox\Model\WarehouseManualOutboundDocument
```

Create manual outbound document

<p>  The <code>id</code> is set automatically.

### Example

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



$apiInstance = new Fortnox\Api\WarehouseManualOutboundDocumentApi(
    // 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()
);
$manual_outbound_document = new \Fortnox\Model\WarehouseManualOutboundDocument(); // \Fortnox\Model\WarehouseManualOutboundDocument | manual outbound document

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **manual_outbound_document** | [**\Fortnox\Model\WarehouseManualOutboundDocument**](../Model/WarehouseManualOutboundDocument.md)| manual outbound document | [optional] |

### Return type

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

## `get1()`

```php
get1($id): \Fortnox\Model\WarehouseManualOutboundDocument
```

Get manual outbound document

### Example

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



$apiInstance = new Fortnox\Api\WarehouseManualOutboundDocumentApi(
    // 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 | Manual Outbound document id.

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **int**| Manual Outbound document id. | |

### Return type

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

## `release1()`

```php
release1($id)
```

Release manual outbound document

<p>  The document will be locked and bookkept.  <p>  The following error codes might be thrown:   <dl>   <dt>cannot_release_later_than_current_date</dt>     <dd>Document date cannot be in the future.</dd>   <dt>document_is_voided</dt>     <dd>Document is voided.</dd>   <dt>period_locked</dt>     <dd>Document date is within a locked bookkeeping period.</dd>   </dl>

### Example

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



$apiInstance = new Fortnox\Api\WarehouseManualOutboundDocumentApi(
    // 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 | Manual Outbound document id.

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **int**| Manual Outbound 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)

## `update1()`

```php
update1($id, $manual_outbound_document): \Fortnox\Model\WarehouseManualOutboundDocument
```

Update manual outbound document

<p>  HTTP code 400 cannot_modify_released_document  HTTP code 400 document_is_voided Document is voided.  HTTP code 404 not found

### Example

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



$apiInstance = new Fortnox\Api\WarehouseManualOutboundDocumentApi(
    // 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 | Manual Outbound document id.
$manual_outbound_document = new \Fortnox\Model\WarehouseManualOutboundDocument(); // \Fortnox\Model\WarehouseManualOutboundDocument | Manual Outbound document.

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **int**| Manual Outbound document id. | |
| **manual_outbound_document** | [**\Fortnox\Model\WarehouseManualOutboundDocument**](../Model/WarehouseManualOutboundDocument.md)| Manual Outbound document. | [optional] |

### Return type

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

## `updateNote1()`

```php
updateNote1($id, $manual_outbound_document_patch)
```

Update note on manual outbound document

<p>  When a Manual Outbound has been released, it is locked.  The <code>note</code> field can still be updated using this endpoint.

### Example

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



$apiInstance = new Fortnox\Api\WarehouseManualOutboundDocumentApi(
    // 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 | Manual Outbound document id
$manual_outbound_document_patch = new \Fortnox\Model\WarehouseManualOutboundDocumentPatch(); // \Fortnox\Model\WarehouseManualOutboundDocumentPatch | Note.

try {
    $apiInstance->updateNote1($id, $manual_outbound_document_patch);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseManualOutboundDocumentApi->updateNote1: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **int**| Manual Outbound document id | |
| **manual_outbound_document_patch** | [**\Fortnox\Model\WarehouseManualOutboundDocumentPatch**](../Model/WarehouseManualOutboundDocumentPatch.md)| Note. | [optional] |

### Return type

void (empty response body)

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

## `voidDocument1()`

```php
voidDocument1($id, $custom_void_date)
```

Void manual outbound document

### Example

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



$apiInstance = new Fortnox\Api\WarehouseManualOutboundDocumentApi(
    // 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 | Manual Outbound document id.
$custom_void_date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | if provided this date will be used as the voided date instead of the document date

try {
    $apiInstance->voidDocument1($id, $custom_void_date);
} catch (Exception $e) {
    echo 'Exception when calling WarehouseManualOutboundDocumentApi->voidDocument1: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **int**| Manual Outbound document id. | |
| **custom_void_date** | **\DateTime**| if provided this date will be used as the voided date instead of the document date | [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)
