Bug 33103: Embed aliases in GET /vendors
[koha.git] / api / v1 / swagger / definitions / vendor.yaml
1 ---
2 type: object
3 properties:
4   id:
5     type: integer
6     description: internally assigned vendor identifier
7     readOnly: true
8   name:
9     type:
10       - string
11     description: Vendor name
12   address1:
13     type:
14       - string
15       - "null"
16     description: Vendor physical address (line 1)
17   address2:
18     type:
19       - string
20       - "null"
21     description: Vendor physical address (line 2)
22   address3:
23     type:
24       - string
25       - "null"
26     description: Vendor physical address (line 3)
27   address4:
28     type:
29       - string
30       - "null"
31     description: Vendor physical address (line 4)
32   phone:
33     type:
34       - string
35       - "null"
36     description: Vendor phone number
37   fax:
38     type:
39       - string
40       - "null"
41     description: Vendor fax number
42   accountnumber:
43     type:
44       - string
45       - "null"
46     description: Vendor account number
47   type:
48     type:
49       - string
50       - "null"
51     description: Type of vendor
52   notes:
53     type:
54       - string
55       - "null"
56     description: Vendor notes
57   postal:
58     type:
59       - string
60       - "null"
61     description: Vendor postal address
62   url:
63     type:
64       - string
65       - "null"
66     description: Vendor web address
67   active:
68     type:
69       - boolean
70       - "null"
71     description: Is this vendor active
72   list_currency:
73     type:
74       - string
75       - "null"
76     description: List prices currency
77   invoice_currency:
78     type:
79       - string
80       - "null"
81     description: Invoice prices currency
82   gst:
83     type:
84       - boolean
85       - "null"
86     description: Is the library taxed when buying from this vendor
87   list_includes_gst:
88     type:
89       - boolean
90       - "null"
91     description: List prices include taxes
92   invoice_includes_gst:
93     type:
94       - boolean
95       - "null"
96     description: Invoice prices include taxes
97   tax_rate:
98     type:
99       - number
100       - "null"
101     description: Default tax rate for items ordered from this vendor
102   discount:
103     type:
104       - number
105       - "null"
106     description: Default discount rate for items ordered from this vendor
107   deliverytime:
108     type:
109       - integer
110       - "null"
111     description: Expected delivery time (in days)
112   external_id:
113     type:
114       - string
115       - "null"
116     description: External id
117   aliases:
118     type: array
119     description: List of aliases
120     items:
121       $ref: "vendor_alias.yaml"
122 additionalProperties: false
123 required:
124   - name