Merge pull request #11 from zaicodev/DEV-5808-feat-box-unit

DEV-5808 単位自動換算対応

.gitignore

@@ -101,3 +101,5 @@ typings/
 
 # TernJS port file
 .tern-port
+
+.DS_Store

api.md

@@ -298,8 +298,15 @@ Authorization: Bearer YOUR_TOKEN_HERE
     * inventory_id : 在庫データID
     * title : 物品名
     * quantity : 出庫数量
+    * box_quantity: まとめ換算数量（基本単位で登録された場合はquantityと同じ値）
     * unit : 単位
+    * box_unit : まとめ単位（基本単位で登録された場合はunitと同じ値）
+    * unit_snapshot : 単位自動換算情報（まとめ単位で登録された場合のみ）
+        * piece_name : 基本単位名
+        * box_name : まとめ単位名
+        * factor : 換算値
     * unit_price : 納品単価
+    * subtotal_amount : 小計（box_quantity x box_unit）
     * status : 状態
       * 以下の2つのどちらかが設定されています
       * before_delivery : 出庫前
@@ -367,6 +374,22 @@ Authorization: Bearer YOUR_TOKEN_HERE
                     + delivery_date: `2019-09-01` (string)
                     + estimated_delivery_date (string, optional, nullable)
                     + etc: (string) - 摘要・備考
+                + (object)
+                    + inventory_id: 3 (number)
+                    + title: ビール (string) - 物品名
+                    + quantity: 12 (number) - 出庫数量
+                    + box_quantity: 1 (string) - まとめ換算の入庫数量
+                    + unit: 瓶 (string) - 単位
+                    + box_unit: 箱 (string) - まとめ単位
+                    + unit_price: 100 (number) - 納品単価
+                    + unit_snapshot:
+                        + piece_name: 瓶 (string) - 基本単位名称
+                        + box_name: 箱 (string) - まとめ単位名称
+                        + factor : 12 (string) - 換算値
+                    + status: completed_delivery (string)
+                    + delivery_date: `2019-09-01` (string)
+                    + estimated_delivery_date (string, optional, nullable)
+                    + etc: (string) - 摘要・備考
             + shipping_instruction (ShippingInstructionView)
         + ()
             + id: 11 (number)
@@ -488,8 +511,15 @@ Authorization: Bearer YOUR_TOKEN_HERE
     * inventory_id : 在庫データID
     * title : 物品名
     * quantity : 出庫数量
+    * box_quantity: まとめ換算数量（基本単位で登録された場合はquantityと同じ値）
     * unit : 単位
+    * box_unit : まとめ単位（基本単位で登録された場合はunitと同じ値）
+    * unit_snapshot : 単位自動換算情報（まとめ単位で登録された場合のみ）
+        * piece_name : 基本単位名
+        * box_name : まとめ単位名
+        * factor : 換算値
     * unit_price : 納品単価
+    * subtotal_amount : 小計（box_quantity x box_unit）
     * status : 状態
       * 以下の2つのどちらかが設定されています
       * before_delivery : 出庫前
@@ -695,8 +725,15 @@ HOST: https://web.zaico.co.jp/
     * inventory_id : 在庫データID
     * title : 物品名
     * quantity : 入庫数量
+    * box_quantity: まとめ換算数量（基本単位で登録された場合はquantityと同じ値）
     * unit : 単位
+    * box_unit : まとめ単位（基本単位で登録された場合はunitと同じ値）
+    * unit_snapshot : 単位自動換算情報
+        * piece_name : 基本単位名
+        * box_name : まとめ単位名
+        * factor : 換算値
     * unit_price : 仕入単価
+    * subtotal_amount : 小計（box_quantity x box_unit）
     * status : 状態
         * 以下の3つのいずれかが設定されています
         * not_ordered : 発注前
@@ -729,7 +766,9 @@ HOST: https://web.zaico.co.jp/
                     + inventory_id: 1
                     + title: 掃除機 (string) - 物品名
                     + quantity: 3 (string) - 入庫数量
+                    + box_quantity: 3 (string) - まとめ換算の入庫数量
                     + unit: 台 (string) - 単位
+                    + box_unit: 台 (string) - まとめ単位
                     + unit_price: 100 (string) - 仕入単価
                     + status: ordered (string)
                     + purchase_date: null (string)
@@ -738,11 +777,28 @@ HOST: https://web.zaico.co.jp/
                     + inventory_id: 1
                     + title: 掃除機 (string) - 物品名
                     + quantity: 3 (string) - 入庫数量
+                    + box_quantity: 3 (string) - まとめ換算の入庫数量
                     + unit: 台 (string) - 単位
+                    + box_unit: 台 (string) - まとめ単位
                     + unit_price: 100 (string) - 仕入単価
                     + status: ordered (string)
                     + purchase_date: null (string)
                     + estimated_purchase_date: `2020-01-01` (string)
+                + ()
+                    + inventory_id: 2 
+                    + title: ビール (string) - 物品名
+                    + quantity: 12 (string) - 入庫数量
+                    + box_quantity: 1 (string) - まとめ換算の入庫数量
+                    + unit: 瓶 (string) - 単位
+                    + box_unit: 箱 (string) - まとめ単位
+                    + unit_price: 100 (string) - 仕入単価
+                    + unit_snapshot:
+                        + piece_name: 瓶 (string) - 基本単位名称
+                        + box_name: 箱 (string) - まとめ単位名称
+                        + factor : 12 (string) - 換算値
+                    + status: ordered (string)
+                    + purchase_date: null (string)
+                    + estimated_purchase_date: `2020-01-01` (string)
         + ()
             + id: 11 (number)
             + num: 1001 (string)
@@ -846,8 +902,15 @@ HOST: https://web.zaico.co.jp/
     * inventory_id : 在庫データID
     * title : 物品名
     * quantity : 入庫数量
+    * box_quantity: まとめ換算数量（基本単位で登録された場合はquantityと同じ値）
     * unit : 単位
+    * box_unit : まとめ単位（基本単位で登録された場合はunitと同じ値）
+    * unit_snapshot : 単位自動換算情報（まとめ単位で登録された場合のみ）
+        * piece_name : 基本単位名
+        * box_name : まとめ単位名
+        * factor : 換算値
     * unit_price : 仕入単価
+    * subtotal_amount : 小計（box_quantity x box_unit）
     * status : 状態
         * 以下の3つのいずれかが設定されています
         * not_ordered : 発注前
@@ -897,6 +960,21 @@ HOST: https://web.zaico.co.jp/
                 + status: purchased (string)
                 + purchase_date: null (string)
                 + estimated_purchase_date: `2020-01-01` (string)
+            + ()
+                + inventory_id: 2 
+                + title: ビール (string) - 物品名
+                + quantity: 12 (string) - 入庫数量
+                + box_quantity: 1 (string) - まとめ換算の入庫数量
+                + unit: 瓶 (string) - 単位
+                + box_unit: 箱 (string) - まとめ単位
+                + unit_price: 100 (string) - 仕入単価
+                + unit_snapshot:
+                    + piece_name: 瓶 (string) - 基本単位名称
+                    + box_name: 箱 (string) - まとめ単位名称
+                    + factor : 12 (string) - 換算値
+                + status: ordered (string)
+                + purchase_date: null (string)
+                + estimated_purchase_date: `2020-01-01` (string)
 
 ## 入庫データ更新 [/api/v1/purchases/{id}]
 ### 入庫データ更新 [PUT]