yellowgrid-api-ts 3.0.79

package/docs/StockOrderCourierEntity.md

@@ -0,0 +1,27 @@
+# StockOrderCourierEntity
+
+DistCourierEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**company** | **string** | company | [optional] [default to undefined]
+**name** | **string** | name | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderCourierEntity } from 'yellowgrid-api-ts';
+
+const instance: StockOrderCourierEntity = {
+    id,
+    company,
+    name,
+    email,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderDeductionModel.md

@@ -0,0 +1,27 @@
+# StockOrderDeductionModel
+
+Stock Order Deduction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+**reason** | **string** | reason | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderDeductionModel } from 'yellowgrid-api-ts';
+
+const instance: StockOrderDeductionModel = {
+    id,
+    orderId,
+    amount,
+    reason,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderDeductionRequestModel.md

@@ -0,0 +1,23 @@
+# StockOrderDeductionRequestModel
+
+Stock Order Deduction Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **number** | Amount | [optional] [default to undefined]
+**reason** | **string** | Reason | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderDeductionRequestModel } from 'yellowgrid-api-ts';
+
+const instance: StockOrderDeductionRequestModel = {
+    amount,
+    reason,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderDeductionsEntity.md

@@ -0,0 +1,27 @@
+# StockOrderDeductionsEntity
+
+DistDeductionsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**amount** | **number** | amount | [optional] [default to undefined]
+**reason** | **string** | reason | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderDeductionsEntity } from 'yellowgrid-api-ts';
+
+const instance: StockOrderDeductionsEntity = {
+    id,
+    orderId,
+    amount,
+    reason,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderEntity.md

@@ -0,0 +1,63 @@
+# StockOrderEntity
+
+DistOrderEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**status** | **number** | status | [optional] [default to undefined]
+**orderDate** | **string** | orderDate | [optional] [default to undefined]
+**supplierId** | **number** | manId | [optional] [default to undefined]
+**poNumber** | **string** | poNumber | [optional] [default to undefined]
+**exchangeRate** | **number** | exchRate | [optional] [default to undefined]
+**total** | **number** | total | [optional] [default to undefined]
+**supplierEmailSent** | **string** | manEmailSent | [optional] [default to undefined]
+**paid** | **number** | paid | [optional] [default to undefined]
+**weight** | **number** | weight | [optional] [default to undefined]
+**dimensions** | **number** | dims | [optional] [default to undefined]
+**supplierInvoice** | **string** | manInv | [optional] [default to undefined]
+**courierId** | **number** | courierId | [optional] [default to undefined]
+**deliveryMethod** | **string** | delMethod | [optional] [default to undefined]
+**deliveryType** | **string** | delType | [optional] [default to undefined]
+**courierQuote** | **string** | courierQuote | [optional] [default to undefined]
+**deliveryCost** | **number** | delCost | [optional] [default to undefined]
+**deliveryDuty** | **number** | delDuty | [optional] [default to undefined]
+**deliveryPaid** | **number** | delPaid | [optional] [default to undefined]
+**dutyPaid** | **number** | dutyPaid | [optional] [default to undefined]
+**shipmentId** | **string** | delId | [optional] [default to undefined]
+**deliveryDate** | **string** | delDate | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderEntity } from 'yellowgrid-api-ts';
+
+const instance: StockOrderEntity = {
+    id,
+    status,
+    orderDate,
+    supplierId,
+    poNumber,
+    exchangeRate,
+    total,
+    supplierEmailSent,
+    paid,
+    weight,
+    dimensions,
+    supplierInvoice,
+    courierId,
+    deliveryMethod,
+    deliveryType,
+    courierQuote,
+    deliveryCost,
+    deliveryDuty,
+    deliveryPaid,
+    dutyPaid,
+    shipmentId,
+    deliveryDate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderItemEntity.md

@@ -0,0 +1,33 @@
+# StockOrderItemEntity
+
+DistItemsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**itemId** | **number** | itemId | [optional] [default to undefined]
+**note** | **string** | note | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
+**price** | **number** | price | [optional] [default to undefined]
+**received** | **number** | received | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderItemEntity } from 'yellowgrid-api-ts';
+
+const instance: StockOrderItemEntity = {
+    id,
+    orderId,
+    itemId,
+    note,
+    quantity,
+    price,
+    received,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderItemModel.md

@@ -0,0 +1,37 @@
+# StockOrderItemModel
+
+Stock Order Item
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**orderId** | **number** | orderId | [optional] [default to undefined]
+**itemId** | **number** | itemId | [optional] [default to undefined]
+**note** | **string** | note | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
+**price** | **number** | price | [optional] [default to undefined]
+**received** | **number** | received | [optional] [default to undefined]
+**sku** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderItemModel } from 'yellowgrid-api-ts';
+
+const instance: StockOrderItemModel = {
+    id,
+    orderId,
+    itemId,
+    note,
+    quantity,
+    price,
+    received,
+    sku,
+    title,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderItemRequestModel.md

@@ -0,0 +1,27 @@
+# StockOrderItemRequestModel
+
+Stock Order Item Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**sku** | **string** | SKU | [optional] [default to undefined]
+**quantity** | **number** | Quantity | [optional] [default to undefined]
+**price** | **number** | Price | [optional] [default to undefined]
+**note** | **string** | Item Note | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderItemRequestModel } from 'yellowgrid-api-ts';
+
+const instance: StockOrderItemRequestModel = {
+    sku,
+    quantity,
+    price,
+    note,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderModel.md

@@ -0,0 +1,49 @@
+# StockOrderModel
+
+Stock Order
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID | [optional] [default to undefined]
+**reference** | **string** | Reference | [optional] [default to undefined]
+**poNumber** | **string** | Purchase Order Number | [optional] [default to undefined]
+**supplierId** | **number** | Supplier ID | [optional] [default to undefined]
+**deliveryDate** | **string** | Delivery Due Date | [optional] [default to undefined]
+**shipmentId** | **string** | Tracking ID | [optional] [default to undefined]
+**deliveryMethod** | **string** | Delivery Method | [optional] [default to undefined]
+**deliveryCost** | **number** | Delivery Cost | [optional] [default to undefined]
+**exchangeRate** | **number** | Exchange Rate | [optional] [default to undefined]
+**weight** | **number** | Weight | [optional] [default to undefined]
+**dimensions** | **number** | dimensions | [optional] [default to undefined]
+**paid** | **number** | Status | [optional] [default to undefined]
+**totals** | [**OrderTotalModel**](OrderTotalModel.md) |  | [optional] [default to undefined]
+**items** | [**Array<StockOrderItemModel>**](StockOrderItemModel.md) | items | [optional] [default to undefined]
+**deductions** | [**Array<StockOrderDeductionsEntity>**](StockOrderDeductionsEntity.md) | deductions | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderModel } from 'yellowgrid-api-ts';
+
+const instance: StockOrderModel = {
+    id,
+    reference,
+    poNumber,
+    supplierId,
+    deliveryDate,
+    shipmentId,
+    deliveryMethod,
+    deliveryCost,
+    exchangeRate,
+    weight,
+    dimensions,
+    paid,
+    totals,
+    items,
+    deductions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderProductEntity.md

@@ -0,0 +1,31 @@
+# StockOrderProductEntity
+
+DistPricesEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**manufacturerId** | **number** | manId | [optional] [default to undefined]
+**sku** | **string** | sku | [optional] [default to undefined]
+**title** | **string** | title | [optional] [default to undefined]
+**price** | **number** | price | [optional] [default to undefined]
+**carton** | **number** | carton | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderProductEntity } from 'yellowgrid-api-ts';
+
+const instance: StockOrderProductEntity = {
+    id,
+    manufacturerId,
+    sku,
+    title,
+    price,
+    carton,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderRequestModel.md

@@ -0,0 +1,25 @@
+# StockOrderRequestModel
+
+Stock Order Request
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**supplierId** | **number** | Supplier ID | [optional] [default to undefined]
+**items** | [**Array<StockOrderItemRequestModel>**](StockOrderItemRequestModel.md) | Items | [optional] [default to undefined]
+**deductions** | [**Array<StockOrderDeductionRequestModel>**](StockOrderDeductionRequestModel.md) | Deductions | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderRequestModel } from 'yellowgrid-api-ts';
+
+const instance: StockOrderRequestModel = {
+    supplierId,
+    items,
+    deductions,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderSupplierEntity.md

@@ -0,0 +1,37 @@
+# StockOrderSupplierEntity
+
+DistManufacturerEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**company** | **string** | company | [optional] [default to undefined]
+**name** | **string** | name | [optional] [default to undefined]
+**address** | **string** | address | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+**cur** | **string** | cur | [optional] [default to undefined]
+**tariff** | **string** | tariff | [optional] [default to undefined]
+**xeroId** | **string** | xeroAccNo | [optional] [default to undefined]
+**supplierId** | **number** | supplierId | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderSupplierEntity } from 'yellowgrid-api-ts';
+
+const instance: StockOrderSupplierEntity = {
+    id,
+    company,
+    name,
+    address,
+    email,
+    cur,
+    tariff,
+    xeroId,
+    supplierId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrderSupplierModel.md

@@ -0,0 +1,37 @@
+# StockOrderSupplierModel
+
+Stock Order Supplier
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**company** | **string** | company | [optional] [default to undefined]
+**name** | **string** | name | [optional] [default to undefined]
+**address** | **string** | address | [optional] [default to undefined]
+**email** | **string** | email | [optional] [default to undefined]
+**cur** | **string** | cur | [optional] [default to undefined]
+**tariff** | **string** | tariff | [optional] [default to undefined]
+**xeroId** | **string** | xeroAccNo | [optional] [default to undefined]
+**supplierId** | **number** | supplierId | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrderSupplierModel } from 'yellowgrid-api-ts';
+
+const instance: StockOrderSupplierModel = {
+    id,
+    company,
+    name,
+    address,
+    email,
+    cur,
+    tariff,
+    xeroId,
+    supplierId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockOrdersModel.md

@@ -0,0 +1,27 @@
+# StockOrdersModel
+
+Stock Orders
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<StockOrderModel>**](StockOrderModel.md) | Results | [optional] [default to undefined]
+**page** | **number** | Page | [optional] [default to undefined]
+**perPage** | **number** | Per Page | [optional] [default to undefined]
+**totalResults** | **number** | Total Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockOrdersModel } from 'yellowgrid-api-ts';
+
+const instance: StockOrdersModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockProductModel.md

