Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-05-31 12:04:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Updates for openapi spec

Browse Source
This commit is contained in:
David Bomba 2023-07-08 20:16:09 +10:00
parent 8d2f6543df
commit 8425569d60
17 changed files with 927 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
app/Console/Commands/OpenApiYaml.php
View File

@ -79,6 +79,7 @@ class OpenApiYaml extends Command
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components.yaml'));
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/responses.yaml'));
Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/examples.yaml'));
$directory = new DirectoryIterator($path . '/components/responses/');

474
openapi/api-docs.yaml
View File

@ -39,7 +39,7 @@ paths:
- $ref: "#/components/parameters/page_meta"
responses:
200:
description: "Returns the client object"
description: "Returns the list of activities"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -50,7 +50,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Client"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Activity'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -267,7 +275,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/BankIntegration"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BankIntegration'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -671,7 +687,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/BankTransaction"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BankTransaction'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -1016,7 +1040,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/BankTransactionRule"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BankTransactionRule'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -1348,7 +1380,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/ClientGatewayToken"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ClientGatewayToken'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -1605,7 +1645,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Company"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Company'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -1948,7 +1996,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/CompanyGateway"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CompanyGateway'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -2255,7 +2311,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/CompanyLedger"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CompanyLedger'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -2359,7 +2423,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Design"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Design'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -2667,7 +2739,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Document'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -2752,7 +2832,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/ExpenseCategory"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ExpenseCategory'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -3048,7 +3136,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Expense"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Expense'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -3416,7 +3512,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/GroupSetting"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/GroupSetting'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -3899,8 +4003,8 @@ paths:
post:
tags:
- logout
summary: "Gets a list of logout"
description: "Lists all logout"
summary: "Logs the user out of their current session"
description: "Logs the user out of their current session"
operationId: getLogout
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
@ -4087,7 +4191,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/PaymentTerm"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PaymentTerm'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -4521,7 +4633,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/RecurringExpense"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RecurringExpense'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -4863,7 +4983,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/RecurringQuote"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RecurringQuote'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -5759,7 +5887,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Subscription"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Subscription'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -6100,7 +6236,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/SystemLog"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SystemLog'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -6405,7 +6549,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/TaskStatus"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TaskStatus'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -6710,7 +6862,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/TaxRate"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TaxRate'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -7019,7 +7179,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/CompanyToken"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CompanyToken'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -7319,7 +7487,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/User"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/User'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -7767,7 +7943,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Webhook"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Webhook'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -8099,7 +8283,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Product'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: '#/components/responses/401'
403:
@ -8504,7 +8696,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Task'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -8915,7 +9115,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Project"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Project'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -9388,7 +9596,19 @@ paths:
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Client'
example:
$ref: '#/components/examples/Client'
meta:
type: object
$ref: '#/components/schemas/Meta'
example:
$ref: '#/components/examples/Meta'
401:
$ref: '#/components/responses/401'
403:
@ -9937,7 +10157,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Credit'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -10396,7 +10624,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Payment"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Payment'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -10965,7 +11201,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Invoice"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Invoice'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -11594,7 +11838,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/RecurringInvoice"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RecurringInvoice'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -12141,7 +12393,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Quote"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Quote'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -12613,7 +12873,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrder'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -12649,7 +12917,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -12695,7 +12963,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -12740,7 +13008,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -12825,7 +13093,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Invoice"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -12863,7 +13131,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -12950,7 +13218,7 @@ paths:
example: clone_to_quote
responses:
200:
description: "Returns the invoice object"
description: "Returns the purchase order object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -12961,7 +13229,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Invoice"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -13006,7 +13274,7 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Vendor"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -13085,7 +13353,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Vendor"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Vendor'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -13459,6 +13735,78 @@ components:
in: header
name: X-API-TOKEN
responses:
examples:
Client:
- id: Opnel5aKBz
user_id: Ua6Rw4pVbS
assigned_user_id: Ua6Rw4pVbS
company_id: Co7Vn3yLmW
name: "Jim's Housekeeping"
website: https://www.jims-housekeeping.com
private_notes: Client prefers email communication over phone calls
client_hash: asdfkjhk342hjhbfdvmnfb1
industry_id: 5
size_id: 2
address1: 123 Main St
address2: Apt 4B
city: Beverly Hills
state: California
postal_code: 90210
phone: 555-3434-3434
country_id: 1
custom_value1: Email
custom_value2: John Doe
custom_value3: Yes
custom_value4: $50,000
vat_number: VAT123456
id_number: ID123456
number: CL-0001
shipping_address1: 5 Wallaby Way
shipping_address2: Suite 5
shipping_city: Perth
shipping_state: Western Australia
shipping_postal_code: 6110
shipping_country_id: 4
is_deleted: false
balance: 500.00
paid_to_date: 2000.00
credit_balance: 100.00
last_login: 1628686031
created_at: 1617629031
updated_at: 1628445631
group_settings_id: Opnel5aKBz
routing_id: Opnel5aKBz3489-dfkiu-2239-sdsd
is_tax_exempt: false
has_valid_vat_number: false
payment_balance: 100
contacts:
- id: Opnel5aKBz
first_name: John
last_name: Doe
email: jim@gmail.com
phone: 555-3434-3434
send_invoice: true
custom_value1: Email
custom_value2: John Doe
custom_value3: Yes
custom_value4: $50,000
is_primary: true
created_at: 1617629031
updated_at: 1628445631
deleted_at: 1628445631
Meta:
value:
pagination:
total: 1
count: 1
per_page: 20
current_page: 1
total_pages: 1
links:
- first: https://invoicing.co/api/v1/invoices?page=1
- last: https://invoicing.co/api/v1/invoices?page=1
- prev: null
- next: null
429:
description: 'Rate Limit Exceeded'
content:
@ -16613,6 +16961,42 @@ components:
type: integer
example: '1'
type: object
Meta:
properties:
pagination:
$ref: '#/components/schemas/Pagination'
Pagination:
type: object
properties:
total:
type: integer
description: 'The total number of items'
example: 1
readOnly: true
count:
type: integer
description: 'The number of items per page'
example: 1
readOnly: true
per_page:
type: integer
description: 'The number of items per page'
example: 1
readOnly: true
current_page:
type: integer
description: 'The current page number'
example: 1
readOnly: true
total_pages:
type: integer
description: 'The total number of pages'
example: 1
readOnly: true
links:
type: array
description: 'The pagination links'
readOnly: true
FeesAndLimits:
properties:
@ -18597,8 +18981,6 @@ components:
type: string
format: date
example: '1994-07-30'
settings:
$ref: '#/components/schemas/CompanySettings'
last_viewed:
description: Timestamp
type: number

