sk_api_schema 0.10.5 → 0.10.6

data/json/v2.0/sub.json

@@ -0,0 +1,60 @@
+{"type":"object",
+  "title": "sub",
+  "name": "sub",
+  "description": "Subscribe to push notifications(webhooks) about object livecycle events like new, update or delete. Only returns subscription for the current app, so you MUST be using oAuth. When a user removes your app its subs are also deleted. <br/>To register you must supply <br/>- callback_url: receives a base64 encode string containing a JSON object with the object in it's latest state, the user_id & subdomain, company_id, hmac-signed with your app secret.<br/>- channel: defining the event, made up of the SINGULAR object name and the action: invoice.delete, payment.new<br/> - register auth_permissions: An app MUST request non-api permissions f.ex.: clients:create. Perms(on company,app,user,team) are checked before any publishing, so if a user cannot create clients in the interface, his apps will not receive any callbacks.",
+  "properties":{
+    "id":{
+      "description":"Unique identifier - UUID",
+      "identity":true,
+      "readonly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "channel":{
+      "description": "The channel to which to subscribe. See available at subs/channels.",
+      "required":true,
+      "type":"string",
+      "maxLength": 100
+    },
+    "callback_url":{
+      "description": "An url receiving the notification. The url MUST be within the url of the current app and receives a POST with a single signed_request parameter containing an base64 encoded JSON object.",
+      "type":"string",
+      "format":"uri",
+      "required":true,
+      "maxLength": 100
+    },
+    "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": "{id}"
+    },
+    { "rel": "instances",
+      "href": "subs/"
+    },
+    { "rel": "destroy",
+      "href": "subs/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "subs/{id}",
+      "method": "PUT"
+    },
+    { "rel": "subs/channels",
+      "href": "subs/channels"
+    }
+  ]
+}

data/json/v2.0/sub_total_item.json

@@ -0,0 +1,57 @@
+{ "type":"object",
+  "title": "sub_total_item",
+  "name": "sub_total_item",
+  "description": "A sub-total item shows a sum of the previous line items, e.g. to distinguish hardware and service costs on a document.",
+  "properties":{
+    "id":{
+      "description":"Unique identifier - UUID",
+      "identity":true,
+      "readonly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "position":{
+      "description": "Required since items are sorted by position.",
+      "type":"integer",
+      "required":true
+    },
+    "name":{
+      "description": "Title of the sub-total e.g. Hardware total",
+      "type":"string",
+      "maxLength": 50
+    },
+    "type":{
+      "description": "The item type: SubTotalItem. Must be set when creating new items via document.items array",
+      "type":"string",
+      "maxLength": 20
+    },
+    "net_total":{
+      "description": "Net sub-total",
+      "type":"number",
+      "readonly":true
+    },
+    "gross_total":{
+      "description": "Gross sub-total",
+      "type":"number",
+      "readonly":true
+    },
+   "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"
+    },
+    "_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"
+    }
+  },
+  "links":[]
+}

data/json/v2.0/tag.json

@@ -0,0 +1,76 @@
+{ "type":"object",
+  "title": "tag",
+  "name": "tag",
+  "description":"A tag",
+  "properties":{
+    "id":{
+      "description":"Unique identifier - UUID",
+      "identity":true,
+      "readonly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "name":{
+      "description": "The tag itself",
+      "readonly":true,
+      "type":"string",
+      "maxLength": 50
+    },
+    "taggings_count":{
+      "description": "Usage count of this tag, for all objects in whole company scope.",
+      "readonly":true,
+      "type":"number"
+    }
+  },
+  "links":[
+    { "rel": "self",
+      "href": "tags/{id}"
+    },
+    { "rel": "instances",
+      "href": "tags",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "per_page":{
+          "title" : "Per page",
+          "description": "Results per page. Default is 50, max is 200",
+          "type":"number"
+        },
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in name",
+          "type":"string"
+        },
+        "filter[related_object_type]":{
+          "title" : "Related object type",
+          "description": "Filter tags by their related object base type",
+          "type":"string"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field",
+          "enum":["filename","taggings_count"],
+          "type": "string"
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC",
+          "type": "string"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "tags/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "tags/{id}",
+      "method": "PUT"
+    }
+  ]
+}

data/json/v2.0/task.json

@@ -0,0 +1,229 @@
+{ "type":"object",
+  "title": "task",
+  "name": "task",
+  "description":"An Task in SK.",
+  "properties":{
+    "id":{
+      "description":"Unique identifier - UUID",
+      "identity":true,
+      "readonly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "name":{
+      "description": "The task title.",
+      "required":true,
+      "type":"string"
+    },
+    "description":{
+      "description": "Notes, explanations for the task.",
+      "required":true,
+      "type":"string"
+    },
+    "status":{
+      "description": "New tasks are open by default, unless otherwise stated.",
+      "default":"open",
+      "enum":["open","closed","overdue"],
+      "type":"string"
+    },
+    "contact_id":{
+      "description": "Related contact of the tasks.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "contact":{
+      "description": "The contact for the task. Use contact_id field to set a contact.",
+      "readonly":true,
+      "type":"object",
+      "properties":{"$ref":"./contact.json#properties"}
+    },
+    "documents":{
+      "description": "A tasks can have many related documents.",
+      "type":"array",
+      "properties" : {"$ref":"./document.json#properties"}
+    },
+    "attachments":{
+      "description": "Attached files, uploads.",
+      "readonly":true,
+      "type":"array",
+      "properties":{"$ref":"./attachment.json#properties"}
+    },
+    "assignee_id":{
+      "description": "User who should do the tasks.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "creator_id":{
+      "description": "User who created the tasks.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "closed_at":{
+      "description": "Date the task was completed.",
+      "format":"date",
+      "readonly":true,
+      "type":"string"
+    },
+    "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"
+    }
+  },
+   "links":[
+    { "rel": "self",
+      "href": "tasks/{id}"
+    },
+    { "rel": "instances",
+      "href": "tasks",
+      "properties" : {
+        "filter[q]":{
+          "title" : "Search",
+          "description": "Search in name, description",
+          "type":"string"
+        },
+        "filter[status]":{
+          "title" : "Status",
+          "description": "A single or a list of status, comma separated: open,closed,overdue",
+          "type" : "string"
+        },
+        "filter[ids]":{
+          "title" : "Task IDs",
+          "description": "Only find tasks with given ids. Comma-separated list of task IDs.",
+          "type" : "string"
+        },
+        "filter[contact_ids]":{
+          "title" : "Contact IDs",
+          "description": "Tasks related to given contacts. Comma-separated list of contact IDs.",
+          "type" : "string"
+        },
+        "filter[creator_ids]":{
+          "title" : "Creator IDs",
+          "description": "Tasks created by given users. Comma-separated list of user IDs.",
+          "type" : "string"
+        },
+        "filter[assignee_ids]":{
+          "title" : "Assignee IDs",
+          "description": "Tasks assigned to given users. Comma-separated list of user IDs.",
+          "type" : "string"
+        },
+        "filter[due_at_from]":{
+          "title" : "From date",
+          "description": "Tasks due after the date(>=). YYYY-MM-DD",
+          "format" : "date",
+          "type" : "string"
+        },
+        "filter[due_at_to]":{
+          "title" : "To date",
+          "description": "Tasks due before the date(<=). YYYY-MM-DD",
+          "format" : "date",
+          "type" : "string"
+        },
+        "filter[closed_at_from]":{
+          "title" : "From date",
+          "description": "Tasks closed after the date(>=). YYYY-MM-DD",
+          "format" : "date",
+          "type" : "string"
+        },
+        "filter[closed_at_to]":{
+          "title" : "To date",
+          "description": "Tasks closed before the date(<=). YYYY-MM-DD",
+          "format" : "date",
+          "type" : "string"
+        },
+        "filter[updated_at_from]":{
+          "title" : "From date",
+          "description": "Tasks updated after the date(>=). YYYY-MM-DD",
+          "format" : "date",
+          "type" : "string"
+        },
+        "filter[updated_at_to]":{
+          "title" : "To date",
+          "description": "Tasks updated before the date(<=). YYYY-MM-DD",
+          "format" : "date",
+          "type" : "string"
+        },
+        "filter[created_at_from]":{
+          "title" : "From date",
+          "description": "Tasks created after the date(>=). YYYY-MM-DD",
+          "format" : "date",
+          "type" : "string"
+        },
+        "filter[created_at_to]":{
+          "title" : "To date",
+          "description": "Tasks created before the date(<=). YYYY-MM-DD",
+          "format" : "date",
+          "type" : "string"
+        },
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "per_page":{
+          "title" : "Per page",
+          "description": "Results per page. Default is 50, max is 200",
+          "type":"number"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":["created_at", "updated_at"],
+          "type": "string"
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC",
+          "type": "string"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "tasks/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "tasks/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "tasks",
+      "method": "POST",
+      "properties" : {
+        "template_id":{
+          "title" : "Task Template",
+          "description": "Task template(id) to use. If set template fields like name, description, attachments are used for the new task.",
+          "type":"string",
+          "maxLength": 22,
+          "minLength":22
+        },
+        "document_id":{
+          "title" : "Create a task for the document.",
+          "description": "If set: the document, its contact and due date are used for the task. Dont forget to set a task.name though. Useful if you want to create a reminder when the document is due e.g call contact.",
+          "type":"string",
+          "maxLength": 22,
+          "minLength":22
+        },
+        "source":{
+          "title" : "Copy a task.",
+          "description": "Uses name, description, contact, documents from given given source task.",
+          "type":"string",
+          "maxLength": 22,
+          "minLength":22
+        }
+      }
+    }
+  ]
+}

data/json/v2.0/text_template.json

@@ -0,0 +1,95 @@
+{ "type":"object",
+  "title": "text_template",
+  "name": "text_template",
+  "description":"An text_template in SK",
+  "properties":{
+    "id":{
+      "description":"Unique identifier - UUID",
+      "identity":true,
+      "readonly":true,
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    },
+    "name":{
+      "description": "A meaningful name.",
+      "required":true,
+      "type":"string",
+      "maxLength": 50
+    },
+    "text":{
+      "description": "Text which may contain placeholders, replaced when the template is used.",
+      "required":true,
+      "type":"string",
+      "format":"text"
+    },
+    "kind":{
+      "description": "Kind of object the template can be used for. If empty the snippet can be used global. In this case watch not all placeholders are available: a client has different fields than an invoice.",
+      "required":true,
+      "enum": ["","invoice", "estimate", "credit_note", "payment_reminder", "order", "contact", "email"],
+      "type":"string"
+    },
+    "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"
+    },
+    "team_id":{
+      "description": "A team uuid. If set only the team and its parent teams can see the record.",
+      "type":"string",
+      "maxLength": 22,
+      "minLength":22
+    }
+  },
+   "links":[
+    { "rel": "self",
+      "href": "text_templates/{id}"
+    },
+    { "rel": "instances",
+      "href": "text_templates",
+      "properties" : {
+        "page":{
+          "title" : "Page",
+          "description": "In paginated results set the page to look for",
+          "type":"number"
+        },
+        "per_page":{
+          "title" : "Per page",
+          "description": "Results per page. Default is 50, max is 200",
+          "type":"number"
+        },
+        "sort_by":{
+          "title" : "Sort by",
+          "description": "Sort the results by the given field => number",
+          "enum":["created_at", "updated_at"],
+          "type": "string"
+        },
+        "sort":{
+          "title" : "Sort",
+          "enum":["ASC","DESC"],
+          "description": "Sort the results in ASC or DESC",
+          "type": "string"
+        }
+      }
+    },
+    { "rel": "destroy",
+      "href": "text_templates/{id}",
+      "method": "DELETE"
+    },
+    { "rel": "update",
+      "href": "text_templates/{id}",
+      "method": "PUT"
+    },
+    { "rel": "create",
+      "href": "text_templates",
+      "method": "POST"
+    }
+  ]
+}