sk_api_schema 0.0.14 → 0.0.15

data/VERSION

@@ -1 +1 @@
-0.0.14
+0.0.15

data/json/v1.0/client.json

@@ -38,7 +38,7 @@
       "type":"string"
     },
     "tax_number": {
-      "description": "Tax number, normaly applies to a private person",
+      "description": "Tax number, normally applies to a private person",
       "type":"string"
     },
     "vat_number": {

data/json/v1.0/company.json

@@ -0,0 +1,108 @@
+{"type":"object",
+  "title": "company",
+  "description": "A company is the main entity. Any data is retrieved scoped to the current company, identified by the subdomain.",
+  "properties": {
+    "id": {
+      "identity":true,
+      "readonly":true,
+      "type":"string"
+    },
+    "name": {
+      "description": "Company name",
+      "type":"string"
+    },
+    "language": {
+      "description": "Default language, used for new users",
+      "type":"string"
+    },    
+    "sub_domain": {
+      "description": "Unique subdomain identifying the company's SalesKing account.",
+      "type":"string"
+    },
+    "account_link": {
+      "description": "Link to a company's SalesKing account.",
+      "type":"string",
+      "readonly":true
+    },
+    "time_zone": {
+      "description": "Default time zone, used for new users",
+      "type":"string"
+    },
+    "email": {
+      "description": "Email address",
+      "required":true,
+      "type":"string"
+    },
+    "url": {
+      "description": "A company website",
+      "type":"string"
+    },   
+    "phone_fax": {
+      "description": "Fax number",
+      "type":"string"
+    },
+    "phone_office": {
+      "description": "Office phone number",
+      "type":"string"
+    },
+    "phone_mobile": {
+      "description": "Mobile phone number",
+      "type":"string"
+    },
+    "tax_number": {
+      "description": "Tax number, normally applies to a private person running a small business.",
+      "type":"string"
+    },
+    "addresses": {
+      "description": "A company can have many addresses, sorted by date descending(new first). Default address used in placeholder is the most recent one.",
+      "type":"array",
+      "properties" : {"$ref":"./addresses.json#properties"}
+    },
+    "vat_number": {
+      "description": "VAT number, for a company entitled to pay value added taxes.",
+      "type":"string"
+    },
+    "bank_name": {
+      "description": "Bank name",
+      "type":"string"
+    },
+    "bank_number": {
+      "description": "Bank number",
+      "type":"string"
+    },
+    "bank_account_number": {
+      "description": "Bank account number.",
+      "type":"string"
+    },
+    "bank_iban": {
+      "description": "IBAN Number of the bank account. Is validated",
+      "type":"string"
+    },
+    "bank_swift": {
+      "description": "SWIFT BIC-  Bank Identifier Code",
+      "type":"string"
+    },
+    "bank_owner": {
+      "description": "Bank account owner",
+      "type":"string"
+    },
+    "created_at": {
+      "description": "Date the record was created in SK. Never changes afterwards.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    },
+    "updated_at": {
+      "description": "Last date when the record was edited.",
+      "format":"date-time",
+      "readonly":true,
+      "type":"string"
+    }
+  },
+  
+  "links":[
+    { "rel": "self",
+      "href": "companies"
+    }
+  ]
+}

data/json/v1.0/credit_note.json

@@ -36,6 +36,10 @@
       "enum":["draft","open","closed"],
       "type":"string"
     },
+    "external_ref":{
+      "description": "Some external reference, whatever this may be.",
+      "type":"string"
+    },
     "payment_method":{
       "description": "How the document is beeing payed. Used in new payments.",
       "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],

data/json/v1.0/estimate.json

@@ -36,6 +36,10 @@
       "enum":["draft","open","closed"],
       "type":"string"
     },
+    "external_ref":{
+      "description": "Some external reference, whatever this may be.",
+      "type":"string"
+    },
     "title":{
       "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your estimate [number]'",
       "type":"string"
@@ -98,7 +102,6 @@
     },
     "lock_version":{
       "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version.",
-      "optional":true,
       "type":"integer"
     },
     "gross_total":{

data/json/v1.0/invoice.json

@@ -36,6 +36,10 @@
       "enum":["draft","open","closed"],
       "type":"string"
     },
+    "external_ref":{
+      "description": "Some external reference, whatever this may be.",
+      "type":"string"
+    },
     "payment_method":{
       "description": "How the invoce is beeing payed. Used in new payments.",
       "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
@@ -103,7 +107,6 @@
     },
     "lock_version":{
       "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version. ",
-      "optional":true,
       "type":"integer"
     },
     "price_total":{

data/json/v1.0/line_item.json

@@ -44,7 +44,7 @@
       "required":true
     },
     "product_id":{
-      "description": "An item can reference a product by its uuid. See use_product",
+      "description": "An item can reference a product. This makes it easier to track a products turnover and the documents it is used on. Also ee use_product",
       "type":"string"
     },
     "use_product":{

data/json/v1.0/order.json

@@ -27,6 +27,10 @@
       "enum":["draft","open","closed"],
       "type":"string"
     },
+    "external_ref":{
+      "description": "Some external reference, whatever this may be.",
+      "type":"string"
+    },
     "title":{
       "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your order [number]'",
       "type":"string"
@@ -88,7 +92,6 @@
     },
     "lock_version":{
       "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version.",
-      "optional":true,
       "type":"integer"
     },
     "gross_total":{

data/json/v1.0/payment_reminder.json

@@ -32,6 +32,10 @@
       "format":"date",
       "type":"string"
     },
+    "external_ref":{
+      "description": "Some external reference, whatever this may be.",
+      "type":"string"
+    },
     "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"
@@ -93,7 +97,6 @@
     },
     "lock_version":{
       "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version. ",
-      "optional":true,
       "type":"integer"
     },
     "gross_total":{

data/json/v1.0/recurring.json

@@ -44,6 +44,10 @@
       "enum":["cash","bank_transfer","credit_card","paypal","direct_debit","cheque"],
       "type":"string"
     },
