sk_api_schema 0.8.8 → 0.9.0

data/CHANGELOG.md

@@ -3,6 +3,16 @@
 See [commit messages](https://github.com/salesking/sk_api_schema/commits/) for details.
 Also sign up to our [Developer Newsletter](http://www.salesking.eu/dev/newsletter/) to stay up-to-date !!!
 
+##2013-12
+
+* add cost_total, gross_margin to documents
+* rename product.cost_price to cost
+
+line_item:
+* remove use_product switch. Now copy product fields into item whenever a product_id is set.
+* remove required quantity and position, now defaulting to 1
+* add cost, cost_total, gross_margin
+
 ##2013-10
 
 * add net_total, gross_total to line item

data/json/v1.0/credit_note.json

@@ -185,6 +185,21 @@
       "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
+    },
+    "cost_total":{
+      "description": "Cost total of all line items, 2 decimals places in document currency.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_total":{
+      "description": "Total gross margin across all line items. Calculated from net_total-cost_total.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_pct":{
+      "description": "Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100",
+      "readonly":true,
+      "type":"number"
     }
   },
   "links":[

data/json/v1.0/estimate.json

@@ -170,6 +170,21 @@
       "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
+    },
+    "cost_total":{
+      "description": "Cost total of all line items, 2 decimals places in document currency.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_total":{
+      "description": "Total gross margin across all line items. Calculated from net_total-cost_total.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_pct":{
+      "description": "Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100",
+      "readonly":true,
+      "type":"number"
     }
   },
   "links":[

data/json/v1.0/invoice.json

@@ -186,6 +186,21 @@
       "readonly":true,
       "type":"number"
     },
+    "cost_total":{
+      "description": "Cost total of all line items, 2 decimals places in document currency.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_total":{
+      "description": "Total gross margin across all line items. Calculated from net_total-cost_total.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_pct":{
+      "description": "Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100",
+      "readonly":true,
+      "type":"number"
+    },
     "recurring_id":{
       "description":"Recurring document ID, if the invoice was created from a recurring.",
       "readonly":true,

data/json/v1.0/line_item.json

@@ -12,9 +12,9 @@
       "minLength":22
     },
     "position":{
-      "description": "Required since items are sorted by position.",
+      "description": "Position by which the items are sorted. Two items can have the same position(if you dont care) and numbers dont need to continuous",
       "type":"integer",
-      "required":true
+      "default": 1
     },
     "name":{
       "description": "The name of an item",
@@ -40,6 +40,25 @@
       "description": "Net price of a single item",
       "type":"number"
     },
+    "cost":{
+      "description": "Cost price for a single item. Used to calculate the gross margin",
+      "type":"number"
+    },
+    "cost_total":{
+      "description": "Total costs. Calculated from cost_single * quantity",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_total":{
+      "description": "Gross margin, the difference between revenue and cost before accounting for certain other costs. Calculated from net_total - cost_total",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_pct":{
+      "description": "Gross margin percentage. Calculated from gross_margin_total/cost_total",
+      "readonly":true,
+      "type":"number"
+    },
     "net_total":{
       "description": "Net price of a single item. Calculated from price_single * quantity * discount",
       "readonly":true,
@@ -67,18 +86,14 @@
       "description": "Quantity of the item. Must be >= 0",
       "type":"number",
       "minimum":0,
-      "required":true
+      "default": 1
     },
     "product_id":{
-      "description": "A uuid of a product, referenced in this item. This makes it easier to track a products turnover and list the documents it is used on. Also see use_product",
+      "description": "A uuid of a product, used by this item. If set or changed, the product fields (name, description, quantity, unit, price, cost price) are copied if the according item fields are missing/blank. Besides this product link makes it possible to track a products turnover and find the documents it is used on.",
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
-    "use_product":{
-      "description": "If set and product_id is present, the products name, description, quantity, unit, price are copied if the according item fields are missing.",
-      "type":"boolean"
-    },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards",
       "format":"date-time",

data/json/v1.0/order.json

@@ -175,6 +175,21 @@
       "description": "Net total, 6 decimal places incl. discount",
       "readonly":true,
       "type":"number"
+    },
+    "cost_total":{
+      "description": "Cost total of all line items, 2 decimals places in document currency.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_total":{
+      "description": "Total gross margin across all line items. Calculated from net_total-cost_total.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_pct":{
+      "description": "Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100",
+      "readonly":true,
+      "type":"number"
     }
   },
   "links":[

data/json/v1.0/product.json

@@ -36,7 +36,7 @@
       "type":"number",
       "required":true
     },
-    "cost_price":{
+    "cost":{
       "description": "Cost price of a single product",
       "type":"number"
     },

data/json/v1.0/recurring.json

@@ -163,6 +163,21 @@
       "readonly":true,
       "type":"number"
     },
+    "cost_total":{
+      "description": "Cost total of all line items, 2 decimals places in document currency.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_total":{
+      "description": "Total gross margin across all line items. Calculated from net_total-cost_total.",
+      "readonly":true,
+      "type":"number"
+    },
+    "gross_margin_pct":{
+      "description": "Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100",
+      "readonly":true,
+      "type":"number"
+    },
     "pdf_template_id":{
       "description": "The PDF template used for printing the invoice when auto sending. Required when auto_send'ing is enabled.",
       "type":"string",

data/lib/sk_api_schema/version.rb

@@ -1,7 +1,7 @@
 module SK
   module Api
     class Schema
-      VERSION='0.8.8'
+      VERSION='0.9.0'
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 47
+  hash: 59
   prerelease: 
   segments: 
   - 0
-  - 8
-  - 8
-  version: 0.8.8
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,10 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-10-22 00:00:00 Z
+date: 2013-12-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
+  name: activesupport
+  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -28,11 +29,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  type: :runtime
   version_requirements: *id001
-  prerelease: false
-  name: activesupport
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: rdoc
+  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -42,11 +43,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  type: :development
   version_requirements: *id002
-  prerelease: false
-  name: rdoc
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: rspec
+  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -56,11 +57,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  type: :development
   version_requirements: *id003
-  prerelease: false
-  name: rspec
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: simplecov
+  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -70,11 +71,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  type: :development
   version_requirements: *id004
-  prerelease: false
-  name: simplecov
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: rake
+  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -86,9 +87,8 @@ dependencies:
         - 9
         - 2
         version: 0.9.2
+  type: :development
   version_requirements: *id005
-  prerelease: false
-  name: rake
 description: |-
   The SalesKing JSON Schema describes our business API in terms of available objects, their fields and links to url endpoints with related objects.
   Besides ruby users can use a small lib with utility methods to load and test the schema files.