sk_api_schema 0.0.13 → 0.0.14

data/VERSION

@@ -1 +1 @@
-0.0.13
+0.0.14

data/json/v1.0/credit_note.json

@@ -193,7 +193,18 @@
     },
     { "rel": "create",
       "href": "credit_notes",
-      "method": "POST"
+      "method": "POST",
+      "properties" : {
+        "source" : {
+          "title" : "Source document id",
+          "description": "Copies the source document(excl. number,date) and returns a new draft document."
+        },
+        "cancel" : {
+          "title" : "Cancel an credit note",
+          "description": "Cancelling a document negates its line item values. A source id must be set.",
+          "dependencies": ['source']
+        }
+      }
     },
     { "rel": "attachments",
       "href": "credit_notes/{id}/attachments"

data/json/v1.0/estimate.json

@@ -180,7 +180,13 @@
     },
     { "rel": "create",
       "href": "estimates",
-      "method": "POST"
+      "method": "POST",
+      "properties" : {
+        "source" : {
+          "title" : "Source document id",
+          "description": "Copies the source document(excl. number,date) and returns a new draft document."
+        }
+      }
     },
     { "rel": "attachments",
       "href": "estimates/{id}/attachments"

data/json/v1.0/invoice.json

@@ -195,7 +195,18 @@
     },
     { "rel": "create",
       "href": "invoices",
-      "method": "POST"
+      "method": "POST",
+      "properties" : {
+        "source" : {
+          "title" : "Source document id",
+          "description": "Copies the source document(excl. number,date) and returns a new draft document. If the source is an Estimate or Order only line_items, client & tags are copied, so you can pass in additional fields."
+        },
+        "cancel" : {
+          "title" : "Cancel an invoice",
+          "description": "Cancelling a document negates its line item values. A source id must be set.",
+          "dependencies": ['source']
+        }
+      }
     },
     { "rel": "attachments",
       "href": "invoices/{id}/attachments"

data/json/v1.0/order.json

@@ -170,7 +170,13 @@
     },
     { "rel": "create",
       "href": "orders",
-      "method": "POST"
+      "method": "POST",
+      "properties" : {
+        "source" : {
+          "title" : "Source document id",
+          "description": "Copies the source document(excl. number,date) and returns a new draft document."
+        }
+      }
     },
     { "rel": "attachments",
       "href": "orders/{id}/attachments"

data/json/v1.0/payment_reminder.json

@@ -10,6 +10,7 @@
     },
     "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"
     },
     "address_field":{
@@ -19,6 +20,7 @@
     "date":{
       "description": "Date the payment_reminder is issued. Automatically set when created from invoice. Defaults to today.",
       "format":"date",
+      "required": true,
       "type":"string"
     },
     "due_days":{

data/json/v1.0/recurring.json

@@ -0,0 +1,205 @@
+{ "type":"object",
+  "title": "recurring",
+  "description": "An recurring is used as an template for new invoices.",
+  "properties":{
+    "id":{
+      "description": "UUID assigned by SK",
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "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
+    },
+    "address_field":{
+      "description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id given.",
+      "type":"string"
+    },
+    "date":{
+      "description": "First date the recurring is issued. Not allowed to be in the past.",
+      "format":"date",
+      "type":"string",
+      "required":true
+    },
+    "due_days":{
+      "description": "Used to calculate the due date of the recurring. Useless if date and due date are present.",
+      "type":"integer"
+    },
+    "final_date":{
+      "description": "The last date the recurring is executed.",
+      "format":"date",
+      "type":"string",
+      "required":true
+    },
+    "frequency":{
+      "description": "Recurring frequency",
+      "enum":['yearly', 'monthly', 'weekly', 'quarterly', 'biweekly', 'sixmonthly'],
+      "type":"string",
+      "required":true
+    },
+    "payment_method":{
+      "description": "How the invoce is beeing payed. Used in new payments.",
+      "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
+      "type":"string"
+    },
+    "title":{
+      "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your recurring [number]'",
+      "type":"string"
+    },
+    "notes_before":{
+      "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.",
+      "type":"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"
+    },
+    "tag_list": {
+      "description": "Space separated list of tags.",
+      "type":"string"
+    },
+    "precision":{
+      "description": "Decimal places for displayed(printed) money values. gross_total and net_total will always be displayed rounded to a precision of 2. When greater 2 use net_total_base(also in line_item) to show the net val with the set precision(3,4).",
+      "type":"number",
+      "enum": [2,3,4],
+      "default":2
+    },
+    "client":{
+      "description": "The client for the document. New documents cannot create a client, use client_id field to set it.",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./client.json#properties"}
+    },
+    "client_id":{
+      "description": "The clients uuid, must be set for a new document. New recurrings take the clients address field, due days and cash discount if those fields are not set.",
+      "type":"string",
+      "required":true
+    },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string"
+    },
+    "line_items":{
+      "description": "Line items for the document",
+      "type":"array",
+      "properties":{"$ref":"./address.json#properties"}
+    },
+    "created_at":{
+      "description": "Date the object was created in SK. Never changes afterwards.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at":{
+      "description": "Date the object was edited in SK.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "lock_version":{
+      "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version. ",
+      "optional":true,
+      "type":"integer"
+    },
+    "gross_total":{
+      "description": "Gross total of all line items, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "tax_total":{
+      "description": "Tax total, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "net_total":{
+      "description": "Net total, 2 decimals places",
+      "readonly":true,
+      "type":"number"
+    },
+    "net_total_base":{
+      "description": "Net total, decimals places as set in precision, default 2",
+      "readonly":true,
+      "type":"number"
+    },
+    "net_total_base_raw":{
+      "description": "Net total, 6 decimal places. Summmed items net_total_base_raw (incl discount)",
+      "readonly":true,
+      "type":"number"
+    }
+  },
+  "links":[
+    { "rel": "self",
+      "href": "recurrings/{id}"
+    },
+    { "rel": "instances",
+      "href": "recurrings",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in title, number, addressfield",
+          "type":"string"
+        },
+        "filter[tags]":{
+          "title" : "Tags",
+          "description": "Filter by a space delimited list of tags",
+          "type":"string"
+        },
+        "filter[from]":{
+          "title" : "From date",
+          "description": "All objects with a date after the date"
+        },
+        "filter[to]":{
+          "title" : "To date",
+          "description": "All objects with date before the date"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":['title', 'number', 'created_at', 'updated_at', 'client_id', 'price_total'],
+          "type": 'string'
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "recurrings/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "recurrings/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "recurrings",
+      "method": "POST",
+      "properties" : {
+        "source" : {
+          "title" : "Source document id",
+          "description": "Copies the source document(excl. number,date) and returns a new draft document."
+        },
+        "cancel" : {
+          "title" : "Cancel an recurring",
+          "description": "Cancelling a document negates its line item values. A source id must be set.",
+          "dependencies": ['source']
+        }
+      }
+    },
+    { "rel": "attachments",
+      "href": "recurrings/{id}/attachments"
+    },    
+    { "rel": "comments",
+      "href": "recurrings/{id}/comments"
+    }
+  ]
+}

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.13"
+  s.version = "0.0.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-01-29}
+  s.date = %q{2011-02-02}
   s.description = %q{SalesKing API JSON schema and utility methods}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
     "json/v1.0/payment.json",
     "json/v1.0/payment_reminder.json",
     "json/v1.0/product.json",
+    "json/v1.0/recurring.json",
     "json/v1.0/text_template.json",
     "json/v1.0/user.json",
     "lib/sk_api_schema.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: 
   segments: 
   - 0
   - 0
-  - 13
-  version: 0.0.13
+  - 14
+  version: 0.0.14
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-29 00:00:00 +01:00
+date: 2011-02-02 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -74,6 +74,7 @@ files:
 - json/v1.0/payment.json
 - json/v1.0/payment_reminder.json
 - json/v1.0/product.json
+- json/v1.0/recurring.json
 - json/v1.0/text_template.json
 - json/v1.0/user.json
 - lib/sk_api_schema.rb