72
openapi/components/examples.yaml Normal file
View File

@ -0,0 +1,72 @@
examples:
Client:
- id: Opnel5aKBz
user_id: Ua6Rw4pVbS
assigned_user_id: Ua6Rw4pVbS
company_id: Co7Vn3yLmW
name: "Jim's Housekeeping"
website: https://www.jims-housekeeping.com
private_notes: Client prefers email communication over phone calls
client_hash: asdfkjhk342hjhbfdvmnfb1
industry_id: 5
size_id: 2
address1: 123 Main St
address2: Apt 4B
city: Beverly Hills
state: California
postal_code: 90210
phone: 555-3434-3434
country_id: 1
custom_value1: Email
custom_value2: John Doe
custom_value3: Yes
custom_value4: $50,000
vat_number: VAT123456
id_number: ID123456
number: CL-0001
shipping_address1: 5 Wallaby Way
shipping_address2: Suite 5
shipping_city: Perth
shipping_state: Western Australia
shipping_postal_code: 6110
shipping_country_id: 4
is_deleted: false
balance: 500.00
paid_to_date: 2000.00
credit_balance: 100.00
last_login: 1628686031
created_at: 1617629031
updated_at: 1628445631
group_settings_id: Opnel5aKBz
routing_id: Opnel5aKBz3489-dfkiu-2239-sdsd
is_tax_exempt: false
has_valid_vat_number: false
payment_balance: 100
contacts:
- id: Opnel5aKBz
first_name: John
last_name: Doe
email: jim@gmail.com
phone: 555-3434-3434
send_invoice: true
custom_value1: Email
custom_value2: John Doe
custom_value3: Yes
custom_value4: $50,000
is_primary: true
created_at: 1617629031
updated_at: 1628445631
deleted_at: 1628445631
Meta:
value:
pagination:
total: 1
count: 1
per_page: 20
current_page: 1
total_pages: 1
links:
- first: https://invoicing.co/api/v1/invoices?page=1
- last: https://invoicing.co/api/v1/invoices?page=1
- prev: null
- next: null

2
openapi/components/schemas/invoice.yaml
View File

@ -168,8 +168,6 @@
type: string
format: date
example: '1994-07-30'
settings:
$ref: '#/components/schemas/CompanySettings'
last_viewed:
description: Timestamp
type: number

36
openapi/components/schemas/meta.yaml Normal file
View File