@@ -0,0 +1,49 @@
+# StockProductModel
+
+Stock Product
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**manufacturerId** | **number** | manId | [optional] [default to undefined]
+**sku** | **string** | sku | [optional] [default to undefined]
+**title** | **string** | title | [optional] [default to undefined]
+**price** | **number** | price | [optional] [default to undefined]
+**carton** | **number** | carton | [optional] [default to undefined]
+**manufacturer** | [**StockOrderSupplierModel**](StockOrderSupplierModel.md) |  | [optional] [default to undefined]
+**attributeSet** | [**AttributeSetEnum**](AttributeSetEnum.md) |  | [optional] [default to undefined]
+**stock** | **number** | Current Quantity | [optional] [default to undefined]
+**weight** | **number** | Weight (KG) | [optional] [default to undefined]
+**ean** | **string** | EAN | [optional] [default to undefined]
+**serialPrefix** | **string** | Serial Prefix | [optional] [default to undefined]
+**tcxLabel** | **string** | 3CX Phone Label | [optional] [default to undefined]
+**tcxTemplate** | [**TcxTemplateXmlEnum**](TcxTemplateXmlEnum.md) |  | [optional] [default to undefined]
+**salesPrices** | [**Array<StockProductPriceModel>**](StockProductPriceModel.md) | Prices | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockProductModel } from 'yellowgrid-api-ts';
+
+const instance: StockProductModel = {
+    id,
+    manufacturerId,
+    sku,
+    title,
+    price,
+    carton,
+    manufacturer,
+    attributeSet,
+    stock,
+    weight,
+    ean,
+    serialPrefix,
+    tcxLabel,
+    tcxTemplate,
+    salesPrices,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockProductPriceModel.md

@@ -0,0 +1,23 @@
+# StockProductPriceModel
+
+Stock Product Price
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**priceList** | [**CustomerPriceListEnum**](CustomerPriceListEnum.md) |  | [optional] [default to undefined]
+**price** | **number** | Price (£) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockProductPriceModel } from 'yellowgrid-api-ts';
+
+const instance: StockProductPriceModel = {
+    priceList,
+    price,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockProductSummariesModel.md

@@ -0,0 +1,27 @@
+# StockProductSummariesModel
+
+Stock Products
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<StockProductSummaryModel>**](StockProductSummaryModel.md) | Results | [optional] [default to undefined]
+**page** | **number** | Page | [optional] [default to undefined]
+**perPage** | **number** | Per Page | [optional] [default to undefined]
+**totalResults** | **number** | Total Results | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockProductSummariesModel } from 'yellowgrid-api-ts';
+
+const instance: StockProductSummariesModel = {
+    results,
+    page,
+    perPage,
+    totalResults,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockProductSummaryModel.md

@@ -0,0 +1,33 @@
+# StockProductSummaryModel
+
+Stock Product Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**manufacturerId** | **number** | manId | [optional] [default to undefined]
+**sku** | **string** | sku | [optional] [default to undefined]
+**title** | **string** | title | [optional] [default to undefined]
+**price** | **number** | price | [optional] [default to undefined]
+**carton** | **number** | carton | [optional] [default to undefined]
+**manufacturer** | [**StockOrderSupplierModel**](StockOrderSupplierModel.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockProductSummaryModel } from 'yellowgrid-api-ts';
+
+const instance: StockProductSummaryModel = {
+    id,
+    manufacturerId,
+    sku,
+    title,
+    price,
+    carton,
+    manufacturer,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/StockTransactionsEntity.md

@@ -0,0 +1,35 @@
+# StockTransactionsEntity
+
+StockTransactionsEntity
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | id | [optional] [default to undefined]
+**sku** | **string** | sku | [optional] [default to undefined]
+**initialStock** | **number** | initialStock | [optional] [default to undefined]
+**action** | **string** | action | [optional] [default to undefined]
+**quantity** | **number** | quantity | [optional] [default to undefined]
+**currentStock** | **number** | currentStock | [optional] [default to undefined]
+**timestamp** | **string** | timestamp | [optional] [default to undefined]
+**user** | **number** | user | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { StockTransactionsEntity } from 'yellowgrid-api-ts';
+
+const instance: StockTransactionsEntity = {
+    id,
+    sku,
+    initialStock,
+    action,
+    quantity,
+    currentStock,
+    timestamp,
+    user,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)