+    "external_ref":{
+      "description": "Some external reference, whatever this may be.",
+      "type":"string"
+    },
     "title":{
       "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your recurring [number]'",
       "type":"string"
@@ -100,7 +104,6 @@
     },
     "lock_version":{
       "description": "Auto-incremented to prevent concurrent updateing. First save wins and increments version. ",
-      "optional":true,
       "type":"integer"
     },
     "gross_total":{

data/json/v1.0/user.json

@@ -12,11 +12,11 @@
       "type":"string"
     },
     "first_name": {
-      "description": "First name of a person.",
+      "description": "First name",
       "type":"string"
     },
     "gender": {
-      "description": "Can be empty for a company. Is used in salutation",
+      "description": "The users gender, used in salutation",
       "enum":["male", "female"],
       "type":"string"
     },
@@ -29,12 +29,12 @@
       "type":"string"
     },
     "language": {
-      "description": "the users language inside SK",
-      "optional":true,
+      "description": "The users language, reflected in the interface.",
+      "required":true,
       "type":"string"
     },
     "time_zone": {
-      "description": "the users time zone inside SK",
+      "description": "Time zone",
       "type":"string"
     },
     "email": {
@@ -56,17 +56,14 @@
     },
     "phone_office": {
       "description": "Office phone number",
-      "optional":true,
       "type":"string"
     },
     "phone_home": {
       "description": "Private phone number.",
-      "optional":true,
       "type":"string"
     },
     "phone_mobile": {
       "description": "Mobile phone number",
-      "optional":true,
       "type":"string"
     },
     "created_at": {

data/sk_api_schema.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sk_api_schema}
-  s.version = "0.0.14"
+  s.version = "0.0.15"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Georg Leciejewski"]
-  s.date = %q{2011-02-02}
+  s.date = %q{2011-02-03}
   s.description = %q{SalesKing API JSON schema and utility methods}
   s.email = %q{gl@salesking.eu}
   s.extra_rdoc_files = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     "json/v1.0/attachment.json",
     "json/v1.0/client.json",
     "json/v1.0/comment.json",
+    "json/v1.0/company.json",
     "json/v1.0/credit_note.json",
     "json/v1.0/email.json",
     "json/v1.0/email_template.json",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sk_api_schema
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 0
   - 0
-  - 14
-  version: 0.0.14
+  - 15
+  version: 0.0.15
 platform: ruby
 authors: 
 - Georg Leciejewski
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-02 00:00:00 +01:00
+date: 2011-02-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,7 @@ files:
 - json/v1.0/attachment.json
 - json/v1.0/client.json
 - json/v1.0/comment.json
+- json/v1.0/company.json
 - json/v1.0/credit_note.json
 - json/v1.0/email.json
 - json/v1.0/email_template.json