Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-10-25 23:02:52 -04:00
Code Issues Packages Projects Releases Wiki Activity

Improve API docs

Browse Source
This commit is contained in:
David Bomba 2024-03-09 18:09:43 +11:00
parent 2777a053df
commit 6aa5c5cad9
2 changed files with 394 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

205
openapi/api-docs.yaml
View File

@ -150,7 +150,9 @@ paths:
description: "The one time password if 2FA is enabled" description: "The one time password if 2FA is enabled"
type: string type: string
example: "123456" example: "123456"
required: false required:
- email
- password
type: object type: object
responses: responses:
200: 200:
@ -186,7 +188,8 @@ paths:
description: | description: |
Refreshes the dataset. Refreshes the dataset.
This endpoint can be used if you only need to access the most recent data from a certain point in time. This endpoint can be used if you only need to access the most recent data from a certain point in time. For example, if you only want to retrieve The
most recent data from the last time you accessed the system, you would pass the query parameter ?updated_at=1676173763. (unix timestamp)
operationId: refresh operationId: refresh
parameters: parameters:
- name: updated_at - name: updated_at
@ -222,6 +225,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/yodlee/refresh: /api/v1/yodlee/refresh:
@ -254,6 +261,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations: /api/v1/bank_integrations:
@ -304,6 +315,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -336,6 +351,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_integrations/{id}": "/api/v1/bank_integrations/{id}":
@ -377,6 +396,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -417,6 +440,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -453,6 +480,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_integrations/{id}/edit": "/api/v1/bank_integrations/{id}/edit":
@ -494,6 +525,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/create: /api/v1/bank_integrations/create:
@ -527,6 +562,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/bulk: /api/v1/bank_integrations/bulk:
@ -567,6 +606,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/refresh_accounts: /api/v1/bank_integrations/refresh_accounts:
@ -600,6 +643,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/remove_account/account_id: /api/v1/bank_integrations/remove_account/account_id:
@ -633,6 +680,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/get_transactions/account_id: /api/v1/bank_integrations/get_transactions/account_id:
@ -666,6 +717,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transactions: /api/v1/bank_transactions:
@ -716,6 +771,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -748,6 +807,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_transactions/{id}": "/api/v1/bank_transactions/{id}":
@ -789,6 +852,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -829,6 +896,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -906,6 +977,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transactions/create: /api/v1/bank_transactions/create:
@ -939,6 +1014,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transations/bulk: /api/v1/bank_transations/bulk:
@ -979,6 +1058,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transations/match: /api/v1/bank_transations/match:
@ -1019,6 +1102,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transaction_rules: /api/v1/bank_transaction_rules:
@ -1069,6 +1156,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -1101,6 +1192,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_transaction_rules/{id}": "/api/v1/bank_transaction_rules/{id}":
@ -1142,6 +1237,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -1182,6 +1281,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -1218,6 +1321,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_transaction_rules/{id}/edit": "/api/v1/bank_transaction_rules/{id}/edit":
@ -1259,6 +1366,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transaction_rules/create: /api/v1/bank_transaction_rules/create:
@ -1292,6 +1403,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transation_rules/bulk: /api/v1/bank_transation_rules/bulk:
@ -1332,6 +1447,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/charts/totals: /api/v1/charts/totals:
@ -1366,6 +1485,10 @@ paths:
$ref: "#/components/headers/X-RateLimit-Limit" $ref: "#/components/headers/X-RateLimit-Limit"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
@ -1409,6 +1532,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -1441,6 +1568,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/client_gateway_tokens/{id}": "/api/v1/client_gateway_tokens/{id}":
@ -1482,6 +1613,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -1522,6 +1657,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -1558,6 +1697,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/client_gateway_tokens/{id}/edit": "/api/v1/client_gateway_tokens/{id}/edit":
@ -1599,6 +1742,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/client_gateway_tokens/create: /api/v1/client_gateway_tokens/create:
@ -1632,6 +1779,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
@ -1674,6 +1825,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -1706,6 +1861,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/companies/create: /api/v1/companies/create:
@ -1739,6 +1898,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/companies/{id}": "/api/v1/companies/{id}":
@ -1780,6 +1943,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -1818,9 +1985,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -1855,9 +2025,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/companies/{id}/edit": "/api/v1/companies/{id}/edit":
@ -1897,9 +2070,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/companies/{id}/upload": "/api/v1/companies/{id}/upload":
@ -1956,9 +2132,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/companies/{company}/default": "/api/v1/companies/{company}/default":
@ -1998,9 +2177,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/company_gateways: /api/v1/company_gateways:
@ -2040,9 +2222,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -2075,6 +2260,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/company_gateways/create: /api/v1/company_gateways/create:

205
openapi/paths.yaml
View File

