sk_api_schema 0.3.4 → 0.4.0

data/json/v1.0/line_item.json

@@ -3,10 +3,12 @@
   "description": "A line item for a document",
   "properties":{
     "id":{
-      "description": "uuid of the item.",
+      "description":"Unique identifier - UUID",
       "identity":true,
       "readonly":true,
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "position":{
       "description": "Required since items are sorted by position.",
@@ -15,11 +17,13 @@
     },
     "name":{
       "description": "The name of an item",
-      "type":"string"
+      "type":"string",
+      "maxLength": 50
     },
     "description":{
       "description": "Item description",
-      "type":"string"
+      "type":"string",
+      "format": "text"
     },
     "price_single":{
       "description": "Net price of a single item",
@@ -30,22 +34,25 @@
       "type":"number"
     },
     "discount":{
-      "description": "Discount in percent applied to the items net total",
+      "description": "Discount in percent applied to the items net total. Can also be negative if you want to add additional charges.",
       "type":"number"
     },
     "quantity_unit":{
       "description": "Quantity unit: kg, days, month.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 30
     },
     "quantity":{
-      "description": "Quantity of the item. Must be > 0",
+      "description": "Quantity of the item. Must be >= 0",
       "type":"number",
-      "exclusiveMinimum":0,
+      "minimum":0,
       "required":true
     },
     "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",
-      "type":"string"
+      "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.",
@@ -63,7 +70,7 @@
       "readonly":true,
       "type":"string"
     },
-    "_destroy": {
+    "_destroy":{
       "description": "When set an existing item will be deleted. This switch is used for items passed-in nested inside their parent object(a document), which is default as long as there is no line item endpoint available.",
       "type":"boolean"
     }

data/json/v1.0/order.json

@@ -3,14 +3,17 @@
   "description": "An order",
   "properties":{
     "id":{
-      "description": "UUID assigned by SK",
+      "description":"Unique identifier - UUID",
       "identity":true,
       "readonly":true,
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "number":{
       "description": "Unique number assigned by SK order number schema. Auto-assigned when order is opened. Required unless doc status is draft.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 50
     },
     "address_field":{
       "description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id present.",
@@ -38,27 +41,31 @@
     },
     "external_ref":{
       "description": "Some external reference, whatever this may be.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 255
     },
     "payment_method":{
-      "description": "How the document is beeing payed. Used in new payments.",
+      "description": "How the document is being payed. Used in new payments.",
       "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
     "title":{
-      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your order [number]'",
-      "type":"string"
+      "description": "The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your order [number]'",
+      "type":"string",
+      "maxLength": 255
     },
     "notes_before":{
-      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
-      "type":"string"
+      "description": "Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.",
+      "type":"string",
+      "format":"text"
     },
     "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"
+      "type":"string",
+      "format":"text"
     },
-    "tag_list": {
-      "description": "Space separated list of tags.",
+    "tag_list":{
+      "description": "Space separated list of tags. Are split and saved as Tag objects on create, update.",
       "type":"string"
     },
     "language":{
@@ -80,11 +87,15 @@
     },
     "client_id":{
       "description": "The clients uuid. If a new client is assigned its language, address field are used if those fields are not set.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "team_id":{
       "description": "A team uuid. If set only the team and its parent teams can see the record.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "line_items":{
       "description": "Line items for the document",
@@ -147,7 +158,7 @@
         },
         "filter[q]":{
           "title" : "Search",
-          "description": "Search in title, number, addressfield",
+          "description": "Search in title, number, address field",
           "type":"string"
         },
         "filter[number]":{

data/json/v1.0/payment.json

@@ -1,21 +1,24 @@
 { "type":"object",
   "title": "payment",
   "description":"An payment in SK must always be related to an object.",
-  "properties": {
-    "id": {
-      "description": "uuid of the object",
+  "properties":{
+    "id":{
+      "description":"Unique identifier - UUID",
       "identity":true,
       "readonly":true,
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
-    "amount": {
+    "amount":{
       "description": "The payment amount",
       "required":true,
       "type":"number"
     },
     "external_ref":{
       "description": "Reference number f.ex. issued by the bank.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 255
     },
     "date":{
       "description": "Date the payment was made.",
@@ -31,21 +34,25 @@
       "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
-    "related_object_type": {
+    "related_object_type":{
       "description": "Object type of the payments parent. Is the camel-cased base class name: Document for invoice, credit_note,.., Contact for client",
       "required":true,
       "type":"string"
     },
-    "related_object_id": {
+    "related_object_id":{
       "description": "uuid of the payments parent object.",
       "required":true,
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "team_id":{
       "description": "A team uuid. If set only the team and its parent teams can see the record.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
-    "created_at": {
+    "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards",
       "format":"date-time",
       "readonly":true,
@@ -71,7 +78,7 @@
         },
         "filter[q]":{
           "title" : "Search",
-          "description": "Search in title, number, addressfield",
+          "description": "Search in title, number, address field",
           "type":"string"
         },
         "filter[from]":{
@@ -110,7 +117,7 @@
       "properties" : {
         "new_doc_status":{
           "title" : "New status for document",
-          "description": "Convinience method to close a document with a payment.",
+          "description": "Convenience method to close a document with a payment.",
           "enum": ["open","closed"],
           "type":"string"
         }

data/json/v1.0/payment_reminder.json

@@ -3,15 +3,19 @@
   "description": "A payment reminder",
   "properties":{
     "id":{
-      "description": "UUID assigned by SK",
+      "description":"Unique identifier - UUID",
       "identity":true,
       "readonly":true,
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "invoice_id":{
       "description": "The invoice for the reminder. If set assumes all other fields are set to custom values, instead of filling them from the invoice. POSTing to invoices/:id/payment_reminders, automatically set this and all other fields.",
       "required": true,
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "address_field":{
       "description": "Receiver address, shown in envelope window. Defaults to invoice.client.address_field if created from invoice.",
@@ -34,22 +38,26 @@
     },
     "external_ref":{
       "description": "Some external reference, whatever this may be.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 255
     },
     "title":{
-      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your payment_reminder [number]'. Defaults to values from settings",
-      "type":"string"
+      "description": "The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your payment_reminder [number]'. Defaults to values from settings",
+      "type":"string",
+      "maxLength": 255
     },
     "notes_before":{
-      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used. Defaults to values from settings",
-      "type":"string"
+      "description": "Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used. Defaults to values from settings",
+      "type":"string",
+      "format":"text"
     },
     "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. Defaults to values from settings",
-      "type":"string"
+      "type":"string",
+      "format":"text"
     },
-    "tag_list": {
-      "description": "Space separated list of tags.",
+    "tag_list":{
+      "description": "Space separated list of tags. Are split and saved as Tag objects on create, update.",
       "type":"string"
     },
     "language":{
@@ -71,11 +79,15 @@
     },
     "client_id":{
       "description": "The clients uuid. Is assigned throught the related invoice.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "team_id":{
       "description": "A team uuid. If set, only the team and its parent teams can see the record. Defaults to team id from invoice",
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "line_items":{
       "description": "Line items for the document. Defaults to invoice.gross_total and late fee values from settings",
@@ -128,7 +140,7 @@
         },
         "filter[q]":{
           "title" : "Search",
-          "description": "Search in title, number, addressfield",
+          "description": "Search in title, number, address field",
           "type":"string"
         },
         "filter[tags]":{

data/json/v1.0/product.json

@@ -3,23 +3,28 @@
   "description": "A product in SK",
   "properties":{
     "id":{
-      "description": "uuid of the product.",
+      "description":"Unique identifier - UUID",
       "identity":true,
       "readonly":true,
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "number":{
       "description": "Unique number assigned by you or if empty SK product number schema.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 50
     },
     "name":{
       "description": "The name of the product",
       "type":"string",
-      "required":true
+      "required":true,
+      "maxLength": 50
     },
     "description":{
       "description": "Product description",
-      "type":"string"
+      "type":"string",
+      "format":"text"
     },
     "price":{
       "description": "Net price of a single product",
@@ -31,7 +36,8 @@
     },
     "quantity_unit":{
       "description": "Unit like kg, days, month.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 30
     },
     "created_at":{
       "description": "Date the object was created in SK. Never changes afterwards",
@@ -47,9 +53,11 @@
     },
     "team_id":{
       "description": "A team uuid. If set only the team and its parent teams can see the record.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
-    "lock_version": {
+    "lock_version":{
       "description": "Increased on every edit, so SK can detect/prevent a concurrent edit by another user. First save wins.",
       "type":"integer"
     }
@@ -75,7 +83,7 @@
           "title" : "Search",
           "description": "Searches in number, name, description, price",
           "type":"string"
-        },        
+        },
         "sort_by":{
           "title" : "Sort by",
           "description": "Sort the results by the given field => number",

data/json/v1.0/recurring.json

@@ -3,15 +3,18 @@
   "description": "An recurring is used as an template for new invoices.",
   "properties":{
     "id":{
-      "description": "UUID assigned by SK",
+      "description":"Unique identifier - UUID",
       "identity":true,
       "readonly":true,
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "number":{
       "description": "Unique name to identify the document. Unlike all other document this one has no number schema and not auto assign",
       "type":"string",
-      "required":true
+      "required":true,
+      "maxLength": 50
     },
     "address_field":{
       "description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id given.",
@@ -40,28 +43,32 @@
       "required":true
     },
     "payment_method":{
-      "description": "How the document is beeing payed. Used in new payments.",
+      "description": "How the document is being payed. Used in new payments.",
       "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque", "moneybookers", "premium_sms"],
       "type":"string"
     },
     "external_ref":{
       "description": "Some external reference, whatever this may be.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 255
     },
     "title":{
-      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your recurring [number]'",
-      "type":"string"
+      "description": "The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your recurring [number]'",
+      "type":"string",
+      "maxLength": 255
     },
     "notes_before":{
-      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
-      "type":"string"
+      "description": "Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.",
+      "type":"string",
+      "format":"text"
     },
     "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"
+      "type":"string",
+      "format":"text"
     },
-    "tag_list": {
-      "description": "Space separated list of tags.",
+    "tag_list":{
+      "description": "Space separated list of tags. Are split and saved as Tag objects on create, update.",
       "type":"string"
     },
     "language":{
@@ -77,11 +84,15 @@
     },
     "client_id":{
       "description": "The clients uuid. If a new client is assigned its language, address field, due days and cash discount are used if those fields are not set.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "team_id":{
       "description": "A team uuid. If set only the team and its parent teams can see the record.",
-      "type":"string"
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
     },
     "line_items":{
       "description": "Line items for the document",
@@ -144,7 +155,7 @@
         },
         "filter[q]":{
           "title" : "Search",
-          "description": "Search in title, number, addressfield",
+          "description": "Search in title, number, address field",
           "type":"string"
         },
         "filter[tags]":{