# # Consignment

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **string** | Auto-generated object ID. | [optional]
**outlet_id** | **string** | A valid ID of an outlet where stock will be received. |
**name** | **string** | Tue 29 Nov 2016 (string) - Consignment name. For orders, the note field in the UI will be the name value. |
**consignment_date** | **string** | 11-28T19:02:15+00:00 (timestamp) - Consignment creation date. | [optional]
**due_at** | **string** | 11-30T19:08:541+00:00 (timestamp) - Due date. | [optional]
**received_at** | **string** | 11-30T19:08:541+00:00 (timestamp) - The date when consignment was received. | [optional]
**type** | **string** | One of &#x60;SUPPLIER&#x60;, &#x60;OUTLET&#x60;, &#x60;STOCKTAKE&#x60;, &#x60;RETURN&#x60;. |
**status** | **string** | * Supplier Order: One of &#x60;OPEN&#x60;, &#x60;SENT&#x60;, &#x60;DISPATCHED&#x60;, &#x60;RECEIVED&#x60;, &#x60;CANCELLED&#x60;  * Outlet Transfer: One of &#x60;OPEN&#x60;, &#x60;SENT&#x60;, &#x60;RECEIVED&#x60;, &#x60;CANCELLED&#x60;  * Return Order: One of &#x60;OPEN&#x60;, &#x60;SENT&#x60;, &#x60;CANCELLED&#x60;  * Stocktake: One of &#x60;STOCKTAKE_SCHEDULED&#x60;, &#x60;STOCKTAKE_IN_PROGRESS&#x60;, &#x60;STOCKTAKE_IN_PROGRESS_PROCESSED&#x60;, &#x60;STOCKTAKE_COMPLETE&#x60;, &#x60;CLOSED&#x60;, &#x60;CANCELLED&#x60;  This is not a definitive list and may be extended in future | [optional]
**supplier_id** | **string** | a valid supplier ID. | [optional]
**source_outlet_id** | **string** | A valid ID of an outlet where stock will come from. **Stock transfers only**. | [optional]
**supplier_invoice** | **string** | Supplier invoice number. | [optional]
**reference** | **string** | Order number.+ &#x60;total_count_gain&#x60; (number) | [optional]
**total_count_gain** | **double** | The number of items over the expected level. | [optional]
**total_cost_gain** | **double** | The cost of items over the expected level. | [optional]
**total_count_loss** | **double** | The number of items below the expected level. | [optional]
**total_cost_loss** | **double** | The cost of items below the expected level. | [optional]
**created_at** | **string** | Creation timestamp in UTC. | [optional]
**updated_at** | **string** | Last update timestamp in UTC. | [optional]
**deleted_at** | **string** | Deletion timestamp in UTC. | [optional]
**version** | **int** | Auto-incrementing object version number. | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
