Bug 18120: Add '/acquisitions/vendors' endpoint
[koha.git] / api / v1 / swagger / definitions / vendor.json
1 {
2   "type": "object",
3   "properties": {
4     "id": {
5       "$ref": "../x-primitives.json#/vendor_id"
6     },
7     "name": {
8       "type": [
9         "string"
10       ],
11       "description": "Vendor name"
12     },
13     "address1": {
14       "type": [
15         "string",
16         "null"
17       ],
18       "description": "Vendor physical address (line 1)"
19     },
20     "address2": {
21       "type": [
22         "string",
23         "null"
24       ],
25       "description": "Vendor physical address (line 2)"
26     },
27     "address3": {
28       "type": [
29         "string",
30         "null"
31       ],
32       "description": "Vendor physical address (line 3)"
33     },
34     "address4": {
35       "type": [
36         "string",
37         "null"
38       ],
39       "description": "Vendor physical address (line 4)"
40     },
41     "phone": {
42       "type": [
43         "string",
44         "null"
45       ],
46       "description": "Vendor phone number"
47     },
48     "fax": {
49       "type": [
50         "string",
51         "null"
52       ],
53       "description": "Vendor fax number"
54     },
55     "accountnumber": {
56       "type": [
57         "string",
58         "null"
59       ],
60       "description": "Vendor account number"
61     },
62     "notes": {
63       "type": [
64         "string",
65         "null"
66       ],
67       "description": "Vendor notes"
68     },
69     "postal": {
70       "type": [
71         "string",
72         "null"
73       ],
74       "description": "Vendor postal address"
75     },
76     "url": {
77       "type": [
78         "string",
79         "null"
80       ],
81       "description": "Vendor web address"
82     },
83     "active": {
84       "type": [
85         "boolean",
86         "null"
87       ],
88       "description": "Is this vendor active"
89     },
90     "list_currency": {
91       "type": [
92         "string",
93         "null"
94       ],
95       "description": "List prices currency"
96     },
97     "invoice_currency": {
98       "type": [
99         "string",
100         "null"
101       ],
102       "description": "Invoice prices currency"
103     },
104     "gst": {
105       "type": [
106         "boolean",
107         "null"
108       ],
109       "description": "Is the library taxed when buying to this vendor"
110     },
111     "list_includes_gst": {
112       "type": [
113         "boolean",
114         "null"
115       ],
116       "description": "List prices include taxes"
117     },
118     "invoice_includes_gst": {
119       "type": [
120         "boolean",
121         "null"
122       ],
123       "description": "Invoice prices include taxes"
124     },
125     "tax_rate": {
126       "type": [
127         "number",
128         "null"
129       ],
130       "description": "Tax rate"
131     },
132     "discount": {
133       "type": [
134         "number",
135         "null"
136       ],
137       "description": "Discount offered on all items ordered from this vendor"
138     },
139     "deliverytime": {
140       "type": [
141         "integer",
142         "null"
143       ],
144       "description": "Vendor expected delivery time (in days)"
145     }
146   },
147   "additionalProperties": false,
148   "required": ["name"]
149 }