@ -126,7 +126,9 @@ paths:
description: "The one time password if 2FA is enabled" description: "The one time password if 2FA is enabled"
type: string type: string
example: "123456" example: "123456"
required: false required:
- email
- password
type: object type: object
responses: responses:
200: 200:
@ -162,7 +164,8 @@ paths:
description: | description: |
Refreshes the dataset. Refreshes the dataset.
This endpoint can be used if you only need to access the most recent data from a certain point in time. This endpoint can be used if you only need to access the most recent data from a certain point in time. For example, if you only want to retrieve The
most recent data from the last time you accessed the system, you would pass the query parameter ?updated_at=1676173763. (unix timestamp)
operationId: refresh operationId: refresh
parameters: parameters:
- name: updated_at - name: updated_at
@ -198,6 +201,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/yodlee/refresh: /api/v1/yodlee/refresh:
@ -230,6 +237,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations: /api/v1/bank_integrations:
@ -280,6 +291,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -312,6 +327,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_integrations/{id}": "/api/v1/bank_integrations/{id}":
@ -353,6 +372,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -393,6 +416,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -429,6 +456,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_integrations/{id}/edit": "/api/v1/bank_integrations/{id}/edit":
@ -470,6 +501,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/create: /api/v1/bank_integrations/create:
@ -503,6 +538,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/bulk: /api/v1/bank_integrations/bulk:
@ -543,6 +582,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/refresh_accounts: /api/v1/bank_integrations/refresh_accounts:
@ -576,6 +619,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/remove_account/account_id: /api/v1/bank_integrations/remove_account/account_id:
@ -609,6 +656,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_integrations/get_transactions/account_id: /api/v1/bank_integrations/get_transactions/account_id:
@ -642,6 +693,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transactions: /api/v1/bank_transactions:
@ -692,6 +747,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -724,6 +783,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_transactions/{id}": "/api/v1/bank_transactions/{id}":
@ -765,6 +828,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -805,6 +872,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -882,6 +953,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transactions/create: /api/v1/bank_transactions/create:
@ -915,6 +990,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transations/bulk: /api/v1/bank_transations/bulk:
@ -955,6 +1034,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transations/match: /api/v1/bank_transations/match:
@ -995,6 +1078,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transaction_rules: /api/v1/bank_transaction_rules:
@ -1045,6 +1132,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -1077,6 +1168,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_transaction_rules/{id}": "/api/v1/bank_transaction_rules/{id}":
@ -1118,6 +1213,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -1158,6 +1257,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -1194,6 +1297,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/bank_transaction_rules/{id}/edit": "/api/v1/bank_transaction_rules/{id}/edit":
@ -1235,6 +1342,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transaction_rules/create: /api/v1/bank_transaction_rules/create:
@ -1268,6 +1379,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/bank_transation_rules/bulk: /api/v1/bank_transation_rules/bulk:
@ -1308,6 +1423,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/charts/totals: /api/v1/charts/totals:
@ -1342,6 +1461,10 @@ paths:
$ref: "#/components/headers/X-RateLimit-Limit" $ref: "#/components/headers/X-RateLimit-Limit"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
@ -1385,6 +1508,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -1417,6 +1544,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/client_gateway_tokens/{id}": "/api/v1/client_gateway_tokens/{id}":
@ -1458,6 +1589,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -1498,6 +1633,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -1534,6 +1673,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/client_gateway_tokens/{id}/edit": "/api/v1/client_gateway_tokens/{id}/edit":
@ -1575,6 +1718,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/client_gateway_tokens/create: /api/v1/client_gateway_tokens/create:
@ -1608,6 +1755,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
@ -1650,6 +1801,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -1682,6 +1837,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/companies/create: /api/v1/companies/create:
@ -1715,6 +1874,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/companies/{id}": "/api/v1/companies/{id}":
@ -1756,6 +1919,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
put: put:
@ -1794,9 +1961,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
delete: delete:
@ -1831,9 +2001,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/companies/{id}/edit": "/api/v1/companies/{id}/edit":
@ -1873,9 +2046,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/companies/{id}/upload": "/api/v1/companies/{id}/upload":
@ -1932,9 +2108,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
"/api/v1/companies/{company}/default": "/api/v1/companies/{company}/default":
@ -1974,9 +2153,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/company_gateways: /api/v1/company_gateways:
@ -2016,9 +2198,12 @@ paths:
$ref: "#/components/responses/401" $ref: "#/components/responses/401"
403: 403:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
post: post:
@ -2051,6 +2236,10 @@ paths:
$ref: "#/components/responses/403" $ref: "#/components/responses/403"
422: 422:
$ref: "#/components/responses/422" $ref: "#/components/responses/422"
429:
$ref: "#/components/responses/429"
5XX:
description: 'Server error'
default: default:
$ref: "#/components/responses/default" $ref: "#/components/responses/default"
/api/v1/company_gateways/create: /api/v1/company_gateways/create: