sk_api_schema 0.10.0 → 0.10.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -17,7 +17,7 @@
17
17
  "maxLength": 100
18
18
  },
19
19
  "account_id":{
20
- "description": "The related account.",
20
+ "description": "The related account. Must be set for entries to be found.",
21
21
  "type":"string",
22
22
  "required":true,
23
23
  "maxLength": 22,
@@ -26,10 +26,10 @@
26
26
  "group_entries_by":{
27
27
  "description": "Group multiple account entries into single line items, when creating a billing+document from entries. Account entries MUST have the SAME price_single and quantity unit, to land in a group. Date base groups also require the SAME entry name.",
28
28
  "type":"string",
29
- "enum": ["none", "name", "day", "week", "month", "year"]
29
+ "enum": ["name", "day", "week", "month", "year"]
30
30
  },
31
31
  "document_type":{
32
- "description": "The document type to create. CamelCase document class name",
32
+ "description": "The document type to create. CamelCase document class name. Invoice by default",
33
33
  "type":"string",
34
34
  "default" : "Invoice",
35
35
  "enum": ["Invoice", "CreditNote", "Order", "Estimate"]
@@ -42,6 +42,7 @@
42
42
  "document_id":{
43
43
  "description": "The document created by the billing.",
44
44
  "type":"string",
45
+ "readonly": true,
45
46
  "maxLength": 22,
46
47
  "minLength":22
47
48
  },
@@ -58,7 +59,7 @@
58
59
  "minLength":22
59
60
  },
60
61
  "creator_id":{
61
- "description": "The user uuid who created the record.",
62
+ "description": "User who created the record.",
62
63
  "type":"string",
63
64
  "maxLength": 22,
64
65
  "minLength":22,
@@ -26,7 +26,7 @@
26
26
  "minLength":22
27
27
  },
28
28
  "item_id":{
29
- "description":"Line item on the document the entry is related to. This relation is set by an account billing.",
29
+ "description":"Line item on the document the entry is related to. This relation is set by an account billing or when a document is booked onto an account.",
30
30
  "readonly":true,
31
31
  "type":"string",
32
32
  "maxLength": 22,
@@ -57,7 +57,7 @@
57
57
  "type":"number"
58
58
  },
59
59
  "quantity_unit":{
60
- "description": "Quantity unit: kg, days, month.",
60
+ "description": "Quantity unit e.g: kg, days, month, ..",
61
61
  "type":"string",
62
62
  "maxLength": 30
63
63
  },
@@ -77,18 +77,18 @@
77
77
  "default": false
78
78
  },
79
79
  "billed_at":{
80
- "description": "Date the object was billed. Is set when the entry is used on an invoice",
80
+ "description": "Date the object was billed. Automatically set when the entry is used on an invoice.",
81
81
  "format":"date-time",
82
82
  "type":"string"
83
83
  },
84
84
  "created_at":{
85
- "description": "Date the object was created in SK. Never changes afterwards",
85
+ "description": "Date the object was created. Never changes afterwards",
86
86
  "format":"date-time",
87
87
  "readonly":true,
88
88
  "type":"string"
89
89
  },
90
90
  "updated_at":{
91
- "description": "Date the object was edited in SK.",
91
+ "description": "Date the object was edited.",
92
92
  "format":"date-time",
93
93
  "readonly":true,
94
94
  "type":"string"
@@ -1,7 +1,7 @@
1
1
  module SK
2
2
  module Api
3
3
  class Schema
4
- VERSION='0.10.0'
4
+ VERSION='0.10.1'
5
5
  end
6
6
  end
7
7
  end
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sk_api_schema
3
3
  version: !ruby/object:Gem::Version
4
- hash: 55
4
+ hash: 53
5
5
  prerelease:
6
6
  segments:
7
7
  - 0
8
8
  - 10
9
- - 0
10
- version: 0.10.0
9
+ - 1
10
+ version: 0.10.1
11
11
  platform: ruby
12
12
  authors:
13
13
  - Georg Leciejewski