yellowgrid-api-ts 3.0.79

package/docs/StockManagementApi.md

@@ -0,0 +1,1380 @@
+# StockManagementApi
+
+All URIs are relative to *http://api.yellowgrid.local*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteDeleteStockOrder**](#deletedeletestockorder) | **DELETE** /stock/orders/{id} | Delete Stock Order|
+|[**deleteDeleteStockOrderDeduction**](#deletedeletestockorderdeduction) | **DELETE** /stock/orders/{order_id}/deductions/{deduction_id} | Delete Stock Order Deduction|
+|[**deleteDeleteStockOrderItem**](#deletedeletestockorderitem) | **DELETE** /stock/orders/{order_id}/items/{item_id} | Delete Stock Order Item|
+|[**deleteGetStockProduct**](#deletegetstockproduct) | **DELETE** /stock/products/{id} | Delete Stock Product|
+|[**getDeleteStockOrder**](#getdeletestockorder) | **GET** /stock/orders/{id} | Get Stock Order|
+|[**getGetProductDetails**](#getgetproductdetails) | **GET** /stock/products/{sku}/details | Get Product Details|
+|[**getGetStockOrderPurchaseOrder**](#getgetstockorderpurchaseorder) | **GET** /stock/orders/{id}/po | Get Stock Order Purchase Order|
+|[**getGetStockOrderSupplierEmail**](#getgetstockordersupplieremail) | **GET** /stock/orders/{id}/supplier/email | Get Stock Product Supplier Email mailto|
+|[**getGetStockOrders**](#getgetstockorders) | **GET** /stock/orders | Get Stock Orders|
+|[**getGetStockProduct**](#getgetstockproduct) | **GET** /stock/products/{id} | Get Stock Product|
+|[**getGetStockProductSuppliers**](#getgetstockproductsuppliers) | **GET** /stock/suppliers | Get Stock Product Suppliers|
+|[**getGetStockProducts**](#getgetstockproducts) | **GET** /stock/products | Get Stock Products|
+|[**getGetStockSupplierProducts**](#getgetstocksupplierproducts) | **GET** /stock/suppliers/{id}/products | Get Stock Supplier\'s Products|
+|[**getUploadStockOrderInvoice**](#getuploadstockorderinvoice) | **GET** /stock/orders/{id}/invoice | Get Stock Order Supplier Invoice|
+|[**patchDeleteStockOrder**](#patchdeletestockorder) | **PATCH** /stock/orders/{id} | Update Stock Order|
+|[**patchDeleteStockOrderDeduction**](#patchdeletestockorderdeduction) | **PATCH** /stock/orders/{order_id}/deductions/{deduction_id} | Update Stock Order Deduction|
+|[**patchDeleteStockOrderItem**](#patchdeletestockorderitem) | **PATCH** /stock/orders/{order_id}/items/{item_id} | Update Stock Order Item|
+|[**postAddStockOrderDeduction**](#postaddstockorderdeduction) | **POST** /stock/orders/{id}/deductions | Add Stock Order Deductions|
+|[**postAddStockOrderItem**](#postaddstockorderitem) | **POST** /stock/orders/{id}/items | Add Stock Order Items|
+|[**postGetStockOrders**](#postgetstockorders) | **POST** /stock/orders | Create New Stock Order|
+|[**postGetStockProducts**](#postgetstockproducts) | **POST** /stock/products | Create Stock Product|
+|[**postUploadStockOrderInvoice**](#postuploadstockorderinvoice) | **POST** /stock/orders/{id}/invoice | Upload Stock Order Supplier Invoice|
+|[**putGetStockProduct**](#putgetstockproduct) | **PUT** /stock/products/{id} | Update Stock Product|
+|[**putReceiveStockOrderItem**](#putreceivestockorderitem) | **PUT** /stock/orders/{order_id}/items/{item_id}/receive | Receive Stock Order Item|
+
+# **deleteDeleteStockOrder**
+> deleteDeleteStockOrder()
+
+Delete Stock Order
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Order ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeleteStockOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Stock Order ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteDeleteStockOrderDeduction**
+> deleteDeleteStockOrderDeduction()
+
+Delete Stock Order Deduction
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let orderId: number; //Stock Order ID (default to undefined)
+let deductionId: number; //Stock Order Deduction ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeleteStockOrderDeduction(
+    orderId,
+    deductionId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderId** | [**number**] | Stock Order ID | defaults to undefined|
+| **deductionId** | [**number**] | Stock Order Deduction ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteDeleteStockOrderItem**
+> deleteDeleteStockOrderItem()
+
+Delete Stock Order Item
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let orderId: number; //Stock Order ID (default to undefined)
+let itemId: number; //Stock Order Item ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteDeleteStockOrderItem(
+    orderId,
+    itemId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderId** | [**number**] | Stock Order ID | defaults to undefined|
+| **itemId** | [**number**] | Stock Order Item ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteGetStockProduct**
+> deleteGetStockProduct()
+
+Delete Stock Product
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Product ID (default to undefined)
+
+const { status, data } = await apiInstance.deleteGetStockProduct(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Stock Product ID | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getDeleteStockOrder**
+> StockOrderModel getDeleteStockOrder()
+
+Get Stock Order
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Order ID (default to undefined)
+
+const { status, data } = await apiInstance.getDeleteStockOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Stock Order ID | defaults to undefined|
+
+
+### Return type
+
+**StockOrderModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getGetProductDetails**
+> StockProductModel getGetProductDetails()
+
+Get Product Details
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let sku: string; //Product SKU (default to undefined)
+
+const { status, data } = await apiInstance.getGetProductDetails(
+    sku
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sku** | [**string**] | Product SKU | defaults to undefined|
+
+
+### Return type
+
+**StockProductModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Product |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getGetStockOrderPurchaseOrder**
+> GenericFileModel getGetStockOrderPurchaseOrder()
+
+Get Stock Order Purchase Order
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Order ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetStockOrderPurchaseOrder(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Stock Order ID | defaults to undefined|
+
+
+### Return type
+
+**GenericFileModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order Invoice |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getGetStockOrderSupplierEmail**
+> string getGetStockOrderSupplierEmail()
+
+Get Stock Product Supplier Email mailto
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Order ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetStockOrderSupplierEmail(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Stock Order ID | defaults to undefined|
+
+
+### Return type
+
+**string**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | string |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getGetStockOrders**
+> StockOrdersModel getGetStockOrders()
+
+Get Stock Orders
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+let outstanding: boolean; //Outstanding Orders (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetStockOrders(
+    pageSize,
+    page,
+    search,
+    outstanding
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+| **outstanding** | [**boolean**] | Outstanding Orders | (optional) defaults to undefined|
+
+
+### Return type
+
+**StockOrdersModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Orders |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getGetStockProduct**
+> StockProductModel getGetStockProduct()
+
+Get Stock Product
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Product ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetStockProduct(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Stock Product ID | defaults to undefined|
+
+
+### Return type
+
+**StockProductModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Product |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getGetStockProductSuppliers**
+> Array<StockOrderSupplierModel> getGetStockProductSuppliers()
+
+Get Stock Product Suppliers
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+const { status, data } = await apiInstance.getGetStockProductSuppliers();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<StockOrderSupplierModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order Suppliers |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getGetStockProducts**
+> StockProductSummariesModel getGetStockProducts()
+
+Get Stock Products
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let pageSize: number; //Number Of Results (optional) (default to 20)
+let page: number; //Page Number (optional) (default to 1)
+let search: string; //Search (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getGetStockProducts(
+    pageSize,
+    page,
+    search
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pageSize** | [**number**] | Number Of Results | (optional) defaults to 20|
+| **page** | [**number**] | Page Number | (optional) defaults to 1|
+| **search** | [**string**] | Search | (optional) defaults to undefined|
+
+
+### Return type
+
+**StockProductSummariesModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Product Summaries |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getGetStockSupplierProducts**
+> Array<ProductSummaryModel> getGetStockSupplierProducts()
+
+Get Stock Supplier\'s Products
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Supplier ID (default to undefined)
+
+const { status, data } = await apiInstance.getGetStockSupplierProducts(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Supplier ID | defaults to undefined|
+
+
+### Return type
+
+**Array<ProductSummaryModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Products |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getUploadStockOrderInvoice**
+> GenericFileModel getUploadStockOrderInvoice()
+
+Get Stock Order Supplier Invoice
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Order ID (default to undefined)
+
+const { status, data } = await apiInstance.getUploadStockOrderInvoice(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Stock Order ID | defaults to undefined|
+
+
+### Return type
+
+**GenericFileModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order Invoice |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **patchDeleteStockOrder**
+> StockOrderModel patchDeleteStockOrder()
+
+Update Stock Order
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration,
+    StockOrderModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Order ID (default to undefined)
+let stockOrderModel: StockOrderModel; // (optional)
+
+const { status, data } = await apiInstance.patchDeleteStockOrder(
+    id,
+    stockOrderModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stockOrderModel** | **StockOrderModel**|  | |
+| **id** | [**number**] | Stock Order ID | defaults to undefined|
+
+
+### Return type
+
+**StockOrderModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **patchDeleteStockOrderDeduction**
+> StockOrderDeductionModel patchDeleteStockOrderDeduction()
+
+Update Stock Order Deduction
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration,
+    StockOrderDeductionModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let orderId: number; //Stock Order ID (default to undefined)
+let deductionId: number; //Stock Order Deduction ID (default to undefined)
+let stockOrderDeductionModel: StockOrderDeductionModel; // (optional)
+
+const { status, data } = await apiInstance.patchDeleteStockOrderDeduction(
+    orderId,
+    deductionId,
+    stockOrderDeductionModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stockOrderDeductionModel** | **StockOrderDeductionModel**|  | |
+| **orderId** | [**number**] | Stock Order ID | defaults to undefined|
+| **deductionId** | [**number**] | Stock Order Deduction ID | defaults to undefined|
+
+
+### Return type
+
+**StockOrderDeductionModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order Deduction |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **patchDeleteStockOrderItem**
+> StockOrderItemModel patchDeleteStockOrderItem()
+
+Update Stock Order Item
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration,
+    StockOrderItemModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let orderId: number; //Stock Order ID (default to undefined)
+let itemId: number; //Stock Order Item ID (default to undefined)
+let stockOrderItemModel: StockOrderItemModel; // (optional)
+
+const { status, data } = await apiInstance.patchDeleteStockOrderItem(
+    orderId,
+    itemId,
+    stockOrderItemModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stockOrderItemModel** | **StockOrderItemModel**|  | |
+| **orderId** | [**number**] | Stock Order ID | defaults to undefined|
+| **itemId** | [**number**] | Stock Order Item ID | defaults to undefined|
+
+
+### Return type
+
+**StockOrderItemModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order Item |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **postAddStockOrderDeduction**
+> Array<StockOrderDeductionModel> postAddStockOrderDeduction()
+
+Add Stock Order Deductions
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Order ID (default to undefined)
+let stockOrderDeductionRequestModel: Array<StockOrderDeductionRequestModel>; // (optional)
+
+const { status, data } = await apiInstance.postAddStockOrderDeduction(
+    id,
+    stockOrderDeductionRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stockOrderDeductionRequestModel** | **Array<StockOrderDeductionRequestModel>**|  | |
+| **id** | [**number**] | Stock Order ID | defaults to undefined|
+
+
+### Return type
+
+**Array<StockOrderDeductionModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order Deductions |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **postAddStockOrderItem**
+> Array<StockOrderItemModel> postAddStockOrderItem()
+
+Add Stock Order Items
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Order ID (default to undefined)
+let stockOrderItemRequestModel: Array<StockOrderItemRequestModel>; // (optional)
+
+const { status, data } = await apiInstance.postAddStockOrderItem(
+    id,
+    stockOrderItemRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stockOrderItemRequestModel** | **Array<StockOrderItemRequestModel>**|  | |
+| **id** | [**number**] | Stock Order ID | defaults to undefined|
+
+
+### Return type
+
+**Array<StockOrderItemModel>**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order Items |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **postGetStockOrders**
+> StockOrderModel postGetStockOrders()
+
+Create New Stock Order
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration,
+    StockOrderRequestModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let stockOrderRequestModel: StockOrderRequestModel; // (optional)
+
+const { status, data } = await apiInstance.postGetStockOrders(
+    stockOrderRequestModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stockOrderRequestModel** | **StockOrderRequestModel**|  | |
+
+
+### Return type
+
+**StockOrderModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Order |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **postGetStockProducts**
+> StockProductModel postGetStockProducts()
+
+Create Stock Product
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration,
+    StockProductModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let stockProductModel: StockProductModel; //Stock Product (optional)
+
+const { status, data } = await apiInstance.postGetStockProducts(
+    stockProductModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stockProductModel** | **StockProductModel**| Stock Product | |
+
+
+### Return type
+
+**StockProductModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Product |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **postUploadStockOrderInvoice**
+> postUploadStockOrderInvoice()
+
+Upload Stock Order Supplier Invoice
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Order ID (default to undefined)
+let invoice: File; //Supplier Invoice (default to undefined)
+
+const { status, data } = await apiInstance.postUploadStockOrderInvoice(
+    id,
+    invoice
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**number**] | Stock Order ID | defaults to undefined|
+| **invoice** | [**File**] | Supplier Invoice | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **putGetStockProduct**
+> StockProductModel putGetStockProduct()
+
+Update Stock Product
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration,
+    StockProductModel
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let id: number; //Stock Product ID (default to undefined)
+let stockProductModel: StockProductModel; //Stock Product (optional)
+
+const { status, data } = await apiInstance.putGetStockProduct(
+    id,
+    stockProductModel
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **stockProductModel** | **StockProductModel**| Stock Product | |
+| **id** | [**number**] | Stock Product ID | defaults to undefined|
+
+
+### Return type
+
+**StockProductModel**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Stock Product |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **putReceiveStockOrderItem**
+> putReceiveStockOrderItem()
+
+Receive Stock Order Item
+
+### Example
+
+```typescript
+import {
+    StockManagementApi,
+    Configuration
+} from 'yellowgrid-api-ts';
+
+const configuration = new Configuration();
+const apiInstance = new StockManagementApi(configuration);
+
+let orderId: number; //Stock Order ID (default to undefined)
+let itemId: number; //Stock Order Item ID (default to undefined)
+let received: number; //Quantity Received (default to undefined)
+
+const { status, data } = await apiInstance.putReceiveStockOrderItem(
+    orderId,
+    itemId,
+    received
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderId** | [**number**] | Stock Order ID | defaults to undefined|
+| **itemId** | [**number**] | Stock Order Item ID | defaults to undefined|
+| **received** | [**number**] | Quantity Received | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | No Response |  -  |
+|**400** | Bad Request |  -  |
+|**401** | Unauthorised |  -  |
+|**403** | Access Denied |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+