mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2025-05-31 21:34:35 -04:00
openapi
This commit is contained in:
David Bomba
parent
fb669e31f3
commit
3889c3cb53
@ -91,6 +91,16 @@ class OpenApiYaml extends Command
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/parameters.yaml'));
|
||||||
|
|
||||||
|
$directory = new DirectoryIterator($path . '/components/parameters/');
|
||||||
|
|
||||||
|
foreach ($directory as $file) {
|
||||||
|
if ($file->isFile() && ! $file->isDot()) {
|
||||||
|
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents("{$path}/components/parameters/{$file->getFilename()}"));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/schemas.yaml'));
|
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/schemas.yaml'));
|
||||||
|
|
||||||
//iterate schemas
|
//iterate schemas
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -1,195 +1,4 @@
|
|||||||
components:
|
components:
|
||||||
parameters:
|
|
||||||
X-API-SECRET:
|
|
||||||
name: X-API-SECRET
|
|
||||||
in: header
|
|
||||||
description: 'The API secret as defined by the .env variable API_SECRET. Only needed for self hosted users, and only applicable on the login route.'
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
example: password
|
|
||||||
X-Requested-With:
|
|
||||||
name: X-Requested-With
|
|
||||||
in: header
|
|
||||||
description: 'Used to send the XMLHttpRequest header'
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
readOnly: true
|
|
||||||
example: XMLHttpRequest
|
|
||||||
X-API-TOKEN:
|
|
||||||
name: X-API-TOKEN
|
|
||||||
in: header
|
|
||||||
description: 'The API token to be used for authentication'
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
example: TOKEN
|
|
||||||
X-API-PASSWORD:
|
|
||||||
name: X-API-PASSWORD
|
|
||||||
in: header
|
|
||||||
description: 'The login password when challenged on certain protected routes'
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
example: supersecretpassword
|
|
||||||
bank_integration_include:
|
|
||||||
name: include
|
|
||||||
in: query
|
|
||||||
description: Include child relations of the BankIntegration object. Format is comma separated.
|
|
||||||
require: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
examples:
|
|
||||||
company:
|
|
||||||
value: company
|
|
||||||
summary: The associated Company
|
|
||||||
account:
|
|
||||||
value: account
|
|
||||||
summary: The associated Account
|
|
||||||
bank_transactions:
|
|
||||||
value: bank_transactions
|
|
||||||
summary: The associated Bank Transactions
|
|
||||||
client_include:
|
|
||||||
name: include
|
|
||||||
in: query
|
|
||||||
description: Include child relationships of the Client Object.
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
examples:
|
|
||||||
activities:
|
|
||||||
value: activities
|
|
||||||
summary: include=activities will include the activities object in the response
|
|
||||||
ledger:
|
|
||||||
value: ledger
|
|
||||||
summary: include=ledger will include the ledger object in the response
|
|
||||||
system_logs:
|
|
||||||
value: system_logs
|
|
||||||
summary: include=system_logs will include the system_logs object in the response
|
|
||||||
activity_include:
|
|
||||||
name: include
|
|
||||||
in: query
|
|
||||||
description: Include child relations of the Activity object, format is comma separated. **Note** it is possible to chain multiple includes together, ie. include=account,token
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
examples:
|
|
||||||
history:
|
|
||||||
value: history
|
|
||||||
summary: include=history will include the history object in the response (This could include references to the backup HTML of the entity)
|
|
||||||
user:
|
|
||||||
value: user
|
|
||||||
summary: include=user will include the user object in the response
|
|
||||||
client:
|
|
||||||
value: client
|
|
||||||
summary: include=client will include the client object in the response
|
|
||||||
recurring_invoice:
|
|
||||||
value: recurring_invoice
|
|
||||||
summary: include=recurring_invoice will include the recurring_invoice object in the response
|
|
||||||
invoice:
|
|
||||||
value: invoice
|
|
||||||
summary: include=invoice will include the invoice object in the response
|
|
||||||
credit:
|
|
||||||
value: credit
|
|
||||||
summary: include=credit will include the credit object in the response
|
|
||||||
quote:
|
|
||||||
value: quote
|
|
||||||
summary: include=quote will include the quote object in the response
|
|
||||||
payment:
|
|
||||||
value: payment
|
|
||||||
summary: include=payment will include the payment object in the response
|
|
||||||
expense:
|
|
||||||
value: expense
|
|
||||||
summary: include=expense will include the expense object in the response
|
|
||||||
vendor_contact:
|
|
||||||
value: vendor_contact
|
|
||||||
summary: include=vendor_contact will include the vendor_contact object in the response
|
|
||||||
vendor:
|
|
||||||
value: vendor
|
|
||||||
summary: include=vendor will include the vendor object in the response
|
|
||||||
purchase_order:
|
|
||||||
value: purchase_order
|
|
||||||
summary: include=purchase_order will include the purchase_order object in the response
|
|
||||||
task:
|
|
||||||
value: task
|
|
||||||
summary: include=task will include the task object in the response
|
|
||||||
login_include:
|
|
||||||
name: include
|
|
||||||
in: query
|
|
||||||
description: Include child relations of the CompanyUser object, format is comma separated. **Note** it is possible to chain multiple includes together, ie. include=account,token
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
examples:
|
|
||||||
user:
|
|
||||||
value: user
|
|
||||||
summary: include=user will include the user object in the response
|
|
||||||
company:
|
|
||||||
value: company
|
|
||||||
summary: include=company will include the company object in the response
|
|
||||||
token:
|
|
||||||
value: token
|
|
||||||
summary: include=token will include the token object in the response
|
|
||||||
account:
|
|
||||||
value: account
|
|
||||||
summary: include=account will include the account object in the response
|
|
||||||
per_page_meta:
|
|
||||||
name: per_page
|
|
||||||
in: query
|
|
||||||
description: The number of records to return for each request, default is 20
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: int
|
|
||||||
example: 20
|
|
||||||
page_meta:
|
|
||||||
name: page
|
|
||||||
in: query
|
|
||||||
description: The page number to return for this request (when performing pagination), default is 1
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: int
|
|
||||||
example: 1
|
|
||||||
include:
|
|
||||||
name: include
|
|
||||||
in: query
|
|
||||||
description: 'Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes'
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
example: 'first_load'
|
|
||||||
include_static:
|
|
||||||
name: include_static
|
|
||||||
in: query
|
|
||||||
description: 'Returns static variables'
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
example: include_static=true
|
|
||||||
clear_cache:
|
|
||||||
name: clear_cache
|
|
||||||
in: query
|
|
||||||
description: 'Clears the static cache'
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
example: clear_cache=true
|
|
||||||
index:
|
|
||||||
name: index
|
|
||||||
in: query
|
|
||||||
description: 'Replaces the default response index from data to a user specific string'
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
example: user
|
|
||||||
api_version:
|
|
||||||
name: api_version
|
|
||||||
in: query
|
|
||||||
description: 'The API version'
|
|
||||||
required: false
|
|
||||||
schema:
|
|
||||||
type: number
|
|
||||||
example: user
|
|
||||||
headers:
|
headers:
|
||||||
X-MINIMUM-CLIENT-VERSION:
|
X-MINIMUM-CLIENT-VERSION:
|
||||||
description: 'The API version'
|
description: 'The API version'
|
||||||
@ -208,4 +17,4 @@ components:
|
|||||||
ApiKeyAuth:
|
ApiKeyAuth:
|
||||||
type: apiKey
|
type: apiKey
|
||||||
in: header
|
in: header
|
||||||
name: X-API-TOKEN
|
name: X-API-TOKEN
|
||||||
@ -4208,472 +4208,7 @@ paths:
|
|||||||
$ref: "#/components/responses/422"
|
$ref: "#/components/responses/422"
|
||||||
default:
|
default:
|
||||||
$ref: "#/components/responses/default"
|
$ref: "#/components/responses/default"
|
||||||
/api/v1/invoices:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Gets a list of invoices"
|
|
||||||
description: "Lists invoices, search and filters allow fine grained lists to be generated.\n *\n *\t\tQuery parameters can be added to performed more fine grained filtering of the invoices, these are handled by the InvoiceFilters class which defines the methods available"
|
|
||||||
operationId: getInvoices
|
|
||||||
parameters:
|
|
||||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
|
||||||
- $ref: "#/components/parameters/X-Requested-With"
|
|
||||||
- $ref: "#/components/parameters/include"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "A list of invoices"
|
|
||||||
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"
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Adds a invoice"
|
|
||||||
description: "Adds an invoice to the system"
|
|
||||||
operationId: storeInvoice
|
|
||||||
parameters:
|
|
||||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
|
||||||
- $ref: "#/components/parameters/X-Requested-With"
|
|
||||||
- $ref: "#/components/parameters/include"
|
|
||||||
requestBody:
|
|
||||||
required: true
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/FillableInvoice"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "Returns the saved 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/invoices/create:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Gets a new blank invoice object"
|
|
||||||
description: "Returns a blank object with default values"
|
|
||||||
operationId: getInvoicesCreate
|
|
||||||
parameters:
|
|
||||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
|
||||||
- $ref: "#/components/parameters/X-Requested-With"
|
|
||||||
- $ref: "#/components/parameters/include"
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "A blank 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/invoices/{id}":
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Shows an invoice"
|
|
||||||
description: "Displays an invoice by id"
|
|
||||||
operationId: showInvoice
|
|
||||||
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 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"
|
|
||||||
put:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Updates an invoice"
|
|
||||||
description: "Handles the updating of an invoice by id"
|
|
||||||
operationId: updateInvoice
|
|
||||||
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 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"
|
|
||||||
delete:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Deletes a invoice"
|
|
||||||
description: "Handles the deletion of an invoice by id"
|
|
||||||
operationId: deleteInvoice
|
|
||||||
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 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/invoices/{id}/edit":
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Shows an invoice for editting"
|
|
||||||
description: "Displays an invoice by id"
|
|
||||||
operationId: editInvoice
|
|
||||||
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 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/invoices/bulk:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Performs bulk actions on an array of invoices"
|
|
||||||
description: ""
|
|
||||||
operationId: bulkInvoices
|
|
||||||
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/invoices/{id}/{action}":
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Performs a custom action on an invoice"
|
|
||||||
description: "Performs a custom action on an invoice.\n *\n * The current range of actions are as follows\n * - clone_to_invoice\n * - clone_to_quote\n * - history\n * - delivery_note\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email"
|
|
||||||
operationId: actionInvoice
|
|
||||||
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
|
|
||||||
- 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/invoice/{invitation_key}/download":
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Download a specific invoice by invitation key"
|
|
||||||
description: "Downloads a specific invoice"
|
|
||||||
operationId: downloadInvoice
|
|
||||||
parameters:
|
|
||||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
|
||||||
- $ref: "#/components/parameters/X-Requested-With"
|
|
||||||
- $ref: "#/components/parameters/include"
|
|
||||||
- name: invitation_key
|
|
||||||
in: path
|
|
||||||
description: "The Invoice Invitation Key"
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
format: string
|
|
||||||
example: D2J234DFA
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "Returns the 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/invoices/{id}/delivery_note":
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Download a specific invoice delivery notes"
|
|
||||||
description: "Downloads a specific invoice delivery notes"
|
|
||||||
operationId: deliveryNote
|
|
||||||
parameters:
|
|
||||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
|
||||||
- $ref: "#/components/parameters/X-Requested-With"
|
|
||||||
- $ref: "#/components/parameters/include"
|
|
||||||
- name: id
|
|
||||||
in: path
|
|
||||||
description: "The Invoice Hahsed Id"
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
format: string
|
|
||||||
example: D2J234DFA
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: "Returns the invoice delivery note 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/invoices/{id}/upload":
|
|
||||||
put:
|
|
||||||
tags:
|
|
||||||
- invoices
|
|
||||||
summary: "Uploads a document to a invoice"
|
|
||||||
description: "Handles the uploading of a document to a invoice"
|
|
||||||
operationId: uploadInvoice
|
|
||||||
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 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/claim_license:
|
/api/v1/claim_license:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
@ -7548,7 +7083,7 @@ paths:
|
|||||||
"/api/v1/recurring_invoice/{invitation_key}/download":
|
"/api/v1/recurring_invoice/{invitation_key}/download":
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- invoices
|
- recurring_invoices
|
||||||
summary: "Download a specific invoice by invitation key"
|
summary: "Download a specific invoice by invitation key"
|
||||||
description: "Downloads a specific invoice"
|
description: "Downloads a specific invoice"
|
||||||
operationId: downloadRecurringInvoice
|
operationId: downloadRecurringInvoice
|
||||||
@ -9452,7 +8987,7 @@ paths:
|
|||||||
$ref: "#/components/responses/422"
|
$ref: "#/components/responses/422"
|
||||||
default:
|
default:
|
||||||
$ref: "#/components/responses/default"
|
$ref: "#/components/responses/default"
|
||||||
/api/v1/invoices/task_schedulers:
|
/api/v1/task_schedulers/create:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- task_schedulers
|
- task_schedulers
|
||||||
|
|||||||
@ -11,6 +11,12 @@
|
|||||||
- $ref: '#/components/parameters/X-Requested-With'
|
- $ref: '#/components/parameters/X-Requested-With'
|
||||||
- $ref: '#/components/parameters/client_include'
|
- $ref: '#/components/parameters/client_include'
|
||||||
- $ref: '#/components/parameters/index'
|
- $ref: '#/components/parameters/index'
|
||||||
|
- $ref: "#/components/parameters/status"
|
||||||
|
- $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: name
|
- name: name
|
||||||
in: query
|
in: query
|
||||||
description: Filter by client name
|
description: Filter by client name
|
||||||
|
|||||||
@ -12,6 +12,13 @@
|
|||||||
- $ref: "#/components/parameters/X-API-TOKEN"
|
- $ref: "#/components/parameters/X-API-TOKEN"
|
||||||
- $ref: "#/components/parameters/X-Requested-With"
|
- $ref: "#/components/parameters/X-Requested-With"
|
||||||
- $ref: "#/components/parameters/include"
|
- $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
|
- name: filter
|
||||||
in: query
|
in: query
|
||||||
description: Filter by product name
|
description: Filter by product name
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user