sk_api_schema 0.10.6 → 0.11.0

data/json/v2.0/credit_note.json

@@ -1,12 +1,20 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "credit_note",
-  "name": "credit_note",
   "description": "A credit note",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "company_id":{
+      "description":"Company",
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
@@ -58,12 +66,12 @@
     "notes_before":{
       "description": "Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.",
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "notes_after":{
       "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.",
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "tag_list":{
       "description": "Space separated list of tags. Are split and saved as Tag objects on create, update.",
@@ -82,37 +90,25 @@
     },
     "exchange_rate":{
       "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it. ",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "gross_total_exchanged":{
       "description": "Exchanged gross total, in your company currency.",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "archived_pdf":{
       "description": "Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one. ",
-      "readonly":true,
+      "readOnly":true,
       "type":"object",
-      "properties":{"$ref":"./attachment.json#properties"}
-    },
-    "client":{
-      "description": "DEPRECATED: use contact",
-      "readonly":true,
-      "type":"object",
-      "properties":{"$ref":"./client.json#properties"}
-    },
-    "client_id":{
-      "description": "DEPRECATED: use contact_id",
-      "type":"string",
-      "maxLength": 22,
-      "minLength":22
+      "$ref":"./attachment.json"
     },
     "contact":{
       "description": "The contact for the document. Use contact_id field to set a contact.",
-      "readonly":true,
+      "readOnly":true,
       "type":"object",
-      "properties":{"$ref":"./contact.json#properties"}
+      "$ref":"./contact.json#"
     },
     "contact_id":{
       "description": "The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.",
@@ -122,85 +118,90 @@
     },
     "team_id":{
       "description": "A team uuid taken from the contact. If set only the team and its parent teams can see the record.",
-      "readonly" :true,
+      "readOnly" :true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
-    "line_items":{
-      "description": "DEPRECATED use items",
-      "type":"array",
-      "properties":{"$ref":"./line_item.json#properties"}
-    },
     "items":{
-      "description": "Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the line_items array is stronger for backward compat.",
+      "description": "Items for the document, including divider and sub_total items. You MUST set the type field(CamelCasedItem class name) on each item on creation.",
       "type":"array",
-      "default": "any",
       "minItems": 0,
-      "items": [{ "$ref": "./line_item.json#properties"},
-                { "$ref":  "./divider_item.json#properties"},
-                { "$ref": "./sub_total_item.json#properties"}]
+      "items": {
+        "type" : "object",
+        "anyOf" : [
+          {
+            "title": "line_item",
+            "$ref": "./line_item.json#"
+          },
+          {
+            "title": "divider_item",
+            "$ref": "./divider_item.json#"
+          },
+          {
+            "title": "sub_total_item",
+            "$ref": "./sub_total_item.json#"
+          }
+        ]
+      }
     },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "updated_at":{
       "description": "Date the object was edited in SK.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "lock_version":{
       "description": "Auto-incremented to prevent concurrent updates. First save wins.",
+      "readOnly":true,
       "type":"integer"
     },
-    "price_total":{
-      "description": "DEPRECATED: use net_total_base",
-      "readonly":true,
-      "type":"number"
-    },
-    "price_tax":{
-      "description": "DEPRECATED: use tax_total",
-      "readonly":true,
-      "type":"number"
-    },
     "gross_total":{
       "description": "Gross total of all line items, 2 decimals places in document currency.",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "tax_total":{
       "description": "Tax total, 2 decimals places",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "net_total":{
       "description": "Net total, 2 decimals places",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "net_total_base":{
       "description": "Net total, 6 decimal places incl. discount",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "cost_total":{
       "description": "Cost total of all line items, 2 decimals places in document currency.",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "gross_margin_total":{
       "description": "Total gross margin across all line items. Calculated from net_total-cost_total.",
-      "readonly":true,
+      "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,
+      "readOnly":true,
       "type":"number"
+    },
+    "tax_exemption_id":{
+      "description": "ID of a tax exemption. When set all item taxes are omitted.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     }
   },
   "links":[
@@ -325,41 +326,16 @@
       }
     },
     { "rel": "attachments",
-      "href": "credit_notes/{id}/attachments"
+      "href": "attachments?filter[related_object_ids]={id}"
     },
     { "rel": "payments",
-      "href": "credit_notes/{id}/payments"
+      "href": "payments?filter[related_object_ids]={id}"
     },
     { "rel": "comments",
-      "href": "credit_notes/{id}/comments"
+      "href": "comments?filter[related_object_ids]={id}"
     },
     { "rel": "emails",
-      "href": "credit_notes/{id}/emails"
-    },
-    { "rel": "emails create",
-      "href": "credit_notes/{id}/emails",
-      "method": "POST",
-      "properties" : {
-        "template_id":{
-          "title" : "Template",
-          "description": "UUID of an email template to use. If present template fields like subject, body, attachments are used for the current email.",
-          "type":"string",
-          "maxLength": 22,
-          "minLength":22
-        },
-        "send":{
-          "title" : "Send email",
-          "description": "Schedule email for sending. Omit this parameter or set value to 0 or false(String or Integer) to keep email as draft."
-        },
-        "archived_pdf":{
-          "title" : "Attach archived pdf",
-          "description": "Adds the archived pdf from the related resource(if it has one)."
-        }
-      }
-    },
-    { "rel": "payment create",
-      "href": "invoices/{id}/payments",
-      "method": "POST"
+      "href": "emails?filter[related_object_ids]={id}"
     },
     { "rel": "print",
       "href": "credit_notes/{id}/print",
@@ -367,8 +343,7 @@
       "properties" : {
         "template_id" : {
           "title" : "PDF template used for printing",
-          "description": "UUID of a pdf template used to print the document. MUST be present",
-          "required":true
+          "description": "UUID of a pdf template used to print the document. MUST be present"
         },
         "base64" : {
           "title" : "Return the created pdf base64 encoded",

data/json/v2.0/divider_item.json

@@ -1,20 +1,21 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "divider_item",
-  "name": "divider_item",
-  "description": "A divider item serves as a separator or headline between line items, e.g. to distinguish hardware and service products on a document. Access and creation is done via documents.items(instead of line_items) where each item has a 'type' field set to its CamelCased class name.",
+  "description": "A divider item serves as a separator or headline between line items, e.g. to distinguish hardware and service products on a document. Access and creation is done via documents.items where each item has a 'type' field containing the CamelCased class name.",
+  "required": ["position"],
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
     "position":{
       "description": "Required since items are sorted by position.",
-      "type":"integer",
-      "required":true
+      "type":"integer"
     },
     "name":{
       "description": "The divider text",
@@ -29,13 +30,13 @@
    "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "updated_at":{
       "description": "Date the object was edited in SK.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "_destroy":{

data/json/v2.0/document.json

@@ -1,16 +1,24 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "document",
-  "name": "document",
-  "description": "This resource is readonly and serves as a convenient way to query documents independent of their type(invoice, order,..). The specific document type is set in each object in the result-set. Internally Document is the base class for all types and special fields are defined in each child-class. Due to this some fields might be missing if you are using this meta-class in queries.",
+  "description": "This resource is readOnly and serves as a convenient way to query documents independent of their type(invoice, order,..). The specific document type is set in each object in the result-set. Internally Document is the base class for all types and special fields are defined in each child-class. Due to this some fields might be missing if you are using this meta-class in queries.",
   "properties":{
     "id":{
       "description":"Unique identifier - UUID",
       "identity":true,
-      "readonly":true,
+      "readOnly":true,
       "type":"string",
       "maxLength": 22,
       "minLength": 22
     },
+    "company_id":{
+      "description":"Company",
+      "readOnly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
     "object_type":{
       "description": "The specific type of the document singular CamelCased: Invoice, PaymentReminder",
       "type":"string"
@@ -42,23 +50,17 @@
     "notes_before":{
       "description": "Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.",
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "notes_after":{
       "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.",
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "tag_list":{
       "description": "Space separated list of tags. Are split and saved as Tag objects on create, update.",
       "type":"string"
     },
-    "client_id":{
-      "description": "DEPRECATED: use contact_id",
-      "type":"string",
-      "maxLength": 22,
-      "minLength":22
-    },
     "contact_id":{
       "description": "The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.",
       "type":"string",
@@ -67,55 +69,63 @@
     },
     "team_id":{
       "description": "A team uuid taken from the contact. If set only the team and its parent teams can see the record.",
-      "readonly" :true,
+      "readOnly" :true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
-    "line_items":{
-      "description": "Line items for the document",
-      "type":"array",
-      "items":{"$ref":"./line_items.json#properties"}
-    },
     "items":{
-      "description": "Items for the document. Access items of all types including divider and sub_total items.",
+      "description": "Items for the document, including divider and sub_total items. You MUST set the type field(CamelCasedItem class name) on each item on creation.",
       "type":"array",
-      "default": "any",
       "minItems": 0,
-      "items": [{ "$ref": "./line_item.json#properties"},
-                { "$ref":  "./divider_item.json#properties"},
-                { "$ref": "./sub_total_item.json#properties"}]
+      "items": {
+        "type" : "object",
+        "anyOf" : [
+          {
+            "title": "line_item",
+            "$ref": "./line_item.json#"
+          },
+          {
+            "title": "divider_item",
+            "$ref": "./divider_item.json#"
+          },
+          {
+            "title": "sub_total_item",
+            "$ref": "./sub_total_item.json#"
+          }
+        ]
+      }
     },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "updated_at":{
       "description": "Date the object was edited in SK.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "gross_total":{
       "description": "Gross total of all line items, 2 decimals places in document currency.",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "tax_total":{
       "description": "Tax total, 2 decimals places",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "net_total":{
       "description": "Net total, 2 decimals places",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "net_total_base":{
       "description": "Net total, 6 decimal places incl. discount",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "currency":{
@@ -126,12 +136,12 @@
     },
     "exchange_rate":{
       "description": "The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it. ",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "gross_total_exchanged":{
       "description": "Exchanged gross total, in your company currency.",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "language":{
@@ -202,11 +212,6 @@
           "description": "A list of language codes, comma separated",
           "type" : "string"
         },
-        "filter[client_ids]":{
-          "title" : "Clients",
-          "description": "DEPRECATED use contact_ids",
-          "type" : "string"
-        },
         "filter[contact_ids]":{
           "title" : "Contacts",
           "description": "Find objects belonging to a single or a list of contacts, use ids comma separated.",