mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-09-20 08:21:34 +02:00
Updates for API docs
This commit is contained in:
parent
cb056a034e
commit
8e59dfbfcb
File diff suppressed because it is too large
Load Diff
@ -17,6 +17,39 @@ tags:
|
||||
- name: recurring_invoices
|
||||
description: |
|
||||
Endpoint definitions for interacting with recurring_invoices.
|
||||
- name: payments
|
||||
description: |
|
||||
Endpoint definitions for interacting with payments.
|
||||
- name: quotes
|
||||
description: |
|
||||
Endpoint definitions for interacting with quotes.
|
||||
- name: credits
|
||||
description: |
|
||||
Endpoint definitions for interacting with credits.
|
||||
- name: projects
|
||||
description: |
|
||||
Endpoint definitions for interacting with projects.
|
||||
- name: tasks
|
||||
description: |
|
||||
Endpoint definitions for interacting with tasks.
|
||||
- name: vendors
|
||||
description: |
|
||||
Endpoint definitions for interacting with vendors.
|
||||
- name: purchase_orders
|
||||
description: |
|
||||
Endpoint definitions for interacting with purchase orders.
|
||||
- name: expenses
|
||||
description: |
|
||||
Endpoint definitions for interacting with expenses.
|
||||
- name: recurring_expenses
|
||||
description: |
|
||||
Endpoint definitions for interacting with recurring_expenses.
|
||||
- name: bank_transactions
|
||||
description: |
|
||||
Endpoint definitions for interacting with bank transactions.
|
||||
- name: reports
|
||||
description: |
|
||||
Endpoint definitions for interacting with reports.
|
||||
externalDocs:
|
||||
description: "https://invoiceninja.github.io"
|
||||
url: "https://invoiceninja.github.io"
|
||||
|
2729
openapi/paths.yaml
2729
openapi/paths.yaml
File diff suppressed because it is too large
Load Diff
384
openapi/paths/credits.yaml
Normal file
384
openapi/paths/credits.yaml
Normal file
@ -0,0 +1,384 @@
|
||||
/api/v1/credits:
|
||||
get:
|
||||
tags:
|
||||
- credits
|
||||
summary: "List credits"
|
||||
description: "Lists credits, 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 credits, these are handled by the CreditFilters class which defines the methods available"
|
||||
operationId: getCredits
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "A list of credits"
|
||||
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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
post:
|
||||
tags:
|
||||
- credits
|
||||
summary: "Create credit"
|
||||
description: "Adds an credit to the system"
|
||||
operationId: storeCredit
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the saved credit 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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
|
||||
"/api/v1/credits/{id}":
|
||||
get:
|
||||
tags:
|
||||
- credits
|
||||
summary: "Show credit"
|
||||
description: "Displays an credit by id"
|
||||
operationId: showCredit
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Credit Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the credit 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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
put:
|
||||
tags:
|
||||
- Credits
|
||||
summary: "Update credit"
|
||||
description: "Handles the updating of an Credit by id"
|
||||
operationId: updateCredit
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Credit Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Credit 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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
delete:
|
||||
tags:
|
||||
- credits
|
||||
summary: "Delete credit"
|
||||
description: "Handles the deletion of an credit by id"
|
||||
operationId: deleteCredit
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Credit 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/credits/{id}/edit":
|
||||
get:
|
||||
tags:
|
||||
- credits
|
||||
summary: "Edit credit"
|
||||
description: "Displays an credit by id"
|
||||
operationId: editCredit
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Invoice Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the credit 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/Invoice"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/credits/create:
|
||||
get:
|
||||
tags:
|
||||
- credits
|
||||
summary: "Blank credit"
|
||||
description: "Returns a blank object with default values"
|
||||
operationId: getCreditsCreate
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "A blank credit 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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/credits/bulk:
|
||||
post:
|
||||
tags:
|
||||
- credits
|
||||
summary: "Bulk credit actions"
|
||||
description: ""
|
||||
operationId: bulkCredits
|
||||
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 Bulk Action 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"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/credit/{invitation_key}/download":
|
||||
get:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Download quote PDF"
|
||||
description: "Downloads a specific quote"
|
||||
operationId: downloadCredit
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: invitation_key
|
||||
in: path
|
||||
description: "The Credit Invitation Key"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the credit pdf"
|
||||
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/credits/{id}/upload":
|
||||
put:
|
||||
tags:
|
||||
- credits
|
||||
summary: "Upload a credit document"
|
||||
description: "Handles the uploading of a document to a credit"
|
||||
operationId: uploadCredits
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Credit Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Credit 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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
476
openapi/paths/payments.yaml
Normal file
476
openapi/paths/payments.yaml
Normal file
@ -0,0 +1,476 @@
|
||||
/api/v1/payments:
|
||||
get:
|
||||
tags:
|
||||
- payments
|
||||
summary: "List payments"
|
||||
description: "Lists payments, 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 payments, these are handled by the PaymentFilters class which defines the methods available"
|
||||
operationId: getPayments
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- $ref: "#/components/parameters/status"
|
||||
- $ref: "#/components/parameters/client_id"
|
||||
- $ref: "#/components/parameters/created_at"
|
||||
- $ref: "#/components/parameters/updated_at"
|
||||
- $ref: "#/components/parameters/is_deleted"
|
||||
- $ref: "#/components/parameters/filter_deleted_clients"
|
||||
- $ref: "#/components/parameters/vendor_id"
|
||||
- name: filter
|
||||
in: query
|
||||
description: |
|
||||
Searches across a range of columns including:
|
||||
- amount
|
||||
- date
|
||||
- custom_value1
|
||||
- custom_value2
|
||||
- custom_value3
|
||||
- custom_value4
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: ?filter=10
|
||||
- name: number
|
||||
in: query
|
||||
description: |
|
||||
Search payments by payment number
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: ?number=0001
|
||||
- name: sort
|
||||
in: query
|
||||
description: Returns the list sorted by column in ascending or descending order.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: id|desc number|desc balance|asc
|
||||
responses:
|
||||
200:
|
||||
description: "A list of payments"
|
||||
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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
post:
|
||||
tags:
|
||||
- payments
|
||||
summary: "Create payment"
|
||||
description: "Adds an Payment to the system"
|
||||
operationId: storePayment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
requestBody:
|
||||
description: "The payment request"
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Payment"
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the saved Payment 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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
|
||||
"/api/v1/payments/{id}":
|
||||
get:
|
||||
tags:
|
||||
- payments
|
||||
summary: "Show payment"
|
||||
description: "Displays an Payment by id"
|
||||
operationId: showPayment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Payment Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Payment 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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
put:
|
||||
tags:
|
||||
- payments
|
||||
summary: "Update payment"
|
||||
description: "Handles the updating of an Payment by id"
|
||||
operationId: updatePayment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Payment Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Payment 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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
delete:
|
||||
tags:
|
||||
- payments
|
||||
summary: "Delete payment"
|
||||
description: "Handles the deletion of an Payment by id"
|
||||
operationId: deletePayment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Payment 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/payments/{id}/edit":
|
||||
get:
|
||||
tags:
|
||||
- payments
|
||||
summary: "Edit payment"
|
||||
description: "Displays an Payment by id"
|
||||
operationId: editPayment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Payment Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Payment 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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/payments/create:
|
||||
get:
|
||||
tags:
|
||||
- payments
|
||||
summary: "Blank payment"
|
||||
description: "Returns a blank object with default values"
|
||||
operationId: getPaymentsCreate
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "A blank Payment 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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/payments/refund:
|
||||
post:
|
||||
tags:
|
||||
- payments
|
||||
summary: "Refund payment"
|
||||
description: "Adds an Refund to the system"
|
||||
operationId: storeRefund
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
requestBody:
|
||||
description: "The refund request"
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/Payment"
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the saved Payment 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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/payments/bulk:
|
||||
post:
|
||||
tags:
|
||||
- payments
|
||||
summary: "Bulk payment actions"
|
||||
description: ""
|
||||
operationId: bulkPayments
|
||||
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 Payment 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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/payments/{id}/{action}":
|
||||
get:
|
||||
deprecated: true
|
||||
tags:
|
||||
- payments
|
||||
summary: "Custom payment actions"
|
||||
description: "Performs a custom action on an Payment.\n\n The current range of actions are as follows\n - clone_to_Payment\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email"
|
||||
operationId: actionPayment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Payment Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
- name: action
|
||||
in: path
|
||||
description: "The action string to be performed"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: clone_to_quote
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Payment 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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
|
||||
"/api/v1/payments/{id}/upload":
|
||||
put:
|
||||
tags:
|
||||
- payments
|
||||
summary: "Upload a payment document"
|
||||
description: "Handles the uploading of a document to a payment"
|
||||
operationId: uploadPayment
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Payment Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Payment 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/Payment"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
342
openapi/paths/projects.yaml
Normal file
342
openapi/paths/projects.yaml
Normal file
@ -0,0 +1,342 @@
|
||||
/api/v1/projects:
|
||||
get:
|
||||
tags:
|
||||
- projects
|
||||
summary: "List projects"
|
||||
description: "Lists projects"
|
||||
operationId: getProjects
|
||||
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 projects"
|
||||
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/Project"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
post:
|
||||
tags:
|
||||
- projects
|
||||
summary: "Create project"
|
||||
description: "Adds an project to a company"
|
||||
operationId: storeProject
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the saved project 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/Project"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/projects/{id}":
|
||||
get:
|
||||
tags:
|
||||
- projects
|
||||
summary: "Show project"
|
||||
description: "Displays a project by id"
|
||||
operationId: showProject
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Project Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the expense 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/Project"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
put:
|
||||
tags:
|
||||
- projects
|
||||
summary: "Update project"
|
||||
description: "Handles the updating of a project by id"
|
||||
operationId: updateProject
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Project Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the project 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/Project"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
delete:
|
||||
tags:
|
||||
- projects
|
||||
summary: "Delete project"
|
||||
description: "Handles the deletion of a project by id"
|
||||
operationId: deleteProject
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Project 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/projects/{id}/edit":
|
||||
get:
|
||||
tags:
|
||||
- projects
|
||||
summary: "Edit project"
|
||||
description: "Displays a project by id"
|
||||
operationId: editProject
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Project Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the project 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/Project"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/projects/create:
|
||||
get:
|
||||
tags:
|
||||
- projects
|
||||
summary: "Blank project"
|
||||
description: "Returns a blank object with default values"
|
||||
operationId: getProjectsCreate
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "A blank project 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/Project"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/projects/bulk:
|
||||
post:
|
||||
tags:
|
||||
- projects
|
||||
summary: "Bulk project actions"
|
||||
description: ""
|
||||
operationId: bulkProjects
|
||||
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 Project 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/Project"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/projects/{id}/upload":
|
||||
put:
|
||||
tags:
|
||||
- projects
|
||||
summary: "Uploads a project document"
|
||||
description: "Handles the uploading of a document to a project"
|
||||
operationId: uploadProject
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Project Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Project 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/Project"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
427
openapi/paths/purchase_orders.yaml
Normal file
427
openapi/paths/purchase_orders.yaml
Normal file
@ -0,0 +1,427 @@
|
||||
/api/v1/purchase_orders:
|
||||
get:
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "List purchase orders"
|
||||
description: "Lists purchase orders, 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 purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available"
|
||||
operationId: getPurchaseOrders
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "A list of purchase orders"
|
||||
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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
post:
|
||||
tags:
|
||||
- purhcase_orders
|
||||
summary: "Create purchase order"
|
||||
description: "Adds an purchase order to the system"
|
||||
operationId: storePurchaseOrder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the saved purchase order 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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
|
||||
"/api/v1/purchase_orders/{id}":
|
||||
get:
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "Show purchase order"
|
||||
description: "Displays an purchase order by id"
|
||||
operationId: showPurchaseOrder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Purchase order Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the purchase order 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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/purchase_order/{id}":
|
||||
put:
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "Update purchase order"
|
||||
description: "Handles the updating of an purchase order by id"
|
||||
operationId: updatePurchaseOrder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The purchase order Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the purchase order 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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
delete:
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "Delete purchase order"
|
||||
description: "Handles the deletion of an purchase orders by id"
|
||||
operationId: deletePurchaseOrder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The purhcase order 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/purchase_orders/{id}/edit":
|
||||
get:
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "Edit purchase order"
|
||||
description: "Displays an purchase order by id"
|
||||
operationId: editPurchaseOrder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The purchase order Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the purchase order 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/Invoice"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
|
||||
/api/v1/purchase_orders/create:
|
||||
get:
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "Blank purchase order"
|
||||
description: "Returns a blank object with default values"
|
||||
operationId: getPurchaseOrderCreate
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "A blank purchase order 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/Credit"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/purchase_orders/bulk:
|
||||
post:
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "Bulk purchase order action"
|
||||
description: ""
|
||||
operationId: bulkPurchaseOrderss
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/index"
|
||||
requestBody:
|
||||
description: "Purchase Order IDS"
|
||||
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 Bulk Action 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"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/purchase_orders/{id}/{action}":
|
||||
get:
|
||||
deprecated: true
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "Custom purchase order actions"
|
||||
description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email"
|
||||
operationId: actionPurchaseOrder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Purchase Order Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
- name: action
|
||||
in: path
|
||||
description: "The action string to be performed"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: clone_to_quote
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the invoice 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/Invoice"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/purchase_orders/{id}/upload":
|
||||
put:
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "Uploads a purchase order document"
|
||||
description: "Handles the uploading of a document to a purchase_order"
|
||||
operationId: uploadPurchaseOrder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Purchase Order Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Purchase Order 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/purchase_order/{invitation_key}/download":
|
||||
get:
|
||||
tags:
|
||||
- purchase_orders
|
||||
summary: "Download a purchase order PDF"
|
||||
description: "Downloads a specific purchase order"
|
||||
operationId: downloadPurchaseOrder
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: invitation_key
|
||||
in: path
|
||||
description: "The Purchase Order Invitation Key"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Purchase Order pdf"
|
||||
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"
|
477
openapi/paths/quotes.yaml
Normal file
477
openapi/paths/quotes.yaml
Normal file
@ -0,0 +1,477 @@
|
||||
/api/v1/quotes:
|
||||
get:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "List quotes"
|
||||
description: "Lists quotes, 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 quotes, these are handled by the QuoteFilters class which defines the methods available"
|
||||
operationId: getQuotes
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- $ref: "#/components/parameters/status"
|
||||
- $ref: "#/components/parameters/client_id"
|
||||
- $ref: "#/components/parameters/created_at"
|
||||
- $ref: "#/components/parameters/updated_at"
|
||||
- $ref: "#/components/parameters/is_deleted"
|
||||
- $ref: "#/components/parameters/filter_deleted_clients"
|
||||
- $ref: "#/components/parameters/vendor_id"
|
||||
- name: filter
|
||||
in: query
|
||||
description: |
|
||||
Searches across a range of columns including:
|
||||
- number
|
||||
- custom_value1
|
||||
- custom_value2
|
||||
- custom_value3
|
||||
- custom_value4
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: ?filter=bob
|
||||
- name: client_status
|
||||
in: query
|
||||
description: |
|
||||
A comma separated list of quote status strings. Valid options include:
|
||||
- all
|
||||
- draft
|
||||
- sent
|
||||
- approved
|
||||
- expired
|
||||
- upcoming
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: ?client_status=paid,unpaid
|
||||
- name: number
|
||||
in: query
|
||||
description: |
|
||||
Search quote by quote number
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: ?number=Q-001
|
||||
- name: sort
|
||||
in: query
|
||||
description: Returns the list sorted by column in ascending or descending order.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
example: id|desc number|desc balance|asc
|
||||
responses:
|
||||
200:
|
||||
description: "A list of quotes"
|
||||
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/Quote"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
post:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Create quote"
|
||||
description: "Adds an Quote to the system"
|
||||
operationId: storeQuote
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the saved Quote 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/Quote"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/quotes/{id}":
|
||||
get:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Show quote"
|
||||
description: "Displays an Quote by id"
|
||||
operationId: showQuote
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Quote Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Quote 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/Quote"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
put:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Update quote"
|
||||
description: "Handles the updating of an Quote by id"
|
||||
operationId: updateQuote
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Quote Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Quote 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/Quote"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
delete:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Delete quote"
|
||||
description: "Handles the deletion of an Quote by id"
|
||||
operationId: deleteQuote
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Quote 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/quotes/{id}/edit":
|
||||
get:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Edit quote"
|
||||
description: "Displays an Quote by id"
|
||||
operationId: editQuote
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Quote Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Quote 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/Quote"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/quotes/create:
|
||||
get:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Blank quote"
|
||||
description: "Returns a blank object with default values"
|
||||
operationId: getQuotesCreate
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "A blank Quote 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/Quote"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/quotes/bulk:
|
||||
post:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Bulk quote actions"
|
||||
description: ""
|
||||
operationId: bulkQuotes
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/index"
|
||||
requestBody:
|
||||
description: "Hashed ids"
|
||||
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 Quote 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/Quote"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/quotes/{id}/{action}":
|
||||
get:
|
||||
deprecated: true
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Performs a custom action on an Quote"
|
||||
description: "Performs a custom action on an Quote.\n\n The current range of actions are as follows\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - convert\n - convert_to_invoice\n - email"
|
||||
operationId: actionQuote
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Quote Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
- name: action
|
||||
in: path
|
||||
description: "The action string to be performed"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: clone_to_quote
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Quote 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/Quote"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/quote/{invitation_key}/download":
|
||||
get:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Download quote PDF"
|
||||
description: "Downloads a specific quote"
|
||||
operationId: downloadQuote
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: invitation_key
|
||||
in: path
|
||||
description: "The Quote Invitation Key"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the quote pdf"
|
||||
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/quotes/{id}/upload":
|
||||
put:
|
||||
tags:
|
||||
- quotes
|
||||
summary: "Upload a quote document"
|
||||
description: "Handles the uploading of a document to a quote"
|
||||
operationId: uploadQuote
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Quote Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Quote 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/Quote"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
@ -2,7 +2,7 @@
|
||||
get:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "List Recurring Invoices"
|
||||
summary: "List recurring invoices"
|
||||
description: |
|
||||
Lists invoices with the option to chain multiple query parameters allowing fine grained filtering of the list.
|
||||
|
||||
@ -73,8 +73,8 @@
|
||||
post:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Adds a RecurringInvoice"
|
||||
description: "Adds an RecurringInvoice to the system"
|
||||
summary: "Create recurring invoice"
|
||||
description: "Adds a Recurring Invoice to the system"
|
||||
operationId: storeRecurringInvoice
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
@ -102,44 +102,12 @@
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/recurring_invoices/create:
|
||||
get:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Gets a new blank RecurringInvoice object"
|
||||
description: "Returns a blank object with default values"
|
||||
operationId: getRecurringInvoicesCreate
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "A blank RecurringInvoice 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/RecurringInvoice"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
|
||||
"/api/v1/recurring_invoices/{id}":
|
||||
get:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Shows an RecurringInvoice"
|
||||
summary: "Show recurring invoice"
|
||||
description: "Displays an RecurringInvoice by id"
|
||||
operationId: showRecurringInvoice
|
||||
parameters:
|
||||
@ -179,7 +147,7 @@
|
||||
put:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Updates an RecurringInvoice"
|
||||
summary: "Update recurring invoice"
|
||||
description: "Handles the updating of an RecurringInvoice by id"
|
||||
operationId: updateRecurringInvoice
|
||||
parameters:
|
||||
@ -219,7 +187,7 @@
|
||||
delete:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Deletes a RecurringInvoice"
|
||||
summary: "Delete recurring invoice"
|
||||
description: "Handles the deletion of an RecurringInvoice by id"
|
||||
operationId: deleteRecurringInvoice
|
||||
parameters:
|
||||
@ -256,7 +224,7 @@
|
||||
get:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Shows an RecurringInvoice for editting"
|
||||
summary: "Edit recurring invoice"
|
||||
description: "Displays an RecurringInvoice by id"
|
||||
operationId: editRecurringInvoice
|
||||
parameters:
|
||||
@ -293,28 +261,21 @@
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/recurring_invoice/{invitation_key}/download":
|
||||
|
||||
/api/v1/recurring_invoices/create:
|
||||
get:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Download a specific invoice by invitation key"
|
||||
description: "Downloads a specific invoice"
|
||||
operationId: downloadRecurringInvoice
|
||||
summary: "Blank recurring invoice"
|
||||
description: "Returns a blank object with default values"
|
||||
operationId: getRecurringInvoicesCreate
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: invitation_key
|
||||
in: path
|
||||
description: "The Recurring Invoice Invitation Key"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the recurring invoice pdf"
|
||||
description: "A blank RecurringInvoice object"
|
||||
headers:
|
||||
X-MINIMUM-CLIENT-VERSION:
|
||||
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
|
||||
@ -322,6 +283,10 @@
|
||||
$ref: "#/components/headers/X-RateLimit-Remaining"
|
||||
X-RateLimit-Limit:
|
||||
$ref: "#/components/headers/X-RateLimit-Limit"
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/RecurringInvoice"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
@ -334,7 +299,7 @@
|
||||
post:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Performs bulk actions on an array of recurring_invoices"
|
||||
summary: "Bulk recurring invoice actions"
|
||||
description: ""
|
||||
operationId: bulkRecurringInvoices
|
||||
parameters:
|
||||
@ -376,9 +341,10 @@
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/recurring_invoices/{id}/{action}":
|
||||
get:
|
||||
deprecated: true
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Performs a custom action on an RecurringInvoice"
|
||||
summary: "Custom recurring invoice action"
|
||||
description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email"
|
||||
operationId: actionRecurringInvoice
|
||||
parameters:
|
||||
@ -423,11 +389,48 @@
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/recurring_invoice/{invitation_key}/download":
|
||||
get:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Download recurring invoice PDF"
|
||||
description: "Downloads a specific invoice"
|
||||
operationId: downloadRecurringInvoice
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: invitation_key
|
||||
in: path
|
||||
description: "The Recurring Invoice Invitation Key"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the recurring invoice pdf"
|
||||
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/recurring_invoices/{id}/upload":
|
||||
put:
|
||||
tags:
|
||||
- recurring_invoices
|
||||
summary: "Uploads a document to a recurring_invoice"
|
||||
summary: "Add recurring invoice document"
|
||||
description: "Handles the uploading of a document to a recurring_invoice"
|
||||
operationId: uploadRecurringInvoice
|
||||
parameters:
|
||||
|
371
openapi/paths/tasks.yaml
Normal file
371
openapi/paths/tasks.yaml
Normal file
@ -0,0 +1,371 @@
|
||||
/api/v1/tasks:
|
||||
get:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "List tasks"
|
||||
description: "Lists tasks, 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 tasks, these are handled by the TaskFilters class which defines the methods available"
|
||||
operationId: getTasks
|
||||
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 tasks"
|
||||
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/Task"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
post:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "Create task"
|
||||
description: "Adds an task to a company"
|
||||
operationId: storeTask
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the saved task 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/Task"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/tasks/{id}":
|
||||
get:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "Show task"
|
||||
description: "Displays a task by id"
|
||||
operationId: showTask
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Task Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the task 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/Task"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
put:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "Update task"
|
||||
description: "Handles the updating of a task by id"
|
||||
operationId: updateTask
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The task Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the task 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/Task"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
delete:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "Delete task"
|
||||
description: "Handles the deletion of a task by id"
|
||||
operationId: deleteTask
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Task 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/tasks/{id}/edit":
|
||||
get:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "Edit task"
|
||||
description: "Displays a task by id"
|
||||
operationId: editTask
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Task Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the client 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/Task"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/tasks/create:
|
||||
get:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "Blank task"
|
||||
description: "Returns a blank task with default values"
|
||||
operationId: getTasksCreate
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "A blank task 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/Task"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/tasks/bulk:
|
||||
post:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "Bulk task actions"
|
||||
description: ""
|
||||
operationId: bulkTasks
|
||||
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 Task 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/Task"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
"/api/v1/tasks/{id}/upload":
|
||||
put:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "Uploads a task document"
|
||||
description: "Handles the uploading of a document to a task"
|
||||
operationId: uploadTask
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
- name: id
|
||||
in: path
|
||||
description: "The Task Hashed ID"
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
format: string
|
||||
example: D2J234DFA
|
||||
responses:
|
||||
200:
|
||||
description: "Returns the Task 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/Task"
|
||||
401:
|
||||
$ref: "#/components/responses/401"
|
||||
403:
|
||||
$ref: "#/components/responses/403"
|
||||
422:
|
||||
$ref: "#/components/responses/422"
|
||||
default:
|
||||
$ref: "#/components/responses/default"
|
||||
/api/v1/tasks/sort:
|
||||
post:
|
||||
tags:
|
||||
- tasks
|
||||
summary: "Sort tasks on KanBan"
|
||||
description: "Sorts tasks after drag and drop on the KanBan."
|
||||
operationId: sortTasks
|
||||
parameters:
|
||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||
- $ref: "#/components/parameters/X-Requested-With"
|
||||
- $ref: "#/components/parameters/include"
|
||||
responses:
|
||||
200:
|
||||
description: "Returns an Ok, 200 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"
|
342
openapi/paths/vendors.yaml
Normal file
342
openapi/paths/vendors.yaml
Normal file
@ -0,0 +1,342 @@
|
||||
/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"
|
Loading…
Reference in New Issue
Block a user