mirrors/homebox
1
0
Fork 1
mirror of https://github.com/hay-kot/homebox.git synced 2025-08-05 09:10:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

add docs

Browse source
This commit is contained in:
Hayden 2022-10-15 17:42:11 -08:00
parent 0c1b92ae6f
commit b2ae04f3e4
1 changed files with 23 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

46
docs/docs/import-csv.md
View file

@ -23,29 +23,29 @@ Import RefLocation Labels Quantity Name Description Insured Serial Number Model
## CSV Reference ## CSV Reference
| Column | Type | Description | | Column | Type | Description |
| ----------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | ----------------- | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| ImportRef | String (100) | Future | | ImportRef | String (100) | Import Refs are unique strings that can be used to deduplicate imports. Before an item is imported, we check the database for a matching ref. If the ref exists, we skip that item. |
| Location | String | This is the location of the item that will be created. These are de-duplicated and won't create another instance when reused. | | Location | String | This is the location of the item that will be created. These are de-duplicated and won't create another instance when reused. |
| Labels | `;` Separated String | List of labels to apply to the item separated by a `;`, can be existing or new | | Labels | `;` Separated String | List of labels to apply to the item separated by a `;`, can be existing or new |
| Quantity | Integer | The quantity of items to create | | Quantity | Integer | The quantity of items to create |
| Name | String | Name of the item | | Name | String | Name of the item |
| Description | String | Description of the item | | Description | String | Description of the item |
| Insured | Boolean | Whether or not the item is insured | | Insured | Boolean | Whether or not the item is insured |
| Serial Number | String | Serial number of the item | | Serial Number | String | Serial number of the item |
| Model Number | String | Model of the item | | Model Number | String | Model of the item |
| Manufacturer | String | Manufacturer of the item | | Manufacturer | String | Manufacturer of the item |
| Notes | String (1000) | General notes about the product | | Notes | String (1000) | General notes about the product |
| Purchase From | String | Name of the place the item was purchased from | | Purchase From | String | Name of the place the item was purchased from |
| Purchase Price | Float64 | | | Purchase Price | Float64 | |
| Purchase At | Date | Date the item was purchased | | Purchase At | Date | Date the item was purchased |
| Lifetime Warranty | Boolean | true or false - case insensitive | | Lifetime Warranty | Boolean | true or false - case insensitive |
| Warranty Expires | Date | Date in the format | | Warranty Expires | Date | Date in the format |
| Warranty Details | String | Details about the warranty | | Warranty Details | String | Details about the warranty |
| Sold To | String | Name of the person the item was sold to | | Sold To | String | Name of the person the item was sold to |
| Sold At | Date | Date the item was sold | | Sold At | Date | Date the item was sold |
| Sold Price | Float64 | | | Sold Price | Float64 | |
| Sold Notes | String (1000) | | | Sold Notes | String (1000) | |
**Type Key** **Type Key**