sk_api_schema 0.10.6 → 0.11.0

data/json/v2.0/email.json

@@ -1,12 +1,21 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "email",
-  "name": "email",
   "description":"An email in SK must always be related to an object. Receivers are limited to 5 per address field.",
+  "required": ["to_addr", "subject", "body", "related_object_type", "related_object_id" ],
   "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
@@ -14,12 +23,12 @@
     "bcc_addr":{
       "description": "BCC addresses, comma separated. Max 5, format: a@b.de,'George'<georg@sk.eu>",
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "cc_addr":{
       "description": "CC addresses, comma separated. Max 5, format: a@b.de,'George'<georg@sk.eu>",
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "from_addr":{
       "description": "From address. If empty the email of the current user is taken.",
@@ -28,71 +37,69 @@
     },
     "to_addr":{
       "description": "TO addresses, comma separated. Max 5, format: a@b.de,'George'<georg@sk.eu>",
-      "required":true,
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "subject":{
       "description": "The email subject.",
-      "required":true,
       "type":"string",
       "maxLength": 255
     },
     "body":{
       "description": "The email text.",
-      "required":true,
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "attachments":{
       "description": "The emails attachments.",
-      "readonly":true,
+      "readOnly":true,
       "type":"array",
-      "properties":{"$ref":"./attachment.json#properties"}
+      "items": {
+        "type": "object",
+        "$ref":"./attachment.json#"
+      }
     },
     "related_object_type":{
       "description": "Object type of the emails parent. Is the camelcased base class name: Document for invoice, credit_note, contact,..",
-      "required":true,
       "type":"string"
     },
     "related_object_id":{
       "description": "uuid of the emails parent object.",
-      "required":true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
     },
     "in_progress":{
       "description": "Is set after an email has been scheduled for sending until it has been sent.",
-      "readonly":true,
+      "readOnly":true,
       "type":"boolean"
     },
     "log":{
       "description": "Logs error message when sending failed.",
-      "readonly":true,
-      "type":"text"
+      "readOnly":true,
+      "type":"string"
     },
     "delivered_at":{
       "description": "Date the email was delivered by SK. If set, the message cannot be edited anymore.",
       "format":"date-time",
-      "readonly":true,
+      "readOnly":true,
       "type":"string"
     },
     "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"
     },
     "team_id":{
       "description": "A team uuid taken from the related object. If set only the team and its parent teams can see the record.",
-      "readonly" :true,
+      "readOnly" :true,
       "type":"string",
       "maxLength": 22,
       "minLength":22
@@ -156,7 +163,7 @@
       }
     },
     { "rel": "attachments",
-      "href": "emails/{id}/attachments"
+      "href": "attachments?filter[related_object_ids]={id}"
     },
     { "rel": "destroy",
       "href": "emails/{id}",

data/json/v2.0/email_template.json

@@ -1,33 +1,39 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "email_template",
-  "name": "email_template",
   "description":"An email_template is used to simplify the creation of emails. When creating a new email just pass template id and all fields from the template are copied to the new email. The fields are NOT merged with present values in a new email object!",
+  "required": ["name", "subject", "body", "kind"],
   "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
     },
     "name":{
       "description": "A meaningful name.",
-      "required":true,
       "type":"string",
       "maxLength": 50
     },
     "subject":{
       "description": "Subject containing placeholders, replaced when the template is used.",
-      "required":true,
       "type":"string",
       "maxLength": 255
     },
     "body":{
       "description": "Body with placeholders, replaced when the template is used.",
-      "required":true,
       "type":"string",
-      "format":"text"
+      "format":"string"
     },
     "from_addr":{
       "description": "Default from address. A valid email address. Make sure your server(if custom SMPT settings for the API user) allows sending with this address.",
@@ -46,7 +52,6 @@
     },
     "kind":{
       "description": "Kind of object the template can be used for.",
-      "required":true,
       "enum": ["invoice", "estimate", "credit_note", "payment_reminder", "order", "contact"],
       "type":"string"
     },
@@ -58,13 +63,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"
     },
     "team_id":{

data/json/v2.0/estimate.json

@@ -1,12 +1,20 @@
-{ "type":"object",
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "type":"object",
   "title": "estimate",
-  "name": "estimate",
   "description": "An estimate",
   "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
@@ -53,12 +61,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.",
@@ -77,37 +85,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.",
@@ -117,74 +113,83 @@
     },
     "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 and increments version.",
+      "readOnly":true,
       "type":"integer"
     },
     "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"
     },
     "probability":{
@@ -193,7 +198,7 @@
     },
     "expected_revenue":{
       "description": "Product of the probability and net total. In company currency.",
-      "readonly":true,
+      "readOnly":true,
       "type":"number"
     },
     "close_date":{
@@ -301,11 +306,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.",
@@ -355,39 +355,23 @@
         "source" : {
           "title" : "Source document id",
           "description": "Copies the source(excl. number,date) and returns a new draft document. You can pass any document type(e.g. invoice, order). Fields passed with the object(e.g. notes, title, address_field) are not overwritten.",
-          "type" : "string"
+          "type" : "string",
+          "maxLength": 22,
+          "minLength":22
         }
       }
     },
     { "rel": "attachments",
-      "href": "estimates/{id}/attachments"
+      "href": "attachments?filter[related_object_ids]={id}"
+    },
+    { "rel": "payments",
+      "href": "payments?filter[related_object_ids]={id}"
     },
     { "rel": "comments",
-      "href": "estimates/{id}/comments"
+      "href": "comments?filter[related_object_ids]={id}"
     },
     { "rel": "emails",
-      "href": "estimates/{id}/emails"
-    },
-    { "rel": "emails create",
-      "href": "estimates/{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)."
-        }
-      }
+      "href": "emails?filter[related_object_ids]={id}"
     },
     { "rel": "print",
       "href": "estimates/{id}/print",
@@ -395,8 +379,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",