mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
384 lines
12 KiB
YAML
384 lines
12 KiB
YAML
|
/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"
|