# Fortnox\WarehouseManualInboundDocumentApi



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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**create()**](WarehouseManualInboundDocumentApi.md#create) | **POST** /api/warehouse/deliveries-v1/inbounddeliveries | Create manual inbound document |
| [**get()**](WarehouseManualInboundDocumentApi.md#get) | **GET** /api/warehouse/deliveries-v1/inbounddeliveries/{id} | Get manual inbound document |
| [**release()**](WarehouseManualInboundDocumentApi.md#release) | **PUT** /api/warehouse/deliveries-v1/inbounddeliveries/{id}/release | Release manual inbound document |
| [**update()**](WarehouseManualInboundDocumentApi.md#update) | **PUT** /api/warehouse/deliveries-v1/inbounddeliveries/{id} | Update manual inbound document |
| [**updateNote()**](WarehouseManualInboundDocumentApi.md#updateNote) | **PATCH** /api/warehouse/deliveries-v1/inbounddeliveries/{id} | Update note on manual inbound document |
| [**voidDocument()**](WarehouseManualInboundDocumentApi.md#voidDocument) | **PUT** /api/warehouse/deliveries-v1/inbounddeliveries/{id}/void | Void manual inbound document |


## `create()`

```php
create($manual_inbound_document): \Fortnox\Model\WarehouseManualInboundDocument
```

Create manual inbound document

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

### Example

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



$apiInstance = new Fortnox\Api\WarehouseManualInboundDocumentApi(
    // 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_inbound_document = new \Fortnox\Model\WarehouseManualInboundDocument(); // \Fortnox\Model\WarehouseManualInboundDocument | manual inbound document

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **manual_inbound_document** | [**\Fortnox\Model\WarehouseManualInboundDocument**](../Model/WarehouseManualInboundDocument.md)| manual inbound document | [optional] |

### Return type

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

## `get()`

```php
get($id): \Fortnox\Model\WarehouseManualInboundDocument
```

Get manual inbound document

### Example

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



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

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

### Parameters

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

### Return type

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

## `release()`

```php
release($id)
```

Release manual inbound 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\WarehouseManualInboundDocumentApi(
    // 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 Inbound document id.

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

### Parameters

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

## `update()`

```php
update($id, $manual_inbound_document): \Fortnox\Model\WarehouseManualInboundDocument
```

Update manual inbound document

### Example

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



$apiInstance = new Fortnox\Api\WarehouseManualInboundDocumentApi(
    // 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 Inbound document id.
$manual_inbound_document = new \Fortnox\Model\WarehouseManualInboundDocument(); // \Fortnox\Model\WarehouseManualInboundDocument | Manual Inbound document

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **int**| Manual Inbound document id. | |
| **manual_inbound_document** | [**\Fortnox\Model\WarehouseManualInboundDocument**](../Model/WarehouseManualInboundDocument.md)| Manual Inbound document | [optional] |

### Return type

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

## `updateNote()`

```php
updateNote($id, $manual_inbound_document_patch)
```

Update note on manual inbound document

<p>  When a Manual Inbound 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\WarehouseManualInboundDocumentApi(
    // 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 Inbound document id.
$manual_inbound_document_patch = new \Fortnox\Model\WarehouseManualInboundDocumentPatch(); // \Fortnox\Model\WarehouseManualInboundDocumentPatch | Note.

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **int**| Manual Inbound document id. | |
| **manual_inbound_document_patch** | [**\Fortnox\Model\WarehouseManualInboundDocumentPatch**](../Model/WarehouseManualInboundDocumentPatch.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)

## `voidDocument()`

```php
voidDocument($id, $force, $custom_void_date)
```

Void manual inbound document

<p>  A released manual inbound document might have connected outbounds, and can only be force voided.  Note that a force void operation might cause a negative stock.  <p>  The following error codes might be thrown:   <dl>   <dt>void_linked_outbound</dt>     <dd>If this document has any outbounds transactions connected to it.</dd>   </dl>

### Example

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



$apiInstance = new Fortnox\Api\WarehouseManualInboundDocumentApi(
    // 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 Inbound document id.
$force = True; // bool | true if we should force void, defaults to false
$custom_void_date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | date the void operation should be bookkeept on

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **id** | **int**| Manual Inbound document id. | |
| **force** | **bool**| true if we should force void, defaults to false | [optional] |
| **custom_void_date** | **\DateTime**| date the void operation should be bookkeept on | [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)
