Koha/api/v1/swagger/definitions/vendor.yaml
Jonathan Druart 14e5e175fc
Bug 33103: Embed aliases in GET /vendors
Signed-off-by: Jonathan Field <jonathan.field@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-04-20 15:48:38 -03:00

124 lines
2.3 KiB
YAML

---
type: object
properties:
id:
type: integer
description: internally assigned vendor identifier
readOnly: true
name:
type:
- string
description: Vendor name
address1:
type:
- string
- "null"
description: Vendor physical address (line 1)
address2:
type:
- string
- "null"
description: Vendor physical address (line 2)
address3:
type:
- string
- "null"
description: Vendor physical address (line 3)
address4:
type:
- string
- "null"
description: Vendor physical address (line 4)
phone:
type:
- string
- "null"
description: Vendor phone number
fax:
type:
- string
- "null"
description: Vendor fax number
accountnumber:
type:
- string
- "null"
description: Vendor account number
type:
type:
- string
- "null"
description: Type of vendor
notes:
type:
- string
- "null"
description: Vendor notes
postal:
type:
- string
- "null"
description: Vendor postal address
url:
type:
- string
- "null"
description: Vendor web address
active:
type:
- boolean
- "null"
description: Is this vendor active
list_currency:
type:
- string
- "null"
description: List prices currency
invoice_currency:
type:
- string
- "null"
description: Invoice prices currency
gst:
type:
- boolean
- "null"
description: Is the library taxed when buying from this vendor
list_includes_gst:
type:
- boolean
- "null"
description: List prices include taxes
invoice_includes_gst:
type:
- boolean
- "null"
description: Invoice prices include taxes
tax_rate:
type:
- number
- "null"
description: Default tax rate for items ordered from this vendor
discount:
type:
- number
- "null"
description: Default discount rate for items ordered from this vendor
deliverytime:
type:
- integer
- "null"
description: Expected delivery time (in days)
external_id:
type:
- string
- "null"
description: External id
aliases:
type: array
description: List of aliases
items:
$ref: "vendor_alias.yaml"
additionalProperties: false
required:
- name