mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-12 14:12:44 +01:00
342 lines
11 KiB
YAML
342 lines
11 KiB
YAML
|
/api/v1/vendors:
|
||
|
|
get:
|
||
|
|
tags:
|
||
|
|
- vendors
|
||
|
|
summary: "List vendors"
|
||
|
|
description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available"
|
||
|
|
operationId: getVendors
|
||
|
|
parameters:
|
||
|
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||
|
|
- $ref: "#/components/parameters/X-Requested-With"
|
||
|
|
- $ref: "#/components/parameters/include"
|
||
|
|
- $ref: "#/components/parameters/index"
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: "A list of vendors"
|
||
|
|
headers:
|
||
|
|
X-MINIMUM-CLIENT-VERSION:
|
||
|
|
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||
|
|
X-RateLimit-Remaining:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||
|
|
X-RateLimit-Limit:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Limit"
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Vendor"
|
||
|
|
401:
|
||
|
|
$ref: "#/components/responses/401"
|
||
|
|
403:
|
||
|
|
$ref: "#/components/responses/403"
|
||
|
|
422:
|
||
|
|
$ref: "#/components/responses/422"
|
||
|
|
default:
|
||
|
|
$ref: "#/components/responses/default"
|
||
|
|
post:
|
||
|
|
tags:
|
||
|
|
- vendors
|
||
|
|
summary: "Create vendor"
|
||
|
|
description: "Adds a vendor to a company"
|
||
|
|
operationId: storeVendor
|
||
|
|
parameters:
|
||
|
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||
|
|
- $ref: "#/components/parameters/X-Requested-With"
|
||
|
|
- $ref: "#/components/parameters/include"
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: "Returns the saved clivendorent object"
|
||
|
|
headers:
|
||
|
|
X-MINIMUM-CLIENT-VERSION:
|
||
|
|
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||
|
|
X-RateLimit-Remaining:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||
|
|
X-RateLimit-Limit:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Limit"
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Vendor"
|
||
|
|
401:
|
||
|
|
$ref: "#/components/responses/401"
|
||
|
|
403:
|
||
|
|
$ref: "#/components/responses/403"
|
||
|
|
422:
|
||
|
|
$ref: "#/components/responses/422"
|
||
|
|
default:
|
||
|
|
$ref: "#/components/responses/default"
|
||
|
|
"/api/v1/vendors/{id}":
|
||
|
|
get:
|
||
|
|
tags:
|
||
|
|
- vendors
|
||
|
|
summary: "Show vendor"
|
||
|
|
description: "Displays a vendor by id"
|
||
|
|
operationId: showVendor
|
||
|
|
parameters:
|
||
|
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||
|
|
- $ref: "#/components/parameters/X-Requested-With"
|
||
|
|
- $ref: "#/components/parameters/include"
|
||
|
|
- name: id
|
||
|
|
in: path
|
||
|
|
description: "The vendor Hashed ID"
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
format: string
|
||
|
|
example: D2J234DFA
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: "Returns the vendor object"
|
||
|
|
headers:
|
||
|
|
X-MINIMUM-CLIENT-VERSION:
|
||
|
|
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||
|
|
X-RateLimit-Remaining:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||
|
|
X-RateLimit-Limit:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Limit"
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Vendor"
|
||
|
|
401:
|
||
|
|
$ref: "#/components/responses/401"
|
||
|
|
403:
|
||
|
|
$ref: "#/components/responses/403"
|
||
|
|
422:
|
||
|
|
$ref: "#/components/responses/422"
|
||
|
|
default:
|
||
|
|
$ref: "#/components/responses/default"
|
||
|
|
put:
|
||
|
|
tags:
|
||
|
|
- vendors
|
||
|
|
summary: "Update vendor"
|
||
|
|
description: "Handles the updating of a vendor by id"
|
||
|
|
operationId: updateVendor
|
||
|
|
parameters:
|
||
|
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||
|
|
- $ref: "#/components/parameters/X-Requested-With"
|
||
|
|
- $ref: "#/components/parameters/include"
|
||
|
|
- name: id
|
||
|
|
in: path
|
||
|
|
description: "The Vendor Hashed ID"
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
format: string
|
||
|
|
example: D2J234DFA
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: "Returns the vendor object"
|
||
|
|
headers:
|
||
|
|
X-MINIMUM-CLIENT-VERSION:
|
||
|
|
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||
|
|
X-RateLimit-Remaining:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||
|
|
X-RateLimit-Limit:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Limit"
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Vendor"
|
||
|
|
401:
|
||
|
|
$ref: "#/components/responses/401"
|
||
|
|
403:
|
||
|
|
$ref: "#/components/responses/403"
|
||
|
|
422:
|
||
|
|
$ref: "#/components/responses/422"
|
||
|
|
default:
|
||
|
|
$ref: "#/components/responses/default"
|
||
|
|
delete:
|
||
|
|
tags:
|
||
|
|
- vendors
|
||
|
|
summary: "Delete vendor"
|
||
|
|
description: "Handles the deletion of a vendor by id"
|
||
|
|
operationId: deleteVendor
|
||
|
|
parameters:
|
||
|
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||
|
|
- $ref: "#/components/parameters/X-Requested-With"
|
||
|
|
- $ref: "#/components/parameters/include"
|
||
|
|
- name: id
|
||
|
|
in: path
|
||
|
|
description: "The Vendor Hashed ID"
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
format: string
|
||
|
|
example: D2J234DFA
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: "Returns a HTTP status"
|
||
|
|
headers:
|
||
|
|
X-MINIMUM-CLIENT-VERSION:
|
||
|
|
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||
|
|
X-RateLimit-Remaining:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||
|
|
X-RateLimit-Limit:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Limit"
|
||
|
|
401:
|
||
|
|
$ref: "#/components/responses/401"
|
||
|
|
403:
|
||
|
|
$ref: "#/components/responses/403"
|
||
|
|
422:
|
||
|
|
$ref: "#/components/responses/422"
|
||
|
|
default:
|
||
|
|
$ref: "#/components/responses/default"
|
||
|
|
"/api/v1/vendors/{id}/edit":
|
||
|
|
get:
|
||
|
|
tags:
|
||
|
|
- vendors
|
||
|
|
summary: "Edit vendor"
|
||
|
|
description: "Displays a vendor by id"
|
||
|
|
operationId: editVendor
|
||
|
|
parameters:
|
||
|
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||
|
|
- $ref: "#/components/parameters/X-Requested-With"
|
||
|
|
- $ref: "#/components/parameters/include"
|
||
|
|
- name: id
|
||
|
|
in: path
|
||
|
|
description: "The Vendor Hashed ID"
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
format: string
|
||
|
|
example: D2J234DFA
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: "Returns the vendor object"
|
||
|
|
headers:
|
||
|
|
X-MINIMUM-CLIENT-VERSION:
|
||
|
|
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||
|
|
X-RateLimit-Remaining:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||
|
|
X-RateLimit-Limit:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Limit"
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Vendor"
|
||
|
|
401:
|
||
|
|
$ref: "#/components/responses/401"
|
||
|
|
403:
|
||
|
|
$ref: "#/components/responses/403"
|
||
|
|
422:
|
||
|
|
$ref: "#/components/responses/422"
|
||
|
|
default:
|
||
|
|
$ref: "#/components/responses/default"
|
||
|
|
/api/v1/vendors/create:
|
||
|
|
get:
|
||
|
|
tags:
|
||
|
|
- vendors
|
||
|
|
summary: "Blank vendor"
|
||
|
|
description: "Returns a blank vendor with default values"
|
||
|
|
operationId: getVendorsCreate
|
||
|
|
parameters:
|
||
|
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||
|
|
- $ref: "#/components/parameters/X-Requested-With"
|
||
|
|
- $ref: "#/components/parameters/include"
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: "A blank vendor object"
|
||
|
|
headers:
|
||
|
|
X-MINIMUM-CLIENT-VERSION:
|
||
|
|
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||
|
|
X-RateLimit-Remaining:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||
|
|
X-RateLimit-Limit:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Limit"
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Vendor"
|
||
|
|
401:
|
||
|
|
$ref: "#/components/responses/401"
|
||
|
|
403:
|
||
|
|
$ref: "#/components/responses/403"
|
||
|
|
422:
|
||
|
|
$ref: "#/components/responses/422"
|
||
|
|
default:
|
||
|
|
$ref: "#/components/responses/default"
|
||
|
|
/api/v1/vendors/bulk:
|
||
|
|
post:
|
||
|
|
tags:
|
||
|
|
- vendors
|
||
|
|
summary: "Bulk vendor actions"
|
||
|
|
description: ""
|
||
|
|
operationId: bulkVendors
|
||
|
|
parameters:
|
||
|
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||
|
|
- $ref: "#/components/parameters/X-Requested-With"
|
||
|
|
- $ref: "#/components/parameters/index"
|
||
|
|
requestBody:
|
||
|
|
description: "User credentials"
|
||
|
|
required: true
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
type: array
|
||
|
|
items:
|
||
|
|
description: "Array of hashed IDs to be bulk 'actioned"
|
||
|
|
type: integer
|
||
|
|
example: "[0,1,2,3]"
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: "The Vendor User response"
|
||
|
|
headers:
|
||
|
|
X-MINIMUM-CLIENT-VERSION:
|
||
|
|
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||
|
|
X-RateLimit-Remaining:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||
|
|
X-RateLimit-Limit:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Limit"
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Vendor"
|
||
|
|
401:
|
||
|
|
$ref: "#/components/responses/401"
|
||
|
|
403:
|
||
|
|
$ref: "#/components/responses/403"
|
||
|
|
422:
|
||
|
|
$ref: "#/components/responses/422"
|
||
|
|
default:
|
||
|
|
$ref: "#/components/responses/default"
|
||
|
|
"/api/v1/vendors/{id}/upload":
|
||
|
|
put:
|
||
|
|
tags:
|
||
|
|
- vendors
|
||
|
|
summary: "Uploads a vendor document"
|
||
|
|
description: "Handles the uploading of a document to a vendor"
|
||
|
|
operationId: uploadVendor
|
||
|
|
parameters:
|
||
|
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||
|
|
- $ref: "#/components/parameters/X-Requested-With"
|
||
|
|
- $ref: "#/components/parameters/include"
|
||
|
|
- name: id
|
||
|
|
in: path
|
||
|
|
description: "The Vendor Hashed ID"
|
||
|
|
required: true
|
||
|
|
schema:
|
||
|
|
type: string
|
||
|
|
format: string
|
||
|
|
example: D2J234DFA
|
||
|
|
responses:
|
||
|
|
200:
|
||
|
|
description: "Returns the Vendor object"
|
||
|
|
headers:
|
||
|
|
X-MINIMUM-CLIENT-VERSION:
|
||
|
|
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||
|
|
X-RateLimit-Remaining:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||
|
|
X-RateLimit-Limit:
|
||
|
|
$ref: "#/components/headers/X-RateLimit-Limit"
|
||
|
|
content:
|
||
|
|
application/json:
|
||
|
|
schema:
|
||
|
|
$ref: "#/components/schemas/Vendor"
|
||
|
|
401:
|
||
|
|
$ref: "#/components/responses/401"
|
||
|
|
403:
|
||
|
|
$ref: "#/components/responses/403"
|
||
|
|
422:
|
||
|
|
$ref: "#/components/responses/422"
|
||
|
|
default:
|
||
|
|
$ref: "#/components/responses/default"
|