@ -0,0 +1,36 @@
Meta:
properties:
pagination:
$ref: '#/components/schemas/Pagination'
Pagination:
type: object
properties:
total:
type: integer
description: 'The total number of items'
example: 1
readOnly: true
count:
type: integer
description: 'The number of items per page'
example: 1
readOnly: true
per_page:
type: integer
description: 'The number of items per page'
example: 1
readOnly: true
current_page:
type: integer
description: 'The current page number'
example: 1
readOnly: true
total_pages:
type: integer
description: 'The total number of pages'
example: 1
readOnly: true
links:
type: array
description: 'The pagination links'
readOnly: true

236
openapi/paths.yaml
View File

@ -15,7 +15,7 @@ paths:
- $ref: "#/components/parameters/page_meta"
responses:
200:
description: "Returns the client object"
description: "Returns the list of activities"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -26,7 +26,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Client"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Activity'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -243,7 +251,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/BankIntegration"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BankIntegration'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -647,7 +663,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/BankTransaction"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BankTransaction'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -992,7 +1016,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/BankTransactionRule"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/BankTransactionRule'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -1324,7 +1356,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/ClientGatewayToken"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ClientGatewayToken'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -1581,7 +1621,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Company"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Company'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -1924,7 +1972,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/CompanyGateway"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CompanyGateway'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -2231,7 +2287,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/CompanyLedger"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CompanyLedger'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -2335,7 +2399,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Design"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Design'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -2643,7 +2715,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Document"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Document'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -2728,7 +2808,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/ExpenseCategory"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ExpenseCategory'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -3024,7 +3112,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Expense"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Expense'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -3392,7 +3488,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/GroupSetting"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/GroupSetting'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -3875,8 +3979,8 @@ paths:
post:
tags:
- logout
summary: "Gets a list of logout"
description: "Lists all logout"
summary: "Logs the user out of their current session"
description: "Logs the user out of their current session"
operationId: getLogout
parameters:
- $ref: "#/components/parameters/X-API-TOKEN"
@ -4063,7 +4167,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/PaymentTerm"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PaymentTerm'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -4497,7 +4609,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/RecurringExpense"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RecurringExpense'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -4839,7 +4959,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/RecurringQuote"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RecurringQuote'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -5735,7 +5863,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Subscription"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Subscription'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -6076,7 +6212,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/SystemLog"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/SystemLog'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -6381,7 +6525,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/TaskStatus"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TaskStatus'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -6686,7 +6838,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/TaxRate"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TaxRate'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -6995,7 +7155,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/CompanyToken"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CompanyToken'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -7295,7 +7463,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/User"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/User'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -7743,7 +7919,15 @@ paths:
content:
application/json:
schema:
$ref: "#/components/schemas/Webhook"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Webhook'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:

12
openapi/paths/clients.yaml
View File

@ -118,7 +118,19 @@
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Client'
example:
$ref: '#/components/examples/Client'
meta:
type: object
$ref: '#/components/schemas/Meta'
example:
$ref: '#/components/examples/Meta'
401:
$ref: '#/components/responses/401'
403:

10
openapi/paths/credits.yaml
View File

@ -22,7 +22,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Credit'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:

10
openapi/paths/invoices.yaml
View File

@ -107,7 +107,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Invoice"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Invoice'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:

10
openapi/paths/payments.yaml
View File

@ -58,7 +58,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Payment"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Payment'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:

10
openapi/paths/products.yaml
View File

@ -53,7 +53,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Product"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Product'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: '#/components/responses/401'
403:

10
openapi/paths/projects.yaml
View File

@ -23,7 +23,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Project"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Project'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:

26
openapi/paths/purchase_orders.yaml
View File

@ -22,7 +22,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PurchaseOrder'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:
@ -58,7 +66,7 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -104,7 +112,7 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -149,7 +157,7 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -234,7 +242,7 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Invoice"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -272,7 +280,7 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Credit"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -359,7 +367,7 @@
example: clone_to_quote
responses:
200:
description: "Returns the invoice object"
description: "Returns the purchase order object"
headers:
X-MINIMUM-CLIENT-VERSION:
$ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION"
@ -370,7 +378,7 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Invoice"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:
@ -415,7 +423,7 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Vendor"
$ref: "#/components/schemas/PurchaseOrder"
401:
$ref: "#/components/responses/401"
403:

10
openapi/paths/quotes.yaml
View File

@ -71,7 +71,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Quote"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Quote'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:

10
openapi/paths/recurring_invoices.yaml
View File

@ -61,7 +61,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/RecurringInvoice"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/RecurringInvoice'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:

10
openapi/paths/tasks.yaml
View File

@ -23,7 +23,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Task"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Task'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403:

10
openapi/paths/vendors.yaml
View File

@ -23,7 +23,15 @@
content:
application/json:
schema:
$ref: "#/components/schemas/Vendor"
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Vendor'
meta:
type: object
$ref: '#/components/schemas/Meta'
401:
$ref: "#/components/responses/401"
403: