From f0c4e4a614803f9948ee577c2656ef2acd2a0877 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 10:17:55 +1100 Subject: [PATCH 01/33] commit .env.cypress --- .env.cypress | 65 +++ cypress.config.js | 1 + tests/cypress/screenshots/.gitignore | 2 - tests/cypress/support/index.js | 5 +- tests/cypress/support/routes.json | 648 ++++++++++++++------------- tests/cypress/videos/.gitignore | 2 - 6 files changed, 409 insertions(+), 314 deletions(-) create mode 100644 .env.cypress delete mode 100644 tests/cypress/screenshots/.gitignore delete mode 100644 tests/cypress/videos/.gitignore diff --git a/.env.cypress b/.env.cypress new file mode 100644 index 000000000000..e3dd90bc2817 --- /dev/null +++ b/.env.cypress @@ -0,0 +1,65 @@ +APP_NAME="Invoice Ninja" +APP_ENV=local +APP_KEY=base64:xV0ixUbXIGjeWImmcjCYL8/XespgcEk+dTTPlM17dNE= +APP_DEBUG=true +APP_DOMAIN=ninja.test:8000 + +APP_URL=http://ninja.test:8000/ +#APP_URL=https://ninja.test + +DB_CONNECTION=mysql +MULTI_DB_ENABLED=false + +DB_HOST1=127.0.0.1 +DB_DATABASE1=db-ninja-01 +DB_USERNAME1=ninja +DB_PASSWORD1=ninja +DB_PORT1=3306 + +DB_HOST2=127.0.0.1 +DB_DATABASE2=db-ninja-02 +DB_USERNAME2=ninja +DB_PASSWORD2=ninja +DB_PORT2=3306 + +DEMO_MODE=false + +LOG_CHANNEL=stack +REQUIRE_HTTPS=false +BROADCAST_DRIVER=pusher +CACHE_DRIVER=redis +QUEUE_CONNECTION=database +SESSION_DRIVER=redis +SESSION_DOMAIN=.ninja.test +SESSION_LIFETIME=120 + +REDIS_HOST=127.0.0.1 +REDIS_PASSWORD=null +REDIS_PORT=6379 + +PUSHER_APP_ID="ninja" +PUSHER_APP_KEY="ninja" +PUSHER_APP_SECRET="ninja" +PUSHER_APP_CLUSTER="ninja1" + +MAIL_MAILER=log +MAIL_HOST=localhost +MAIL_PORT=1025 +MAIL_USERNAME=null +MAIL_PASSWORD=null +MAIL_ENCRYPTION=null + +MAIL_FROM_ADDRESS='' +MAIL_FROM_NAME='' + +GOOGLE_MAPS_API_KEY= + +NINJA_ENVIRONMENT=selfhost + +HASH_SALT= + +FILESYSTEM_DRIVER=public + +PDF_GENERATOR=snappdf + +MIX_ASSET_URL=false diff --git a/cypress.config.js b/cypress.config.js index 38502ba0d042..052450a24ca6 100644 --- a/cypress.config.js +++ b/cypress.config.js @@ -3,6 +3,7 @@ const { defineConfig } = require('cypress') module.exports = defineConfig({ chromeWebSecurity: false, retries: 2, + video: false, defaultCommandTimeout: 5000, watchForFileChanges: false, videosFolder: 'tests/cypress/videos', diff --git a/tests/cypress/screenshots/.gitignore b/tests/cypress/screenshots/.gitignore deleted file mode 100644 index d6b7ef32c847..000000000000 --- a/tests/cypress/screenshots/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -* -!.gitignore diff --git a/tests/cypress/support/index.js b/tests/cypress/support/index.js index bc30bc7a68c0..7ad35042b37b 100644 --- a/tests/cypress/support/index.js +++ b/tests/cypress/support/index.js @@ -23,7 +23,10 @@ before(() => { cy.task('activateCypressEnvFile', {}, { log: false }); cy.artisan('config:clear', {}, { log: false }); cy.refreshRoutes(); - cy.seed("RandomDataSeeder"); + cy.artisan("migrate:fresh", { + '--seed': true, + }); + cy.seed('RandomDataSeeder'); }); after(() => { diff --git a/tests/cypress/support/routes.json b/tests/cypress/support/routes.json index 5dad2ae68bb6..1b5aa01c2ea6 100644 --- a/tests/cypress/support/routes.json +++ b/tests/cypress/support/routes.json @@ -237,8 +237,8 @@ "HEAD" ] }, - "generated::9tgxNSXus6SSV0ES": { - "name": "generated::9tgxNSXus6SSV0ES", + "generated::LbMEKyHuoZZlPwNZ": { + "name": "generated::LbMEKyHuoZZlPwNZ", "domain": null, "action": "Livewire\\Controllers\\LivewireJavaScriptAssets@source", "uri": "livewire/livewire.js", @@ -247,8 +247,8 @@ "HEAD" ] }, - "generated::zhcNBnSOTjJa5Auk": { - "name": "generated::zhcNBnSOTjJa5Auk", + "generated::BERbHZk3mZlQ2zNh": { + "name": "generated::BERbHZk3mZlQ2zNh", "domain": null, "action": "Livewire\\Controllers\\LivewireJavaScriptAssets@maps", "uri": "livewire/livewire.js.map", @@ -294,8 +294,8 @@ "POST" ] }, - "generated::lcjLK643w88fu7E3": { - "name": "generated::lcjLK643w88fu7E3", + "generated::LcI9cAVRDG3eHEK0": { + "name": "generated::LcI9cAVRDG3eHEK0", "domain": null, "action": "App\\Http\\Controllers\\Auth\\LoginController@oauthApiLogin", "uri": "api/v1/oauth_login", @@ -312,8 +312,8 @@ "POST" ] }, - "generated::1SUcWtUJGUV0tfVM": { - "name": "generated::1SUcWtUJGUV0tfVM", + "generated::A629fcGvwTfLOJod": { + "name": "generated::A629fcGvwTfLOJod", "domain": null, "action": "App\\Http\\Controllers\\Auth\\ForgotPasswordController@sendResetLinkEmail", "uri": "api/v1/reset_password", @@ -636,8 +636,8 @@ "HEAD" ] }, - "api.generated::hUG9w98np43C7mkz": { - "name": "api.generated::hUG9w98np43C7mkz", + "api.generated::DET5P1AwuqN66R4r": { + "name": "api.generated::DET5P1AwuqN66R4r", "domain": null, "action": "App\\Http\\Controllers\\ActivityController@downloadHistoricalEntity", "uri": "api/v1/activities/download_entity/{activity}", @@ -741,15 +741,6 @@ "DELETE" ] }, - "api.clients.adjust_ledger": { - "name": "api.clients.adjust_ledger", - "domain": null, - "action": "App\\Http\\Controllers\\ClientController@adjustLedger", - "uri": "api/v1/clients/{client}/adjust_ledger", - "method": [ - "PUT" - ] - }, "api.clients.upload": { "name": "api.clients.upload", "domain": null, @@ -863,8 +854,8 @@ "DELETE" ] }, - "api.generated::22rcJuOzw564jRyT": { - "name": "api.generated::22rcJuOzw564jRyT", + "api.generated::ZWFw3c3zfOBw9pgT": { + "name": "api.generated::ZWFw3c3zfOBw9pgT", "domain": null, "action": "App\\Http\\Controllers\\ConnectedAccountController@index", "uri": "api/v1/connected_account", @@ -872,8 +863,8 @@ "POST" ] }, - "api.generated::rMOwW8reRxnSwYCD": { - "name": "api.generated::rMOwW8reRxnSwYCD", + "api.generated::Clo98Mgw3bI1A6qC": { + "name": "api.generated::Clo98Mgw3bI1A6qC", "domain": null, "action": "App\\Http\\Controllers\\ConnectedAccountController@handleGmailOauth", "uri": "api/v1/connected_account/gmail", @@ -890,8 +881,8 @@ "POST" ] }, - "api.generated::bjqXJbSpH7wgQFKb": { - "name": "api.generated::bjqXJbSpH7wgQFKb", + "api.generated::RppLbiTzkE6rL0xM": { + "name": "api.generated::RppLbiTzkE6rL0xM", "domain": null, "action": "App\\Http\\Controllers\\MigrationController@purgeCompany", "uri": "api/v1/companies/purge/{company}", @@ -899,8 +890,8 @@ "POST" ] }, - "api.generated::NDzAomJjJquQFDMc": { - "name": "api.generated::NDzAomJjJquQFDMc", + "api.generated::iog9yqNE2JOx4unn": { + "name": "api.generated::iog9yqNE2JOx4unn", "domain": null, "action": "App\\Http\\Controllers\\MigrationController@purgeCompanySaveSettings", "uri": "api/v1/companies/purge_save_settings/{company}", @@ -976,8 +967,8 @@ "DELETE" ] }, - "api.generated::nnxmNaHFc5HYMd1e": { - "name": "api.generated::nnxmNaHFc5HYMd1e", + "api.generated::pVqy59LIgOLTTR8J": { + "name": "api.generated::pVqy59LIgOLTTR8J", "domain": null, "action": "App\\Http\\Controllers\\CompanyController@upload", "uri": "api/v1/companies/{company}/upload", @@ -985,8 +976,8 @@ "PUT" ] }, - "api.generated::Aul4AwF3Vyr0zbA1": { - "name": "api.generated::Aul4AwF3Vyr0zbA1", + "api.generated::y64S7PFntB5Tvyko": { + "name": "api.generated::y64S7PFntB5Tvyko", "domain": null, "action": "App\\Http\\Controllers\\CompanyController@default", "uri": "api/v1/companies/{company}/default", @@ -1081,8 +1072,8 @@ "POST" ] }, - "api.generated::UhL9M8n8I9K6MkuN": { - "name": "api.generated::UhL9M8n8I9K6MkuN", + "api.generated::fMHDK9ykCMeiM5VI": { + "name": "api.generated::fMHDK9ykCMeiM5VI", "domain": null, "action": "App\\Http\\Controllers\\CompanyUserController@update", "uri": "api/v1/company_users/{user}", @@ -1186,6 +1177,16 @@ "POST" ] }, + "api.credits.downloadPdf": { + "name": "api.credits.downloadPdf", + "domain": null, + "action": "App\\Http\\Controllers\\CreditController@downloadPdf", + "uri": "api/v1/credit/{invitation_key}/download", + "method": [ + "GET", + "HEAD" + ] + }, "api.designs.index": { "name": "api.designs.index", "domain": null, @@ -1436,8 +1437,8 @@ "DELETE" ] }, - "api.generated::OWiGWLlLZWpbFSQ2": { - "name": "api.generated::OWiGWLlLZWpbFSQ2", + "api.generated::aC0Zr3SWvGhFFuiw": { + "name": "api.generated::aC0Zr3SWvGhFFuiw", "domain": null, "action": "App\\Http\\Controllers\\ExpenseController@upload", "uri": "api/v1/expenses/{expense}/upload", @@ -1608,8 +1609,8 @@ "DELETE" ] }, - "api.generated::9lZCDBC6fDL5q21R": { - "name": "api.generated::9lZCDBC6fDL5q21R", + "api.generated::2D4kIXL1pT31Trk0": { + "name": "api.generated::2D4kIXL1pT31Trk0", "domain": null, "action": "App\\Http\\Controllers\\GroupSettingController@bulk", "uri": "api/v1/group_settings/bulk", @@ -1796,8 +1797,8 @@ "POST" ] }, - "api.generated::JNCu852fm8brWprM": { - "name": "api.generated::JNCu852fm8brWprM", + "api.generated::hj0Y7xZpadV934D6": { + "name": "api.generated::hj0Y7xZpadV934D6", "domain": null, "action": "App\\Http\\Controllers\\MigrationController@purgeCompany", "uri": "api/v1/migration/purge/{company}", @@ -1805,8 +1806,8 @@ "POST" ] }, - "api.generated::J0qb09d1IZSKuB3T": { - "name": "api.generated::J0qb09d1IZSKuB3T", + "api.generated::QxQAIRXiLaLW0u9W": { + "name": "api.generated::QxQAIRXiLaLW0u9W", "domain": null, "action": "App\\Http\\Controllers\\MigrationController@purgeCompanySaveSettings", "uri": "api/v1/migration/purge_save_settings/{company}", @@ -1814,8 +1815,8 @@ "POST" ] }, - "api.generated::ITSwZTwLBJ1jvaBg": { - "name": "api.generated::ITSwZTwLBJ1jvaBg", + "api.generated::SAVbILd5Ud3QciAg": { + "name": "api.generated::SAVbILd5Ud3QciAg", "domain": null, "action": "App\\Http\\Controllers\\MigrationController@startMigration", "uri": "api/v1/migration/start", @@ -1823,8 +1824,8 @@ "POST" ] }, - "api.generated::W3GelFKf9MECShsz": { - "name": "api.generated::W3GelFKf9MECShsz", + "api.generated::3yv1OUwsjZrmnvtv": { + "name": "api.generated::3yv1OUwsjZrmnvtv", "domain": null, "action": "App\\Http\\Controllers\\OneTimeTokenController@create", "uri": "api/v1/one_time_token", @@ -1918,8 +1919,8 @@ "POST" ] }, - "api.generated::b5ZuoYI6S7M4ijwt": { - "name": "api.generated::b5ZuoYI6S7M4ijwt", + "api.generated::oH5pZVIeYNlaYagI": { + "name": "api.generated::oH5pZVIeYNlaYagI", "domain": null, "action": "App\\Http\\Controllers\\PaymentController@upload", "uri": "api/v1/payments/{payment}/upload", @@ -2022,6 +2023,15 @@ "POST" ] }, + "api.preview.design": { + "name": "api.preview.design", + "domain": null, + "action": "App\\Http\\Controllers\\PreviewController@design", + "uri": "api/v1/live_design", + "method": [ + "POST" + ] + }, "api.preview_purchase_order.show": { "name": "api.preview_purchase_order.show", "domain": null, @@ -2117,8 +2127,8 @@ "POST" ] }, - "api.generated::71ETdJ7Jkmc3mgmn": { - "name": "api.generated::71ETdJ7Jkmc3mgmn", + "api.generated::DH2U07gfXC2fJF8A": { + "name": "api.generated::DH2U07gfXC2fJF8A", "domain": null, "action": "App\\Http\\Controllers\\ProductController@upload", "uri": "api/v1/products/{product}/upload", @@ -2212,6 +2222,112 @@ "PUT" ] }, + "api.purchase_orders.index": { + "name": "api.purchase_orders.index", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@index", + "uri": "api/v1/purchase_orders", + "method": [ + "GET", + "HEAD" + ] + }, + "api.purchase_orders.create": { + "name": "api.purchase_orders.create", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@create", + "uri": "api/v1/purchase_orders/create", + "method": [ + "GET", + "HEAD" + ] + }, + "api.purchase_orders.store": { + "name": "api.purchase_orders.store", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@store", + "uri": "api/v1/purchase_orders", + "method": [ + "POST" + ] + }, + "api.purchase_orders.show": { + "name": "api.purchase_orders.show", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@show", + "uri": "api/v1/purchase_orders/{purchase_order}", + "method": [ + "GET", + "HEAD" + ] + }, + "api.purchase_orders.edit": { + "name": "api.purchase_orders.edit", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@edit", + "uri": "api/v1/purchase_orders/{purchase_order}/edit", + "method": [ + "GET", + "HEAD" + ] + }, + "api.purchase_orders.update": { + "name": "api.purchase_orders.update", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@update", + "uri": "api/v1/purchase_orders/{purchase_order}", + "method": [ + "PUT", + "PATCH" + ] + }, + "api.purchase_orders.destroy": { + "name": "api.purchase_orders.destroy", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@destroy", + "uri": "api/v1/purchase_orders/{purchase_order}", + "method": [ + "DELETE" + ] + }, + "api.purchase_orders.bulk": { + "name": "api.purchase_orders.bulk", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@bulk", + "uri": "api/v1/purchase_orders/bulk", + "method": [ + "POST" + ] + }, + "api.generated::FRRe3e5ToXKR8TzQ": { + "name": "api.generated::FRRe3e5ToXKR8TzQ", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@upload", + "uri": "api/v1/purchase_orders/{purchase_order}/upload", + "method": [ + "PUT" + ] + }, + "api.purchase_orders.action": { + "name": "api.purchase_orders.action", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@action", + "uri": "api/v1/purchase_orders/{purchase_order}/{action}", + "method": [ + "GET", + "HEAD" + ] + }, + "api.purchase_orders.downloadPdf": { + "name": "api.purchase_orders.downloadPdf", + "domain": null, + "action": "App\\Http\\Controllers\\PurchaseOrderController@downloadPdf", + "uri": "api/v1/purchase_order/{invitation_key}/download", + "method": [ + "GET", + "HEAD" + ] + }, "api.quotes.index": { "name": "api.quotes.index", "domain": null, @@ -2299,8 +2415,8 @@ "POST" ] }, - "api.generated::F37vmxMYBp00fEV5": { - "name": "api.generated::F37vmxMYBp00fEV5", + "api.generated::xykBtsm9tNrrpVZS": { + "name": "api.generated::xykBtsm9tNrrpVZS", "domain": null, "action": "App\\Http\\Controllers\\QuoteController@upload", "uri": "api/v1/quotes/{quote}/upload", @@ -2308,6 +2424,16 @@ "PUT" ] }, + "api.quotes.downloadPdf": { + "name": "api.quotes.downloadPdf", + "domain": null, + "action": "App\\Http\\Controllers\\QuoteController@downloadPdf", + "uri": "api/v1/quote/{invitation_key}/download", + "method": [ + "GET", + "HEAD" + ] + }, "api.recurring_expenses.index": { "name": "api.recurring_expenses.index", "domain": null, @@ -2385,8 +2511,8 @@ "POST" ] }, - "api.generated::oS0LS4kGxzFgcA7G": { - "name": "api.generated::oS0LS4kGxzFgcA7G", + "api.generated::QtWBtE5coePWEkRQ": { + "name": "api.generated::QtWBtE5coePWEkRQ", "domain": null, "action": "App\\Http\\Controllers\\RecurringExpenseController@upload", "uri": "api/v1/recurring_expenses/{recurring_expense}/upload", @@ -2471,8 +2597,8 @@ "POST" ] }, - "api.generated::THUWuXBktrWauVQ9": { - "name": "api.generated::THUWuXBktrWauVQ9", + "api.generated::fihLgQbJMRiLlCcf": { + "name": "api.generated::fihLgQbJMRiLlCcf", "domain": null, "action": "App\\Http\\Controllers\\RecurringInvoiceController@upload", "uri": "api/v1/recurring_invoices/{recurring_invoice}/upload", @@ -2557,8 +2683,8 @@ "POST" ] }, - "api.generated::zkD4lZXhrUXOjOZV": { - "name": "api.generated::zkD4lZXhrUXOjOZV", + "api.generated::9kp3yEZvFH07hggq": { + "name": "api.generated::9kp3yEZvFH07hggq", "domain": null, "action": "App\\Http\\Controllers\\RecurringQuoteController@upload", "uri": "api/v1/recurring_quotes/{recurring_quote}/upload", @@ -2566,8 +2692,8 @@ "PUT" ] }, - "api.generated::WmgewfqthVFRED2d": { - "name": "api.generated::WmgewfqthVFRED2d", + "api.generated::UXJcFXLyFP0eDcPq": { + "name": "api.generated::UXJcFXLyFP0eDcPq", "domain": null, "action": "App\\Http\\Controllers\\Auth\\LoginController@refresh", "uri": "api/v1/refresh", @@ -2575,8 +2701,8 @@ "POST" ] }, - "api.generated::aymYLRFHIROz1CoI": { - "name": "api.generated::aymYLRFHIROz1CoI", + "api.generated::1EgHwNPczRIKU64a": { + "name": "api.generated::1EgHwNPczRIKU64a", "domain": null, "action": "App\\Http\\Controllers\\Reports\\ClientReportController", "uri": "api/v1/reports/clients", @@ -2584,8 +2710,8 @@ "POST" ] }, - "api.generated::62Dhs7Yn6QvaFZ2K": { - "name": "api.generated::62Dhs7Yn6QvaFZ2K", + "api.generated::xr1Ozz0vPlXdgn5v": { + "name": "api.generated::xr1Ozz0vPlXdgn5v", "domain": null, "action": "App\\Http\\Controllers\\Reports\\ClientContactReportController", "uri": "api/v1/reports/contacts", @@ -2593,8 +2719,8 @@ "POST" ] }, - "api.generated::DYbmp87RBttLr1UR": { - "name": "api.generated::DYbmp87RBttLr1UR", + "api.generated::Vj78TPJKvfZ1Kjbs": { + "name": "api.generated::Vj78TPJKvfZ1Kjbs", "domain": null, "action": "App\\Http\\Controllers\\Reports\\CreditReportController", "uri": "api/v1/reports/credits", @@ -2602,8 +2728,8 @@ "POST" ] }, - "api.generated::9ylFhDv2gS6bYYR3": { - "name": "api.generated::9ylFhDv2gS6bYYR3", + "api.generated::Ukm6MdxG36lz85m8": { + "name": "api.generated::Ukm6MdxG36lz85m8", "domain": null, "action": "App\\Http\\Controllers\\Reports\\DocumentReportController", "uri": "api/v1/reports/documents", @@ -2611,8 +2737,8 @@ "POST" ] }, - "api.generated::BxIThlKQJ8Xb4Snc": { - "name": "api.generated::BxIThlKQJ8Xb4Snc", + "api.generated::xeGsy4HGVfWmLXzS": { + "name": "api.generated::xeGsy4HGVfWmLXzS", "domain": null, "action": "App\\Http\\Controllers\\Reports\\ExpenseReportController", "uri": "api/v1/reports/expenses", @@ -2620,8 +2746,8 @@ "POST" ] }, - "api.generated::iy3PRl2i3JLjIpJS": { - "name": "api.generated::iy3PRl2i3JLjIpJS", + "api.generated::UZ4kCKLyMUGpotjr": { + "name": "api.generated::UZ4kCKLyMUGpotjr", "domain": null, "action": "App\\Http\\Controllers\\Reports\\InvoiceReportController", "uri": "api/v1/reports/invoices", @@ -2629,8 +2755,8 @@ "POST" ] }, - "api.generated::Ut3nqZF6THUhM90z": { - "name": "api.generated::Ut3nqZF6THUhM90z", + "api.generated::FNb6VjLMKGzfUbFf": { + "name": "api.generated::FNb6VjLMKGzfUbFf", "domain": null, "action": "App\\Http\\Controllers\\Reports\\InvoiceItemReportController", "uri": "api/v1/reports/invoice_items", @@ -2638,8 +2764,8 @@ "POST" ] }, - "api.generated::OEdvit54646VZKfS": { - "name": "api.generated::OEdvit54646VZKfS", + "api.generated::I0HDnHslCugFPzIq": { + "name": "api.generated::I0HDnHslCugFPzIq", "domain": null, "action": "App\\Http\\Controllers\\Reports\\QuoteReportController", "uri": "api/v1/reports/quotes", @@ -2647,8 +2773,8 @@ "POST" ] }, - "api.generated::5yoyFjddx6bw5qm4": { - "name": "api.generated::5yoyFjddx6bw5qm4", + "api.generated::VzDpeYGVm0JQHzEl": { + "name": "api.generated::VzDpeYGVm0JQHzEl", "domain": null, "action": "App\\Http\\Controllers\\Reports\\QuoteItemReportController", "uri": "api/v1/reports/quote_items", @@ -2656,8 +2782,8 @@ "POST" ] }, - "api.generated::Zbvku8lj1KcLOzcX": { - "name": "api.generated::Zbvku8lj1KcLOzcX", + "api.generated::CxnnFo9Af4EdAZxF": { + "name": "api.generated::CxnnFo9Af4EdAZxF", "domain": null, "action": "App\\Http\\Controllers\\Reports\\RecurringInvoiceReportController", "uri": "api/v1/reports/recurring_invoices", @@ -2665,8 +2791,8 @@ "POST" ] }, - "api.generated::ST82bPUDej34kcaF": { - "name": "api.generated::ST82bPUDej34kcaF", + "api.generated::tDchnoCNqygMLdD4": { + "name": "api.generated::tDchnoCNqygMLdD4", "domain": null, "action": "App\\Http\\Controllers\\Reports\\PaymentReportController", "uri": "api/v1/reports/payments", @@ -2674,8 +2800,8 @@ "POST" ] }, - "api.generated::8bSFQS6iGE57gnqO": { - "name": "api.generated::8bSFQS6iGE57gnqO", + "api.generated::V6NKGZ40HiwSNIME": { + "name": "api.generated::V6NKGZ40HiwSNIME", "domain": null, "action": "App\\Http\\Controllers\\Reports\\ProductReportController", "uri": "api/v1/reports/products", @@ -2683,8 +2809,8 @@ "POST" ] }, - "api.generated::lexe4yWHwLRtavAk": { - "name": "api.generated::lexe4yWHwLRtavAk", + "api.generated::ysxp85Ae9kPbBlvB": { + "name": "api.generated::ysxp85Ae9kPbBlvB", "domain": null, "action": "App\\Http\\Controllers\\Reports\\ProductSalesReportController", "uri": "api/v1/reports/product_sales", @@ -2692,8 +2818,8 @@ "POST" ] }, - "api.generated::mMlDQpafXpi2y7KC": { - "name": "api.generated::mMlDQpafXpi2y7KC", + "api.generated::v09ahXVLGLjqMc7I": { + "name": "api.generated::v09ahXVLGLjqMc7I", "domain": null, "action": "App\\Http\\Controllers\\Reports\\TaskReportController", "uri": "api/v1/reports/tasks", @@ -2701,8 +2827,8 @@ "POST" ] }, - "api.generated::S43GAj6FZKKN9Ute": { - "name": "api.generated::S43GAj6FZKKN9Ute", + "api.generated::zxNa0Fjha2JiMSO9": { + "name": "api.generated::zxNa0Fjha2JiMSO9", "domain": null, "action": "App\\Http\\Controllers\\Reports\\ProfitAndLossController", "uri": "api/v1/reports/profitloss", @@ -2787,8 +2913,8 @@ "POST" ] }, - "api.generated::Mli43AT6LwA7TTMe": { - "name": "api.generated::Mli43AT6LwA7TTMe", + "api.generated::CqQYJuTjXxqI0N0y": { + "name": "api.generated::CqQYJuTjXxqI0N0y", "domain": null, "action": "App\\Http\\Controllers\\SchedulerController@index", "uri": "api/v1/scheduler", @@ -2797,8 +2923,8 @@ "HEAD" ] }, - "api.generated::g8kHq9TIw6VjkGEx": { - "name": "api.generated::g8kHq9TIw6VjkGEx", + "api.generated::tAKhoC6yZ3ChYtiK": { + "name": "api.generated::tAKhoC6yZ3ChYtiK", "domain": null, "action": "App\\Http\\Controllers\\Support\\Messages\\SendingController", "uri": "api/v1/support/messages/send", @@ -2806,8 +2932,8 @@ "POST" ] }, - "api.generated::2O90hX0dRTiHoISd": { - "name": "api.generated::2O90hX0dRTiHoISd", + "api.generated::Njqn78yYjJGvmX0y": { + "name": "api.generated::Njqn78yYjJGvmX0y", "domain": null, "action": "App\\Http\\Controllers\\SelfUpdateController@update", "uri": "api/v1/self-update", @@ -2815,8 +2941,8 @@ "POST" ] }, - "api.generated::SMQnAxLt7UFSxZG5": { - "name": "api.generated::SMQnAxLt7UFSxZG5", + "api.generated::cXnwkp2th6W3f332": { + "name": "api.generated::cXnwkp2th6W3f332", "domain": null, "action": "App\\Http\\Controllers\\SelfUpdateController@checkVersion", "uri": "api/v1/self-update/check_version", @@ -2969,8 +3095,8 @@ "POST" ] }, - "api.generated::BNkMBhpaKDH5htD8": { - "name": "api.generated::BNkMBhpaKDH5htD8", + "api.generated::CzIPyK9bctiZ2kre": { + "name": "api.generated::CzIPyK9bctiZ2kre", "domain": null, "action": "App\\Http\\Controllers\\TaskController@upload", "uri": "api/v1/tasks/{task}/upload", @@ -2978,8 +3104,8 @@ "PUT" ] }, - "api.generated::DSQ6KzZbD0Nj4vRs": { - "name": "api.generated::DSQ6KzZbD0Nj4vRs", + "api.generated::WsD7DZAXcVCRebnD": { + "name": "api.generated::WsD7DZAXcVCRebnD", "domain": null, "action": "App\\Http\\Controllers\\TaskController@sort", "uri": "api/v1/tasks/sort", @@ -3227,8 +3353,8 @@ "POST" ] }, - "api.generated::iQwZSxzIzx70IxtF": { - "name": "api.generated::iQwZSxzIzx70IxtF", + "api.generated::5F8psNW4tgBliQKp": { + "name": "api.generated::5F8psNW4tgBliQKp", "domain": null, "action": "App\\Http\\Controllers\\TwoFactorController@setupTwoFactor", "uri": "api/v1/settings/enable_two_factor", @@ -3237,8 +3363,8 @@ "HEAD" ] }, - "api.generated::PTr1o4tRf7yTSGI3": { - "name": "api.generated::PTr1o4tRf7yTSGI3", + "api.generated::numU1oTJ77ywzjz7": { + "name": "api.generated::numU1oTJ77ywzjz7", "domain": null, "action": "App\\Http\\Controllers\\TwoFactorController@enableTwoFactor", "uri": "api/v1/settings/enable_two_factor", @@ -3246,8 +3372,8 @@ "POST" ] }, - "api.generated::24H010vh5AAmAco9": { - "name": "api.generated::24H010vh5AAmAco9", + "api.generated::JTyFrmsuyZcL5mFg": { + "name": "api.generated::JTyFrmsuyZcL5mFg", "domain": null, "action": "App\\Http\\Controllers\\TwoFactorController@disableTwoFactor", "uri": "api/v1/settings/disable_two_factor", @@ -3350,8 +3476,8 @@ "POST" ] }, - "api.generated::BZLuCDpgKz3nMmaY": { - "name": "api.generated::BZLuCDpgKz3nMmaY", + "api.generated::mhRrJyNsS8qflOvt": { + "name": "api.generated::mhRrJyNsS8qflOvt", "domain": null, "action": "App\\Http\\Controllers\\VendorController@upload", "uri": "api/v1/vendors/{vendor}/upload", @@ -3359,104 +3485,8 @@ "PUT" ] }, - "api.purchase_orders.index": { - "name": "api.purchase_orders.index", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@index", - "uri": "api/v1/purchase_orders", - "method": [ - "GET", - "HEAD" - ] - }, - "api.purchase_orders.create": { - "name": "api.purchase_orders.create", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@create", - "uri": "api/v1/purchase_orders/create", - "method": [ - "GET", - "HEAD" - ] - }, - "api.purchase_orders.store": { - "name": "api.purchase_orders.store", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@store", - "uri": "api/v1/purchase_orders", - "method": [ - "POST" - ] - }, - "api.purchase_orders.show": { - "name": "api.purchase_orders.show", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@show", - "uri": "api/v1/purchase_orders/{purchase_order}", - "method": [ - "GET", - "HEAD" - ] - }, - "api.purchase_orders.edit": { - "name": "api.purchase_orders.edit", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@edit", - "uri": "api/v1/purchase_orders/{purchase_order}/edit", - "method": [ - "GET", - "HEAD" - ] - }, - "api.purchase_orders.update": { - "name": "api.purchase_orders.update", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@update", - "uri": "api/v1/purchase_orders/{purchase_order}", - "method": [ - "PUT", - "PATCH" - ] - }, - "api.purchase_orders.destroy": { - "name": "api.purchase_orders.destroy", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@destroy", - "uri": "api/v1/purchase_orders/{purchase_order}", - "method": [ - "DELETE" - ] - }, - "api.purchase_orders.bulk": { - "name": "api.purchase_orders.bulk", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@bulk", - "uri": "api/v1/purchase_orders/bulk", - "method": [ - "POST" - ] - }, - "api.generated::Q8EXQTr8qdJCPNJ9": { - "name": "api.generated::Q8EXQTr8qdJCPNJ9", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@upload", - "uri": "api/v1/purchase_orders/{purchase_order}/upload", - "method": [ - "PUT" - ] - }, - "api.purchase_orders.action": { - "name": "api.purchase_orders.action", - "domain": null, - "action": "App\\Http\\Controllers\\PurchaseOrderController@action", - "uri": "api/v1/purchase_orders/{purchase_order}/{action}", - "method": [ - "GET", - "HEAD" - ] - }, - "api.generated::cLF9tHEkg3AItUie": { - "name": "api.generated::cLF9tHEkg3AItUie", + "api.generated::iHeTlsHSBvc8QUl2": { + "name": "api.generated::iHeTlsHSBvc8QUl2", "domain": null, "action": "App\\Http\\Controllers\\UserController@index", "uri": "api/v1/users", @@ -3465,8 +3495,8 @@ "HEAD" ] }, - "api.generated::NaclFWOfrFXf5Ty7": { - "name": "api.generated::NaclFWOfrFXf5Ty7", + "api.generated::r5IFdxDgANfm8Pfv": { + "name": "api.generated::r5IFdxDgANfm8Pfv", "domain": null, "action": "App\\Http\\Controllers\\UserController@create", "uri": "api/v1/users/create", @@ -3475,8 +3505,8 @@ "HEAD" ] }, - "api.generated::QaO678U9QW3Q2L7Q": { - "name": "api.generated::QaO678U9QW3Q2L7Q", + "api.generated::OoPzNCnPak5mBRiN": { + "name": "api.generated::OoPzNCnPak5mBRiN", "domain": null, "action": "App\\Http\\Controllers\\UserController@show", "uri": "api/v1/users/{user}", @@ -3485,8 +3515,8 @@ "HEAD" ] }, - "api.generated::LfpiUfJ0i6DLKqeh": { - "name": "api.generated::LfpiUfJ0i6DLKqeh", + "api.generated::K8njQsVfRFu2fD8q": { + "name": "api.generated::K8njQsVfRFu2fD8q", "domain": null, "action": "App\\Http\\Controllers\\UserController@update", "uri": "api/v1/users/{user}", @@ -3494,8 +3524,8 @@ "PUT" ] }, - "api.generated::o0IEjAcNUlkefAKc": { - "name": "api.generated::o0IEjAcNUlkefAKc", + "api.generated::IWF3MIMmtwiOAqIX": { + "name": "api.generated::IWF3MIMmtwiOAqIX", "domain": null, "action": "App\\Http\\Controllers\\UserController@store", "uri": "api/v1/users", @@ -3503,8 +3533,8 @@ "POST" ] }, - "api.generated::iIgPZF6w9LmIEAsq": { - "name": "api.generated::iIgPZF6w9LmIEAsq", + "api.generated::w3TusGgioIOwpEwp": { + "name": "api.generated::w3TusGgioIOwpEwp", "domain": null, "action": "App\\Http\\Controllers\\UserController@detach", "uri": "api/v1/users/{user}/detach_from_company", @@ -3521,8 +3551,8 @@ "POST" ] }, - "api.generated::tE9y5fe5gtz2vc6e": { - "name": "api.generated::tE9y5fe5gtz2vc6e", + "api.generated::wx7oIo2t2NqApI4Y": { + "name": "api.generated::wx7oIo2t2NqApI4Y", "domain": null, "action": "App\\Http\\Controllers\\UserController@invite", "uri": "api/v1/users/{user}/invite", @@ -3530,8 +3560,8 @@ "POST" ] }, - "api.generated::JXFzipCBQGvF2TXl": { - "name": "api.generated::JXFzipCBQGvF2TXl", + "api.generated::EJ4RQTlsSfcxpakf": { + "name": "api.generated::EJ4RQTlsSfcxpakf", "domain": null, "action": "App\\Http\\Controllers\\UserController@reconfirm", "uri": "api/v1/user/{user}/reconfirm", @@ -3729,8 +3759,8 @@ "POST" ] }, - "api.generated::zcZpdTjHdtDpLxLW": { - "name": "api.generated::zcZpdTjHdtDpLxLW", + "api.generated::OgFxwnB4UDDUHOVA": { + "name": "api.generated::OgFxwnB4UDDUHOVA", "domain": null, "action": "App\\Http\\Controllers\\StaticController", "uri": "api/v1/statics", @@ -3779,8 +3809,8 @@ "HEAD" ] }, - "generated::ZQYgiUyM8ziyaylK": { - "name": "generated::ZQYgiUyM8ziyaylK", + "generated::4jDCwtq9RZID899C": { + "name": "generated::4jDCwtq9RZID899C", "domain": null, "action": "App\\Http\\Controllers\\PostMarkController@webhook", "uri": "api/v1/postmark_webhook", @@ -3788,8 +3818,8 @@ "POST" ] }, - "generated::zaPZNhsZe5kCRQOf": { - "name": "generated::zaPZNhsZe5kCRQOf", + "generated::xbH64tE1hcfrv4hm": { + "name": "generated::xbH64tE1hcfrv4hm", "domain": null, "action": "App\\Http\\Controllers\\OneTimeTokenController@router", "uri": "token_hash_router", @@ -3798,8 +3828,8 @@ "HEAD" ] }, - "generated::deYiRv49t4s9EtvU": { - "name": "generated::deYiRv49t4s9EtvU", + "generated::F0e3meo4BBqwwQPm": { + "name": "generated::F0e3meo4BBqwwQPm", "domain": null, "action": "App\\Http\\Controllers\\WebCronController@index", "uri": "webcron", @@ -3808,8 +3838,8 @@ "HEAD" ] }, - "generated::zNk9B5Y1TZHythfd": { - "name": "generated::zNk9B5Y1TZHythfd", + "generated::Az7dUZcLqUN37UFH": { + "name": "generated::Az7dUZcLqUN37UFH", "domain": null, "action": "App\\Http\\Controllers\\HostedMigrationController@getAccount", "uri": "api/v1/get_migration_account", @@ -3817,8 +3847,8 @@ "POST" ] }, - "generated::SjmsOCah7DRT9cKO": { - "name": "generated::SjmsOCah7DRT9cKO", + "generated::kBFjYNVLCyYWz2Dk": { + "name": "generated::kBFjYNVLCyYWz2Dk", "domain": null, "action": "App\\Http\\Controllers\\HostedMigrationController@confirmForwarding", "uri": "api/v1/confirm_forwarding", @@ -3826,8 +3856,8 @@ "POST" ] }, - "generated::hjNG27uFkl607frE": { - "name": "generated::hjNG27uFkl607frE", + "generated::xXywAAINKFcV2Uan": { + "name": "generated::xXywAAINKFcV2Uan", "domain": null, "action": "App\\Http\\Controllers\\InAppPurchase\\AppleController@process_webhook", "uri": "api/v1/process_webhook", @@ -3835,8 +3865,8 @@ "POST" ] }, - "generated::i4B5LyT7ozSnWLm7": { - "name": "generated::i4B5LyT7ozSnWLm7", + "generated::S4N7QDie9lTj9Qs7": { + "name": "generated::S4N7QDie9lTj9Qs7", "domain": null, "action": "App\\Http\\Controllers\\InAppPurchase\\AppleController@confirm_purchase", "uri": "api/v1/confirm_purchase", @@ -3844,8 +3874,8 @@ "POST" ] }, - "generated::NR0QT6QhHpRzgeFM": { - "name": "generated::NR0QT6QhHpRzgeFM", + "generated::4lAmmJb85Vq2JS1H": { + "name": "generated::4lAmmJb85Vq2JS1H", "domain": null, "action": "App\\Http\\Controllers\\Bank\\YodleeController@refreshWebhook", "uri": "api/v1/yodlee/refresh", @@ -3853,8 +3883,8 @@ "POST" ] }, - "generated::PWE4ouJw551wvLgP": { - "name": "generated::PWE4ouJw551wvLgP", + "generated::A0JmbHLalcwDt14e": { + "name": "generated::A0JmbHLalcwDt14e", "domain": null, "action": "App\\Http\\Controllers\\Bank\\YodleeController@dataUpdatesWebhook", "uri": "api/v1/yodlee/data_updates", @@ -3862,8 +3892,8 @@ "POST" ] }, - "generated::VwAPqf4N7d9C2UeH": { - "name": "generated::VwAPqf4N7d9C2UeH", + "generated::HC8m9NQ4L0D938Ed": { + "name": "generated::HC8m9NQ4L0D938Ed", "domain": null, "action": "App\\Http\\Controllers\\Bank\\YodleeController@refreshUpdatesWebhook", "uri": "api/v1/yodlee/refresh_updates", @@ -3871,8 +3901,8 @@ "POST" ] }, - "generated::5JgTIkTeVYZXmSiu": { - "name": "generated::5JgTIkTeVYZXmSiu", + "generated::nqtdv0BmmfGpdKuF": { + "name": "generated::nqtdv0BmmfGpdKuF", "domain": null, "action": "App\\Http\\Controllers\\Bank\\YodleeController@balanceWebhook", "uri": "api/v1/yodlee/balance", @@ -3880,8 +3910,8 @@ "POST" ] }, - "generated::YYiG6iYqw6W4nInb": { - "name": "generated::YYiG6iYqw6W4nInb", + "generated::spyxazsXktbv5nOs": { + "name": "generated::spyxazsXktbv5nOs", "domain": null, "action": "App\\Http\\Controllers\\BaseController@notFoundClient", "uri": "{fallbackPlaceholder}", @@ -3890,8 +3920,8 @@ "HEAD" ] }, - "generated::5n5VePUCRt2TAvGW": { - "name": "generated::5n5VePUCRt2TAvGW", + "generated::bF8WcnpfZpbhbbkA": { + "name": "generated::bF8WcnpfZpbhbbkA", "domain": null, "action": "App\\Http\\Controllers\\BaseController@flutterRoute", "uri": "/", @@ -3900,8 +3930,8 @@ "HEAD" ] }, - "generated::TGoVLPXTPVLegDrn": { - "name": "generated::TGoVLPXTPVLegDrn", + "generated::ecOcADO3tabQyhRB": { + "name": "generated::ecOcADO3tabQyhRB", "domain": null, "action": "App\\Http\\Controllers\\SetupController@index", "uri": "setup", @@ -3910,8 +3940,8 @@ "HEAD" ] }, - "generated::aH1RYcdoUCNh2Or0": { - "name": "generated::aH1RYcdoUCNh2Or0", + "generated::mZDWFOC7mo1MwpSl": { + "name": "generated::mZDWFOC7mo1MwpSl", "domain": null, "action": "App\\Http\\Controllers\\SetupController@doSetup", "uri": "setup", @@ -3919,8 +3949,8 @@ "POST" ] }, - "generated::ulIBz1EVGnyK1CV6": { - "name": "generated::ulIBz1EVGnyK1CV6", + "generated::PF514EHyl9u4u4OL": { + "name": "generated::PF514EHyl9u4u4OL", "domain": null, "action": "App\\Http\\Controllers\\SetupController@update", "uri": "update", @@ -3929,8 +3959,8 @@ "HEAD" ] }, - "generated::Fe1X26NAn3ce88sX": { - "name": "generated::Fe1X26NAn3ce88sX", + "generated::xcW1bwOAqv0kUUpg": { + "name": "generated::xcW1bwOAqv0kUUpg", "domain": null, "action": "App\\Http\\Controllers\\SetupController@checkDB", "uri": "setup/check_db", @@ -3938,8 +3968,8 @@ "POST" ] }, - "generated::rqZwGUSDMdBc845j": { - "name": "generated::rqZwGUSDMdBc845j", + "generated::BNHKMmzHx6FTpNuJ": { + "name": "generated::BNHKMmzHx6FTpNuJ", "domain": null, "action": "App\\Http\\Controllers\\SetupController@checkMail", "uri": "setup/check_mail", @@ -3947,8 +3977,8 @@ "POST" ] }, - "generated::RDiaxJz5C9TWM6La": { - "name": "generated::RDiaxJz5C9TWM6La", + "generated::Z4f4gHVQuvTS2PvL": { + "name": "generated::Z4f4gHVQuvTS2PvL", "domain": null, "action": "App\\Http\\Controllers\\SetupController@checkPdf", "uri": "setup/check_pdf", @@ -4014,8 +4044,8 @@ "HEAD" ] }, - "generated::i4zkszi5XG1MagwJ": { - "name": "generated::i4zkszi5XG1MagwJ", + "generated::nWWw54Bz32uDU73y": { + "name": "generated::nWWw54Bz32uDU73y", "domain": null, "action": "App\\Http\\Controllers\\Auth\\LoginController@redirectToProvider", "uri": "auth/{provider}", @@ -4024,8 +4054,8 @@ "HEAD" ] }, - "generated::pDEX8qT4P8Jy1hu4": { - "name": "generated::pDEX8qT4P8Jy1hu4", + "generated::VPYo2z9LjzmGyrAr": { + "name": "generated::VPYo2z9LjzmGyrAr", "domain": null, "action": "App\\Http\\Controllers\\UserController@confirm", "uri": "user/confirm/{confirmation_code}", @@ -4034,8 +4064,8 @@ "HEAD" ] }, - "generated::fLK4xgr1UGJhcpEI": { - "name": "generated::fLK4xgr1UGJhcpEI", + "generated::DZ1E4NWn9DeAKTmq": { + "name": "generated::DZ1E4NWn9DeAKTmq", "domain": null, "action": "App\\Http\\Controllers\\UserController@confirmWithPassword", "uri": "user/confirm/{confirmation_code}", @@ -4103,8 +4133,8 @@ "HEAD" ] }, - "generated::Dbvz1KDmhDKppMVJ": { - "name": "generated::Dbvz1KDmhDKppMVJ", + "generated::5kIlSr2tGj8fe8Xv": { + "name": "generated::5kIlSr2tGj8fe8Xv", "domain": null, "action": "App\\Http\\Controllers\\ClientPortal\\ApplePayDomainController@showAppleMerchantId", "uri": ".well-known/apple-developer-merchantid-domain-association", @@ -4113,8 +4143,8 @@ "HEAD" ] }, - "generated::djeIjZ5TvGKb9kp1": { - "name": "generated::djeIjZ5TvGKb9kp1", + "generated::PNW7F8OYShGQRz3Q": { + "name": "generated::PNW7F8OYShGQRz3Q", "domain": null, "action": "App\\Http\\Controllers\\Contact\\LoginController@apiLogin", "uri": "api/v1/contact/login", @@ -4162,8 +4192,8 @@ "HEAD" ] }, - "vendor.generated::R5AP0ff5fGIEFhSb": { - "name": "vendor.generated::R5AP0ff5fGIEFhSb", + "vendor.generated::NwLUmJ8Z7uDQAYi4": { + "name": "vendor.generated::NwLUmJ8Z7uDQAYi4", "domain": null, "action": "App\\Http\\Controllers\\VendorPortal\\InvitationController@download", "uri": "vendor/purchase_order/{invitation_key}/download", @@ -4337,8 +4367,8 @@ "HEAD" ] }, - "generated::rpgQ9O14ZONbXkpu": { - "name": "generated::rpgQ9O14ZONbXkpu", + "generated::1treHbNadtYbt8l5": { + "name": "generated::1treHbNadtYbt8l5", "domain": null, "action": "App\\Http\\Controllers\\Auth\\ContactRegisterController@register", "uri": "client/register/{company_key?}", @@ -4404,8 +4434,8 @@ "HEAD" ] }, - "generated::FBJnNwDY5zUdpbgD": { - "name": "generated::FBJnNwDY5zUdpbgD", + "generated::YaZCrI8ELO78h3ik": { + "name": "generated::YaZCrI8ELO78h3ik", "domain": null, "action": "App\\Http\\Controllers\\ClientPortal\\EntityViewController@handlePassword", "uri": "view/{entity_type}/{invitation_key}/password", @@ -4472,8 +4502,8 @@ "HEAD" ] }, - "generated::mLyFQRhcZwffpGmu": { - "name": "generated::mLyFQRhcZwffpGmu", + "generated::8AGcFJVqXoCVp8vF": { + "name": "generated::8AGcFJVqXoCVp8vF", "domain": null, "action": "App\\Http\\Controllers\\ClientPortal\\InvitationController@paymentRouter", "uri": "client/payment/{contact_key}/{payment_id}", @@ -5018,8 +5048,8 @@ "HEAD" ] }, - "client.generated::2OaIW3XyBqUuFmmR": { - "name": "client.generated::2OaIW3XyBqUuFmmR", + "client.generated::H8hCyNDzwMF60PJs": { + "name": "client.generated::H8hCyNDzwMF60PJs", "domain": null, "action": "App\\Http\\Controllers\\ClientPortal\\InvitationController@recurringRouter", "uri": "client/recurring_invoice/{invitation_key}", @@ -5028,8 +5058,8 @@ "HEAD" ] }, - "client.generated::qqFOMAohukdLzli8": { - "name": "client.generated::qqFOMAohukdLzli8", + "client.generated::uZMvsHShteWNNF2k": { + "name": "client.generated::uZMvsHShteWNNF2k", "domain": null, "action": "App\\Http\\Controllers\\ClientPortal\\InvitationController@invoiceRouter", "uri": "client/invoice/{invitation_key}", @@ -5038,8 +5068,8 @@ "HEAD" ] }, - "client.generated::MpuK89JSkGHcs8Px": { - "name": "client.generated::MpuK89JSkGHcs8Px", + "client.generated::CS1U71QvDjdE9QU2": { + "name": "client.generated::CS1U71QvDjdE9QU2", "domain": null, "action": "App\\Http\\Controllers\\ClientPortal\\InvitationController@quoteRouter", "uri": "client/quote/{invitation_key}", @@ -5048,8 +5078,8 @@ "HEAD" ] }, - "client.generated::7sb34HxR9uLCiSxY": { - "name": "client.generated::7sb34HxR9uLCiSxY", + "client.generated::mEmCvZlhZjOtKBro": { + "name": "client.generated::mEmCvZlhZjOtKBro", "domain": null, "action": "App\\Http\\Controllers\\ClientPortal\\InvitationController@creditRouter", "uri": "client/credit/{invitation_key}", @@ -5098,8 +5128,8 @@ "HEAD" ] }, - "client.generated::XWcWZmVfyICKpQSJ": { - "name": "client.generated::XWcWZmVfyICKpQSJ", + "client.generated::dFh8YyI3NF90jeA7": { + "name": "client.generated::dFh8YyI3NF90jeA7", "domain": null, "action": "App\\Http\\Controllers\\ClientPortal\\InvitationController@routerForDownload", "uri": "client/{entity}/{invitation_key}/download", @@ -5138,8 +5168,8 @@ "HEAD" ] }, - "generated::mbXaf7AwVDTLun7i": { - "name": "generated::mbXaf7AwVDTLun7i", + "generated::DX2GaT7Q2aij92cd": { + "name": "generated::DX2GaT7Q2aij92cd", "domain": null, "action": "App\\Http\\Controllers\\Shop\\ProductController@index", "uri": "api/v1/shop/products", @@ -5148,8 +5178,8 @@ "HEAD" ] }, - "generated::vstdpye8tLBf8JAy": { - "name": "generated::vstdpye8tLBf8JAy", + "generated::iJde93wQL6YxqVFK": { + "name": "generated::iJde93wQL6YxqVFK", "domain": null, "action": "App\\Http\\Controllers\\Shop\\ClientController@store", "uri": "api/v1/shop/clients", @@ -5157,8 +5187,8 @@ "POST" ] }, - "generated::WhdRIYkzRIiAE8Zy": { - "name": "generated::WhdRIYkzRIiAE8Zy", + "generated::na3kmJrHWqOlbohO": { + "name": "generated::na3kmJrHWqOlbohO", "domain": null, "action": "App\\Http\\Controllers\\Shop\\InvoiceController@store", "uri": "api/v1/shop/invoices", @@ -5166,8 +5196,8 @@ "POST" ] }, - "generated::jmKt9NXIdAhbDj1Z": { - "name": "generated::jmKt9NXIdAhbDj1Z", + "generated::7P1ePmtaqydcKOBA": { + "name": "generated::7P1ePmtaqydcKOBA", "domain": null, "action": "App\\Http\\Controllers\\Shop\\ClientController@show", "uri": "api/v1/shop/client/{contact_key}", @@ -5176,8 +5206,8 @@ "HEAD" ] }, - "generated::oDii2kL46XkNAIq7": { - "name": "generated::oDii2kL46XkNAIq7", + "generated::lAwZhvjZalRR5aZf": { + "name": "generated::lAwZhvjZalRR5aZf", "domain": null, "action": "App\\Http\\Controllers\\Shop\\InvoiceController@show", "uri": "api/v1/shop/invoice/{invitation_key}", @@ -5186,8 +5216,8 @@ "HEAD" ] }, - "generated::hcZIdmMVQWRg8fcW": { - "name": "generated::hcZIdmMVQWRg8fcW", + "generated::WE9qPq1BvsH3USKi": { + "name": "generated::WE9qPq1BvsH3USKi", "domain": null, "action": "App\\Http\\Controllers\\Shop\\ProductController@show", "uri": "api/v1/shop/product/{product_key}", @@ -5196,8 +5226,8 @@ "HEAD" ] }, - "generated::B1hEiRmAZvYhMDB3": { - "name": "generated::B1hEiRmAZvYhMDB3", + "generated::90IHZXAOxuwPCLe4": { + "name": "generated::90IHZXAOxuwPCLe4", "domain": null, "action": "App\\Http\\Controllers\\Shop\\ProfileController@show", "uri": "api/v1/shop/profile", @@ -5243,8 +5273,8 @@ "HEAD" ] }, - "generated::Equd3NqTzSG8DBd0": { - "name": "generated::Equd3NqTzSG8DBd0", + "generated::NwYLFBGVXwLgzKI9": { + "name": "generated::NwYLFBGVXwLgzKI9", "domain": null, "action": "Modules\\Admin\\Http\\Controllers\\LoginController@login", "uri": "admin/login", @@ -5585,8 +5615,8 @@ "HEAD" ] }, - "generated::Kib8hMR7yxwg141Y": { - "name": "generated::Kib8hMR7yxwg141Y", + "generated::XoLRi9FKg3P30e96": { + "name": "generated::XoLRi9FKg3P30e96", "domain": null, "action": "Modules\\Admin\\Http\\Controllers\\OnboardingController@unsubscribe", "uri": "onboarding/unsubscribe/{account_key}", @@ -5595,8 +5625,8 @@ "HEAD" ] }, - "generated::KZIwSvsiWdkFJOg9": { - "name": "generated::KZIwSvsiWdkFJOg9", + "generated::vGh9ZOZ5qs8bCl4v": { + "name": "generated::vGh9ZOZ5qs8bCl4v", "domain": null, "action": "Modules\\Admin\\Http\\Controllers\\CertificateController@index", "uri": ".well-known/acme-challenge/{challenge_token}", diff --git a/tests/cypress/videos/.gitignore b/tests/cypress/videos/.gitignore deleted file mode 100644 index d6b7ef32c847..000000000000 --- a/tests/cypress/videos/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -* -!.gitignore From d8bdb0c2fd60b831451b5f017249e63293d94fde Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 12:22:48 +1100 Subject: [PATCH 02/33] Product API Docs --- openapi/api-docs.yaml | 1022 ++++++++++++++++++----------------- openapi/paths.yaml | 410 +------------- openapi/paths/clients.yaml | 17 +- openapi/paths/products.yaml | 409 ++++++++++++++ 4 files changed, 945 insertions(+), 913 deletions(-) create mode 100644 openapi/paths/products.yaml diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 610cdeb68639..70020b625e5c 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -6864,415 +6864,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' - /api/v1/products: - get: - tags: - - products - summary: 'Gets a list of products' - description: "Lists products, 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 products, these are handled by the ProductFilters class which defines the methods available" - operationId: getProducts - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'A list of products' - 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - post: - tags: - - products - summary: 'Adds a Product' - description: 'Adds an Product to the system' - operationId: storeProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'Returns the saved Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /api/v1/products/create: - get: - tags: - - products - summary: 'Gets a new blank Product object' - description: 'Returns a blank object with default values' - operationId: getProductsCreate - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'A blank Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}': - get: - tags: - - products - summary: 'Shows an Product' - description: 'Displays an Product by id' - operationId: showProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - put: - tags: - - products - summary: 'Updates an Product' - description: 'Handles the updating of an Product by id' - operationId: updateProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - delete: - tags: - - products - summary: 'Deletes a Product' - description: 'Handles the deletion of an Product by id' - operationId: deleteProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product 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' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/edit': - get: - tags: - - products - summary: 'Shows an Product for editting' - description: 'Displays an Product by id' - operationId: editProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /api/v1/products/bulk: - post: - tags: - - products - summary: 'Performs bulk actions on an array of products' - description: '' - operationId: bulkProducts - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' - requestBody: - description: 'Hashed IDs' - required: true - content: - application/json: - schema: - type: array - items: - description: 'Array of hashed IDs to be bulk ''actioned' - type: integer - example: '[0,1,2,3]' - responses: - 200: - description: 'The Product response' - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' - X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' - X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' - content: - application/json: - schema: - $ref: '#/components/schemas/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/upload': - put: - tags: - - products - summary: 'Uploads a document to a product' - description: 'Handles the uploading of a document to a product' - operationId: uploadProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + /api/v1/projects: get: tags: @@ -14296,6 +13888,415 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' + /api/v1/products: + get: + tags: + - products + summary: 'List products' + description: "Lists products, 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 products, these are handled by the ProductFilters class which defines the methods available" + operationId: getProducts + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + responses: + 200: + description: 'A list of products' + 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + post: + tags: + - products + summary: 'Create Product' + description: 'Adds an Product to the system' + operationId: storeProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + responses: + 200: + description: 'Returns the saved Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + /api/v1/products/create: + get: + tags: + - products + summary: 'Create product' + description: 'Returns a blank object with default values' + operationId: getProductsCreate + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + responses: + 200: + description: 'A blank Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '/api/v1/products/{id}': + get: + tags: + - products + summary: 'Show product' + description: 'Displays an Product by id' + operationId: showProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + put: + tags: + - products + summary: 'Update product' + description: 'Handles the updating of an Product by id' + operationId: updateProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + delete: + tags: + - products + summary: 'Delete product' + description: 'Handles the deletion of an Product by id' + operationId: deleteProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product 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' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '/api/v1/products/{id}/edit': + get: + tags: + - products + summary: 'Show product' + description: 'Displays an Product by id' + operationId: editProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + /api/v1/products/bulk: + post: + tags: + - products + summary: 'Bulk product actions' + description: '' + operationId: bulkProducts + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/index' + requestBody: + description: 'Hashed IDs' + required: true + content: + application/json: + schema: + type: array + items: + description: 'Array of hashed IDs to be bulk ''actioned' + type: integer + example: '[0,1,2,3]' + responses: + 200: + description: 'The Product response' + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '/api/v1/products/{id}/upload': + put: + tags: + - products + summary: 'Add product document' + description: 'Handles the uploading of a document to a product' + operationId: uploadProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' /api/v1/clients: get: tags: @@ -14825,7 +14826,7 @@ paths: tags: - clients summary: 'Add client document' - description: 'Handles the uploading of a document to a client' + description: 'Handles the uploading of a document to a client, please note due to a quirk in REST you will need to use a _method parameter with value of POST' operationId: uploadClient parameters: - @@ -14843,6 +14844,21 @@ paths: type: string format: string example: D2J234DFA + produces: + - application/json + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + _method: + type: string + example: POST + documents: + type: array + format: binary responses: 200: description: 'Returns the client object' @@ -19139,99 +19155,6 @@ components: type: string example: JSON type: object - Activity: - properties: - id: - description: 'The id field of the activity' - type: string - example: Opnel5aKBz - activity_type_id: - description: 'The activity type id' - type: string - example: Opnel5aKBz - client_id: - description: 'The client hashed id' - type: string - example: Opnel5aKBz - company_id: - description: 'The company hashed id' - type: string - example: Opnel5aKBz - user_id: - description: 'The user hashed id' - type: string - example: Opnel5aKBz - invoice_id: - description: 'The invoice hashed id' - type: string - example: Opnel5aKBz - payment_id: - description: 'The payment hashed id' - type: string - example: Opnel5aKBz - credit_id: - description: 'The credit hashed id' - type: string - example: Opnel5aKBz - updated_at: - description: 'Unixtimestamp the last time the record was updated' - type: integer - example: '343421434' - expense_id: - description: 'The expense hashed id' - type: string - example: Opnel5aKBz - is_system: - description: 'Defines is the activity was performed by the system' - type: boolean - example: true - contact_id: - description: 'The contact hashed id' - type: string - example: Opnel5aKBz - task_id: - description: 'The task hashed id' - type: string - example: Opnel5aKBz - notes: - description: 'Activity Notes' - type: string - example: Opnel5aKBz - token_id: - description: 'The hashed ID of the token who performed the action' - type: string - example: Opnel5aKBz - ip: - description: 'The IP Address of the user who performed the action' - type: string - example: 192.168.1.252 - user: - $ref: '#/components/schemas/User' - client: - $ref: '#/components/schemas/Client' - contact: - $ref: '#/components/schemas/ClientContact' - recurring_invoice: - $ref: '#/components/schemas/RecurringInvoice' - invoice: - $ref: '#/components/schemas/Invoice' - credit: - $ref: '#/components/schemas/Credit' - quote: - $ref: '#/components/schemas/Quote' - payment: - $ref: '#/components/schemas/Payment' - expense: - $ref: '#/components/schemas/Expense' - task: - $ref: '#/components/schemas/Task' - purchase_order: - $ref: '#/components/schemas/PurchaseOrder' - vendor: - $ref: '#/components/schemas/Vendor' - vendor_contact: - $ref: '#/components/schemas/VendorContact' - type: object BankTransaction: properties: id: @@ -19334,6 +19257,99 @@ components: type: string example: USD type: object + Activity: + properties: + id: + description: 'The id field of the activity' + type: string + example: Opnel5aKBz + activity_type_id: + description: 'The activity type id' + type: string + example: Opnel5aKBz + client_id: + description: 'The client hashed id' + type: string + example: Opnel5aKBz + company_id: + description: 'The company hashed id' + type: string + example: Opnel5aKBz + user_id: + description: 'The user hashed id' + type: string + example: Opnel5aKBz + invoice_id: + description: 'The invoice hashed id' + type: string + example: Opnel5aKBz + payment_id: + description: 'The payment hashed id' + type: string + example: Opnel5aKBz + credit_id: + description: 'The credit hashed id' + type: string + example: Opnel5aKBz + updated_at: + description: 'Unixtimestamp the last time the record was updated' + type: integer + example: '343421434' + expense_id: + description: 'The expense hashed id' + type: string + example: Opnel5aKBz + is_system: + description: 'Defines is the activity was performed by the system' + type: boolean + example: true + contact_id: + description: 'The contact hashed id' + type: string + example: Opnel5aKBz + task_id: + description: 'The task hashed id' + type: string + example: Opnel5aKBz + notes: + description: 'Activity Notes' + type: string + example: Opnel5aKBz + token_id: + description: 'The hashed ID of the token who performed the action' + type: string + example: Opnel5aKBz + ip: + description: 'The IP Address of the user who performed the action' + type: string + example: 192.168.1.252 + user: + $ref: '#/components/schemas/User' + client: + $ref: '#/components/schemas/Client' + contact: + $ref: '#/components/schemas/ClientContact' + recurring_invoice: + $ref: '#/components/schemas/RecurringInvoice' + invoice: + $ref: '#/components/schemas/Invoice' + credit: + $ref: '#/components/schemas/Credit' + quote: + $ref: '#/components/schemas/Quote' + payment: + $ref: '#/components/schemas/Payment' + expense: + $ref: '#/components/schemas/Expense' + task: + $ref: '#/components/schemas/Task' + purchase_order: + $ref: '#/components/schemas/PurchaseOrder' + vendor: + $ref: '#/components/schemas/Vendor' + vendor_contact: + $ref: '#/components/schemas/VendorContact' + type: object BTRules: properties: data_key: diff --git a/openapi/paths.yaml b/openapi/paths.yaml index dde3fb5d2f2f..382a4cf1cdee 100644 --- a/openapi/paths.yaml +++ b/openapi/paths.yaml @@ -6840,415 +6840,7 @@ paths: application/json: schema: $ref: '#/components/schemas/Error' - /api/v1/products: - get: - tags: - - products - summary: 'Gets a list of products' - description: "Lists products, 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 products, these are handled by the ProductFilters class which defines the methods available" - operationId: getProducts - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'A list of products' - 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - post: - tags: - - products - summary: 'Adds a Product' - description: 'Adds an Product to the system' - operationId: storeProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'Returns the saved Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /api/v1/products/create: - get: - tags: - - products - summary: 'Gets a new blank Product object' - description: 'Returns a blank object with default values' - operationId: getProductsCreate - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'A blank Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}': - get: - tags: - - products - summary: 'Shows an Product' - description: 'Displays an Product by id' - operationId: showProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - put: - tags: - - products - summary: 'Updates an Product' - description: 'Handles the updating of an Product by id' - operationId: updateProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - delete: - tags: - - products - summary: 'Deletes a Product' - description: 'Handles the deletion of an Product by id' - operationId: deleteProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product 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' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/edit': - get: - tags: - - products - summary: 'Shows an Product for editting' - description: 'Displays an Product by id' - operationId: editProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - /api/v1/products/bulk: - post: - tags: - - products - summary: 'Performs bulk actions on an array of products' - description: '' - operationId: bulkProducts - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' - requestBody: - description: 'Hashed IDs' - required: true - content: - application/json: - schema: - type: array - items: - description: 'Array of hashed IDs to be bulk ''actioned' - type: integer - example: '[0,1,2,3]' - responses: - 200: - description: 'The Product response' - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' - X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' - X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' - content: - application/json: - schema: - $ref: '#/components/schemas/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/upload': - put: - tags: - - products - summary: 'Uploads a document to a product' - description: 'Handles the uploading of a document to a product' - operationId: uploadProduct - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id - in: path - description: 'The Product Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + /api/v1/projects: get: tags: diff --git a/openapi/paths/clients.yaml b/openapi/paths/clients.yaml index 5249c95f18e9..41f50989853f 100644 --- a/openapi/paths/clients.yaml +++ b/openapi/paths/clients.yaml @@ -527,7 +527,7 @@ tags: - clients summary: 'Add client document' - description: 'Handles the uploading of a document to a client' + description: 'Handles the uploading of a document to a client, please note due to a quirk in REST you will need to use a _method parameter with value of POST' operationId: uploadClient parameters: - @@ -545,6 +545,21 @@ type: string format: string example: D2J234DFA + produces: + - application/json + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + _method: + type: string + example: POST + documents: + type: array + format: binary responses: 200: description: 'Returns the client object' diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml new file mode 100644 index 000000000000..853c285b91c6 --- /dev/null +++ b/openapi/paths/products.yaml @@ -0,0 +1,409 @@ + /api/v1/products: + get: + tags: + - products + summary: 'List products' + description: "Lists products, 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 products, these are handled by the ProductFilters class which defines the methods available" + operationId: getProducts + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + responses: + 200: + description: 'A list of products' + 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + post: + tags: + - products + summary: 'Create Product' + description: 'Adds an Product to the system' + operationId: storeProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + responses: + 200: + description: 'Returns the saved Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + /api/v1/products/create: + get: + tags: + - products + summary: 'Create product' + description: 'Returns a blank object with default values' + operationId: getProductsCreate + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + responses: + 200: + description: 'A blank Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '/api/v1/products/{id}': + get: + tags: + - products + summary: 'Show product' + description: 'Displays an Product by id' + operationId: showProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + put: + tags: + - products + summary: 'Update product' + description: 'Handles the updating of an Product by id' + operationId: updateProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + delete: + tags: + - products + summary: 'Delete product' + description: 'Handles the deletion of an Product by id' + operationId: deleteProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product 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' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '/api/v1/products/{id}/edit': + get: + tags: + - products + summary: 'Show product' + description: 'Displays an Product by id' + operationId: editProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + /api/v1/products/bulk: + post: + tags: + - products + summary: 'Bulk product actions' + description: '' + operationId: bulkProducts + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/index' + requestBody: + description: 'Hashed IDs' + required: true + content: + application/json: + schema: + type: array + items: + description: 'Array of hashed IDs to be bulk ''actioned' + type: integer + example: '[0,1,2,3]' + responses: + 200: + description: 'The Product response' + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' + content: + application/json: + schema: + $ref: '#/components/schemas/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + '/api/v1/products/{id}/upload': + put: + tags: + - products + summary: 'Add product document' + description: 'Handles the uploading of a document to a product' + operationId: uploadProduct + parameters: + - + $ref: '#/components/parameters/X-API-TOKEN' + - + $ref: '#/components/parameters/X-Requested-With' + - + $ref: '#/components/parameters/include' + - + name: id + in: path + description: 'The Product Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the Product 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/Product' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' \ No newline at end of file From e97b69d55c5b30c0eb2d459f242bfa498c9a2899 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 12:24:45 +1100 Subject: [PATCH 03/33] Product API Docs --- openapi/paths/products.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index 853c285b91c6..a93b65a9a593 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -262,7 +262,7 @@ get: tags: - products - summary: 'Show product' + summary: 'Edit product' description: 'Displays an Product by id' operationId: editProduct parameters: From 9f997e9bc4ef50e636e11114a003c74c88c0fbe3 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 14:21:42 +1100 Subject: [PATCH 04/33] add responses into components --- openapi/api-docs.yaml | 11518 +++++++++----------- openapi/components/responses/401.yaml | 5 + openapi/components/responses/403.yaml | 5 + openapi/components/responses/404.yaml | 0 openapi/components/responses/422.yaml | 5 + openapi/components/responses/default.yaml | 5 + openapi/misc/misc.yaml | 30 +- openapi/paths.yaml | 10554 ++++++++---------- openapi/paths/clients.yaml | 455 +- openapi/paths/products.yaml | 477 +- 10 files changed, 10430 insertions(+), 12624 deletions(-) create mode 100644 openapi/components/responses/401.yaml create mode 100644 openapi/components/responses/403.yaml create mode 100644 openapi/components/responses/404.yaml create mode 100644 openapi/components/responses/422.yaml create mode 100644 openapi/components/responses/default.yaml diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 70020b625e5c..8cc1473948d5 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -27,25 +27,19 @@ paths: get: tags: - actvities - summary: 'Returns a list of actvities' - description: 'Lists all activities related to this company' + summary: "Returns a list of actvities" + description: "Lists all activities related to this company" operationId: getActivities parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/activity_include' - - - $ref: '#/components/parameters/index' - - - $ref: '#/components/parameters/per_page_meta' - - - $ref: '#/components/parameters/page_meta' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/activity_include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: - description: 'A list of actvities' + description: 'Returns the client object' headers: X-MINIMUM-CLIENT-VERSION: $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' @@ -56,31 +50,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Activity' - default: - description: 'Unexpected Error' + $ref: '#/components/schemas/Client' + 401: + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/actvities/download_entity/{activity_id}': + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + "/api/v1/actvities/download_entity/{activity_id}": get: tags: - actvities - summary: 'Returns a PDF for the given activity' - description: 'Returns a PDF for the given activity' + summary: "Returns a PDF for the given activity" + description: "Returns a PDF for the given activity" operationId: getActivityHistoricalEntityPdf parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/activity_include' - - - name: activity_id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/activity_include" + - name: activity_id in: path - description: 'The Activity Hashed ID' + description: "The Activity Hashed ID" required: true schema: type: string @@ -88,63 +84,64 @@ paths: example: D2J234DFA responses: 200: - description: 'PDF File' + description: "PDF File" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 404: - description: 'No file exists for the given record' - default: - description: 'Unexpected Error' + description: "No file exists for the given record" + 401: + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + /api/v1/login: post: tags: - login - summary: 'Attempts authentication' - description: 'Returns a CompanyUser object on success' + summary: "Attempts authentication" + description: "Returns a CompanyUser object on success" operationId: postLogin security: - [] parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/login_include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/login_include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: properties: email: - description: 'The users email address.' + description: "The users email address." type: string - example: 'demo@invoiceninja.com' + example: "demo@invoiceninja.com" password: - description: 'The user password. Must meet minimum criteria ~ > 6 characters' + description: "The user password. Must meet minimum criteria ~ > 6 characters" type: string - example: 'Password0' + example: "Password0" type: object responses: 200: - description: 'The Company User response' + description: 'Returns the company user object' headers: X-MINIMUM-CLIENT-VERSION: $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' @@ -155,209 +152,217 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: '#/components/schemas/Client' 401: - description: 'Authentication failure' + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/AuthenticationError' + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/refresh: post: tags: - refresh - summary: 'Refresh data by timestamp' + summary: "Refresh data by timestamp" 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. - operationId: refresh + This endpoint can be used if you only need to access the most recent data from a certain point in time. + operationId: refresh parameters: - - - name: updated_at + - name: updated_at in: query - description: 'The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data.' + description: "The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data." required: true schema: type: number format: integer example: 1676173763 - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: "#/components/schemas/CompanyUser" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/yodlee/refresh: post: tags: - yodlee - summary: 'Yodlee Webhook' - description: 'Webhook endpoint for Yodlee. Used to notify the system that a data point can be updated.' + summary: "Yodlee Webhook" + description: "Webhook endpoint for Yodlee. Used to notify the system that a data point can be updated." operationId: yodleeRefreshWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: '' + description: "" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations: get: tags: - bank_integrations - summary: 'Returns a list of Bank Integrations' - description: 'Lists all bank integrations' + summary: "Returns a list of Bank Integrations" + description: "Lists all bank integrations" operationId: getBankIntegrations parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/bank_integration_include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/bank_integration_include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_integrations - summary: 'Adds a bank_integration' - description: 'Adds an bank_integration to a company' + summary: "Adds a bank_integration" + description: "Adds an bank_integration to a company" operationId: storeBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_integration object' + description: "Returns the saved bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_integrations/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_integrations/{id}": get: tags: - bank_integrations - summary: 'Shows a bank_integration' - description: 'Displays a bank_integration by id' + summary: "Shows a bank_integration" + description: "Displays a bank_integration by id" operationId: showBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -365,47 +370,47 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_integrations - summary: 'Updates a bank_integration' - description: 'Handles the updating of a bank_integration by id' + summary: "Updates a bank_integration" + description: "Handles the updating of a bank_integration by id" operationId: updateBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -413,47 +418,47 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_integrations - summary: 'Deletes a bank_integration' - description: 'Handles the deletion of a bank_integration by id' + summary: "Deletes a bank_integration" + description: "Handles the deletion of a bank_integration by id" operationId: deleteBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -461,44 +466,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_integrations/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_integrations/{id}/edit": get: tags: - bank_integrations - summary: 'Shows a bank_integration for editing' - description: 'Displays a bank_integration by id' + summary: "Shows a bank_integration for editing" + description: "Displays a bank_integration by id" operationId: editBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -506,345 +511,326 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/create: get: tags: - bank_integrations - summary: 'Gets a new blank bank_integration object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_integration object" + description: "Returns a blank object with default values" operationId: getBankIntegrationsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_integration object' + description: "A blank bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/bulk: post: tags: - bank_integrations - summary: 'Performs bulk actions on an array of bank_integrations' - description: '' + summary: "Performs bulk actions on an array of bank_integrations" + description: "" operationId: bulkBankIntegrations parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/refresh_accounts: post: tags: - bank_integrations - summary: 'Gets the list of accounts from the remote server' - description: 'Adds an bank_integration to a company' + summary: "Gets the list of accounts from the remote server" + description: "Adds an bank_integration to a company" operationId: getRefreshAccounts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_integration object' + description: "Returns the saved bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/remove_account/account_id: post: tags: - bank_integrations - summary: 'Removes an account from the integration' - description: 'Removes an account from the integration' + summary: "Removes an account from the integration" + description: "Removes an account from the integration" operationId: getRemoveAccount parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/get_transactions/account_id: post: tags: - bank_integrations - summary: 'Retrieve transactions for a account' - description: 'Retrieve transactions for a account' + summary: "Retrieve transactions for a account" + description: "Retrieve transactions for a account" operationId: getAccountTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Retrieve transactions for a account' + description: "Retrieve transactions for a account" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transactions: get: tags: - bank_transactions - summary: 'Gets a list of bank_transactions' - description: 'Lists all bank integrations' + summary: "Gets a list of bank_transactions" + description: "Lists all bank integrations" operationId: getBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_transactions - summary: 'Adds a bank_transaction' - description: 'Adds an bank_transaction to a company' + summary: "Adds a bank_transaction" + description: "Adds an bank_transaction to a company" operationId: storeBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_transaction object' + description: "Returns the saved bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transactions/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transactions/{id}": get: tags: - bank_transactions - summary: 'Shows a bank_transaction' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction" + description: "Displays a bank_transaction by id" operationId: showBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -852,47 +838,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_transactions - summary: 'Updates a bank_transaction' - description: 'Handles the updating of a bank_transaction by id' + summary: "Updates a bank_transaction" + description: "Handles the updating of a bank_transaction by id" operationId: updateBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -900,47 +882,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_transactions - summary: 'Deletes a bank_transaction' - description: 'Handles the deletion of a bank_transaction by id' + summary: "Deletes a bank_transaction" + description: "Handles the deletion of a bank_transaction by id" operationId: deleteBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -948,44 +926,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transactions/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transactions/{id}/edit": get: tags: - bank_transactions - summary: 'Shows a bank_transaction for editing' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction for editing" + description: "Displays a bank_transaction by id" operationId: editBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -993,272 +967,251 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transactions/create: get: tags: - bank_transactions - summary: 'Gets a new blank bank_transaction object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_transaction object" + description: "Returns a blank object with default values" operationId: getBankTransactionsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_transaction object' + description: "A blank bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transations/bulk: post: tags: - bank_transactions - summary: 'Performs bulk actions on an array of bank_transations' - description: '' + summary: "Performs bulk actions on an array of bank_transations" + description: "" operationId: bulkBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transations/match: post: tags: - bank_transactions - summary: 'Performs match actions on an array of bank_transactions' - description: '' + summary: "Performs match actions on an array of bank_transactions" + description: "" operationId: matchBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transaction_rules: get: tags: - bank_transaction_rules - summary: 'Gets a list of bank_transaction_rules' - description: 'Lists all bank transaction rules' + summary: "Gets a list of bank_transaction_rules" + description: "Lists all bank transaction rules" operationId: getBankTransactionRules parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_transaction_rules - summary: 'Adds a bank_transaction rule' - description: 'Adds an bank_transaction to a company' + summary: "Adds a bank_transaction rule" + description: "Adds an bank_transaction to a company" operationId: storeBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_transaction rule object' + description: "Returns the saved bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transaction_rules/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transaction_rules/{id}": get: tags: - bank_transaction_rules - summary: 'Shows a bank_transaction' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction" + description: "Displays a bank_transaction by id" operationId: showBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction RuleHashed ID' + description: "The Bank Transaction RuleHashed ID" required: true schema: type: string @@ -1266,47 +1219,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_transaction_rules - summary: 'Updates a bank_transaction Rule' - description: 'Handles the updating of a bank_transaction rule by id' + summary: "Updates a bank_transaction Rule" + description: "Handles the updating of a bank_transaction rule by id" operationId: updateBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1314,47 +1263,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_transaction_rules - summary: 'Deletes a bank_transaction rule' - description: 'Handles the deletion of a bank_transaction rule by id' + summary: "Deletes a bank_transaction rule" + description: "Handles the deletion of a bank_transaction rule by id" operationId: deleteBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1362,44 +1307,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transaction_rules/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transaction_rules/{id}/edit": get: tags: - bank_transaction_rules - summary: 'Shows a bank_transaction for editing' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction for editing" + description: "Displays a bank_transaction by id" operationId: editBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1407,264 +1348,242 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transaction_rules/create: get: tags: - bank_transaction_rules - summary: 'Gets a new blank bank_transaction rule object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_transaction rule object" + description: "Returns a blank object with default values" operationId: getBankTransactionRulesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_transaction rule object' + description: "A blank bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transation_rules/bulk: post: tags: - bank_transaction_rules - summary: 'Performs bulk actions on an array of bank_transation rules' - description: '' + summary: "Performs bulk actions on an array of bank_transation rules" + description: "" operationId: bulkBankTransactionRules parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/charts/totals: post: tags: - charts - summary: 'Get chart data' - description: 'Get chart data' + summary: "Get chart data" + description: "Get chart data" operationId: getChartTotals parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The chart' + description: "The chart" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'json dataset of chart data' + description: "json dataset of chart data" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/client_gateway_tokens: get: tags: - client_gateway_tokens - summary: 'List of client tokens' + summary: "List of client tokens" description: "Lists client_gateway_tokens, 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 client_gateway_tokens, these are handled by the ClientGatewayTokenFilters class which defines the methods available" operationId: getClientGatewayTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of client_gateway_tokens' + description: "A list of client_gateway_tokens" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - client_gateway_tokens - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/client_gateway_tokens/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/client_gateway_tokens/{id}": get: tags: - client_gateway_tokens - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1672,47 +1591,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the cl.ient object' + description: "Returns the cl.ient object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - client_gateway_tokens - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1720,47 +1635,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - client_gateway_tokens - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1768,44 +1679,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/client_gateway_tokens/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/client_gateway_tokens/{id}/edit": get: tags: - client_gateway_tokens - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1813,208 +1720,192 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/client_gateway_tokens/create: get: tags: - client_gateway_tokens - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getClientGatewayTokensCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - + $ref: "#/components/schemas/Error" + /api/v1/companies: get: tags: - companies - summary: 'Gets a list of companies' + summary: "Gets a list of companies" description: "Lists companies, 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 companies, these are handled by the CompanyFilters class which defines the methods available" operationId: getCompanies parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of companies' + description: "A list of companies" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - companies - summary: 'Adds a company' - description: 'Adds an company to the system' + summary: "Adds a company" + description: "Adds an company to the system" operationId: storeCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved company object' + description: "Returns the saved company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/companies/create: get: tags: - companies - summary: 'Gets a new blank company object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank company object" + description: "Returns a blank object with default values" operationId: getCompaniesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank company object' + description: "A blank company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}": get: tags: - companies - summary: 'Shows an company' - description: 'Displays an company by id' + summary: "Shows an company" + description: "Displays an company by id" operationId: showCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2022,47 +1913,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - companies - summary: 'Updates an company' - description: 'Handles the updating of an company by id' + summary: "Updates an company" + description: "Handles the updating of an company by id" operationId: updateCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2070,47 +1957,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - companies - summary: 'Deletes a company' - description: 'Handles the deletion of an company by id' + summary: "Deletes a company" + description: "Handles the deletion of an company by id" operationId: deleteCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2118,44 +2001,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}/edit": get: tags: - companies - summary: 'Shows an company for editting' - description: 'Displays an company by id' + summary: "Shows an company for editting" + description: "Displays an company by id" operationId: editCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2163,48 +2042,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}/upload": put: tags: - companies - summary: 'Uploads a document to a company' - description: 'Handles the uploading of a document to a company' + summary: "Uploads a document to a company" + description: "Handles the uploading of a document to a company" operationId: uploadCompanies parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2212,48 +2087,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{company}/default': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{company}/default": post: tags: - companies - summary: 'Sets the company as the default company.' - description: 'Sets the company as the default company.' + summary: "Sets the company as the default company." + description: "Sets the company as the default company." operationId: setDefaultCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2261,167 +2132,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways: get: tags: - company_gateways - summary: 'Gets a list of company_gateways' + summary: "Gets a list of company_gateways" description: "Lists company_gateways, 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 company_gateways, these are handled by the CompanyGatewayFilters class which defines the methods available" operationId: getCompanyGateways parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of company_gateways' + description: "A list of company_gateways" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - company_gateways - summary: 'Adds a CompanyGateway' - description: 'Adds an CompanyGateway to the system' + summary: "Adds a CompanyGateway" + description: "Adds an CompanyGateway to the system" operationId: storeCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved CompanyGateway object' + description: "Returns the saved CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways/create: get: tags: - company_gateways - summary: 'Gets a new blank CompanyGateway object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank CompanyGateway object" + description: "Returns a blank object with default values" operationId: getCompanyGatewaysCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank CompanyGateway object' + description: "A blank CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/company_gateways/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/company_gateways/{id}": get: tags: - company_gateways - summary: 'Shows an CompanyGateway' - description: 'Displays an CompanyGateway by id' + summary: "Shows an CompanyGateway" + description: "Displays an CompanyGateway by id" operationId: showCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2429,47 +2287,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - company_gateways - summary: 'Updates an CompanyGateway' - description: 'Handles the updating of an CompanyGateway by id' + summary: "Updates an CompanyGateway" + description: "Handles the updating of an CompanyGateway by id" operationId: updateCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2477,47 +2331,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - company_gateways - summary: 'Deletes a CompanyGateway' - description: 'Handles the deletion of an CompanyGateway by id' + summary: "Deletes a CompanyGateway" + description: "Handles the deletion of an CompanyGateway by id" operationId: deleteCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2525,44 +2375,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/company_gateways/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/company_gateways/{id}/edit": get: tags: - company_gateways - summary: 'Shows an CompanyGateway for editting' - description: 'Displays an CompanyGateway by id' + summary: "Shows an CompanyGateway for editting" + description: "Displays an CompanyGateway by id" operationId: editCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2570,338 +2416,313 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways/bulk: post: tags: - company_gateways - summary: 'Performs bulk actions on an array of company_gateways' - description: '' + summary: "Performs bulk actions on an array of company_gateways" + description: "" operationId: bulkCompanyGateways parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Array of company gateway IDs' + description: "Array of company gateway IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Company Gateways response' + description: "The Company Gateways response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_ledger: get: tags: - company_ledger - summary: 'Gets a list of company_ledger' - description: 'Lists the company_ledger.' + summary: "Gets a list of company_ledger" + description: "Lists the company_ledger." operationId: getCompanyLedger parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of company_ledger' + description: "A list of company_ledger" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyLedger' + $ref: "#/components/schemas/CompanyLedger" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_users: post: tags: - company_user - summary: 'Update a company user record' - description: 'Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users' + summary: "Update a company user record" + description: "Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users" operationId: updateCompanyUser parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: "#/components/schemas/CompanyUser" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/connected_account: post: tags: - connected_account - summary: 'Connect an oauth user to an existing user' - description: 'Refreshes the dataset' + summary: "Connect an oauth user to an existing user" + description: "Refreshes the dataset" operationId: connected_account parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits: get: tags: - credits - summary: 'Gets a list of credits' + summary: "Gets a list of 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of credits' + description: "A list of credits" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - credits - summary: 'Adds a credit' - description: 'Adds an credit to the system' + summary: "Adds a 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits/create: get: tags: - credits - summary: 'Gets a new blank credit object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank credit object" + 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank credit object' + description: "A blank credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}": get: tags: - credits - summary: 'Shows an credit' - description: 'Displays an credit by id' + summary: "Shows an 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 + - $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' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2909,47 +2730,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit object' + description: "Returns the credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - Credits - summary: 'Updates an Credit' - description: 'Handles the updating of an Credit by id' + summary: "Updates an 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 + - $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' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2957,47 +2774,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Credit object' + description: "Returns the Credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - credits - summary: 'Deletes a credit' - description: 'Handles the deletion of an credit by id' + summary: "Deletes a 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 + - $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' + description: "The Credit Hashed ID" required: true schema: type: string @@ -3005,44 +2818,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}/edit": get: tags: - credits - summary: 'Shows an credit for editting' - description: 'Displays an credit by id' + summary: "Shows an credit for editting" + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -3050,95 +2859,88 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit object' + description: "Returns the credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits/bulk: post: tags: - credits - summary: 'Performs bulk actions on an array of credits' - description: '' + summary: "Performs bulk actions on an array of credits" + description: "" operationId: bulkCredits parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credit/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/credit/{invitation_key}/download": get: tags: - quotes - summary: 'Download a specific credit by invitation key' - description: 'Downloads a specific quote' + summary: "Download a specific credit by invitation key" + 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 + - $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' + description: "The Credit Invitation Key" required: true schema: type: string @@ -3146,44 +2948,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit pdf' + description: "Returns the credit pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}/upload": put: tags: - credits - summary: 'Uploads a document to a credit' - description: 'Handles the uploading of a document to a credit' + summary: "Uploads a document to a credit" + 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 + - $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' + description: "The Credit Hashed ID" required: true schema: type: string @@ -3191,129 +2989,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Credit object' + description: "Returns the Credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs: get: tags: - designs - summary: 'Gets a list of designs' - description: 'Lists designs' + summary: "Gets a list of designs" + description: "Lists designs" operationId: getDesigns parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of designs' + description: "A list of designs" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - designs - summary: 'Adds a design' - description: 'Adds an design to a company' + summary: "Adds a design" + description: "Adds an design to a company" operationId: storeDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved design object' + description: "Returns the saved design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/designs/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/designs/{id}": get: tags: - designs - summary: 'Shows a design' - description: 'Displays a design by id' + summary: "Shows a design" + description: "Displays a design by id" operationId: showDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3321,47 +3108,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - designs - summary: 'Updates a design' - description: 'Handles the updating of a design by id' + summary: "Updates a design" + description: "Handles the updating of a design by id" operationId: updateDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3369,47 +3152,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the design object' + description: "Returns the design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - designs - summary: 'Deletes a design' - description: 'Handles the deletion of a design by id' + summary: "Deletes a design" + description: "Handles the deletion of a design by id" operationId: deleteDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3417,44 +3196,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/designs/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/designs/{id}/edit": get: tags: - designs - summary: 'Shows a design for editting' - description: 'Displays a design by id' + summary: "Shows a design for editting" + description: "Displays a design by id" operationId: editDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3462,194 +3237,183 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the design object' + description: "Returns the design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs/create: get: tags: - designs - summary: 'Gets a new blank design object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank design object" + description: "Returns a blank object with default values" operationId: getDesignsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank design object' + description: "A blank design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs/bulk: post: tags: - designs - summary: 'Performs bulk actions on an array of designs' - description: '' + summary: "Performs bulk actions on an array of designs" + description: "" operationId: bulkDesigns parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Design User response' + description: "The Design User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/documents: get: tags: - documents - summary: 'Gets a list of documents' + summary: "Gets a list of documents" description: "Lists documents, 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 documents, these are handled by the DocumentsFilters class which defines the methods available" operationId: getDocuments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of documents' + description: "A list of documents" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Document' + $ref: "#/components/schemas/Document" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/emails: post: tags: - emails - summary: 'Sends an email for an entity' - description: 'Sends an email for an entity' + summary: "Sends an email for an entity" + description: "Sends an email for an entity" operationId: sendEmailTemplate parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The template subject and body' + description: "The template subject and body" required: true content: application/json: schema: properties: subject: - description: 'The email subject' + description: "The email subject" type: string body: - description: 'The email body' + description: "The email body" type: string entity: - description: 'The entity name' + description: "The entity name" type: string entity_id: - description: 'The entity_id' + description: "The entity_id" type: string template: - description: 'The template required' + description: "The template required" type: string type: object responses: @@ -3657,156 +3421,147 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Template' + $ref: "#/components/schemas/Template" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories: get: tags: - expense_categories - summary: 'Gets a list of expense_categories' - description: 'Lists tax rates' + summary: "Gets a list of expense_categories" + description: "Lists tax rates" operationId: getExpenseCategorys parameters: - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of expense_categories' + description: "A list of expense_categories" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - expense_categories - summary: 'Adds a expense category' - description: 'Adds an expense category to the system' + summary: "Adds a expense category" + description: "Adds an expense category to the system" operationId: storeExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved invoice object' + description: "Returns the saved invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories/create: get: tags: - expense_categories - summary: 'Gets a new blank Expens Category object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Expens Category object" + description: "Returns a blank object with default values" operationId: getExpenseCategoryCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A blank Expens Category object' + description: "A blank Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expense_categories/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/expense_categories/{id}": get: tags: - expense_categories - summary: 'Shows a Expens Category' - description: 'Displays an ExpenseCategory by id' + summary: "Shows a Expens Category" + description: "Displays an ExpenseCategory by id" operationId: showExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3814,45 +3569,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expens Category object' + description: "Returns the Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - expense_categories - summary: 'Updates a tax rate' - description: 'Handles the updating of a tax rate by id' + summary: "Updates a tax rate" + description: "Handles the updating of a tax rate by id" operationId: updateExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3860,45 +3612,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the ExpenseCategory object' + description: "Returns the ExpenseCategory object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - expense_categories - summary: 'Deletes a ExpenseCategory' - description: 'Handles the deletion of an ExpenseCategory by id' + summary: "Deletes a ExpenseCategory" + description: "Handles the deletion of an ExpenseCategory by id" operationId: deleteExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3906,42 +3655,39 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expense_categories/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/expense_categories/{id}/edit": get: tags: - expense_categories - summary: 'Shows a Expens Category for editting' - description: 'Displays a Expens Category by id' + summary: "Shows a Expens Category for editting" + description: "Displays a Expens Category by id" operationId: editExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3949,180 +3695,166 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expens Category object' + description: "Returns the Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories/bulk: post: tags: - expense_categories - summary: 'Performs bulk actions on an array of ExpenseCategorys' - description: '' + summary: "Performs bulk actions on an array of ExpenseCategorys" + description: "" operationId: bulkExpenseCategorys parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Expens Categorys' + description: "Expens Categorys" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The ExpenseCategory List response' + description: "The ExpenseCategory List response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses: get: tags: - expenses - summary: 'Gets a list of expenses' + summary: "Gets a list of expenses" description: "Lists expenses, 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 expenses, these are handled by the ExpenseFilters class which defines the methods available" operationId: getExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of expenses' + description: "A list of expenses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - expenses - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}": get: tags: - expenses - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4130,47 +3862,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - expenses - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4178,47 +3906,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - expenses - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4226,44 +3950,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}/edit": get: tags: - expenses - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4271,139 +3991,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses/create: get: tags: - expenses - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getExpensesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses/bulk: post: tags: - expenses - summary: 'Performs bulk actions on an array of expenses' - description: '' + summary: "Performs bulk actions on an array of expenses" + description: "" operationId: bulkExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Expense User response' + description: "The Expense User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}/upload": put: tags: - expense - summary: 'Uploads a document to a expense' - description: 'Handles the uploading of a document to a expense' + summary: "Uploads a document to a expense" + description: "Handles the uploading of a document to a expense" operationId: uploadExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4411,199 +4121,185 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expense object' + description: "Returns the Expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/export: post: tags: - export - summary: 'Export data from the system' - description: 'Export data from the system' + summary: "Export data from the system" + description: "Export data from the system" operationId: getExport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings: get: tags: - group_settings - summary: 'Gets a list of group_settings' + summary: "Gets a list of group_settings" description: "Lists group_settings, 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 group_settings, these are handled by the GroupSettingFilters class which defines the methods available" operationId: getGroupSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of group_settings' + description: "A list of group_settings" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - group_settings - summary: 'Adds a GroupSetting' - description: 'Adds an GroupSetting to the system' + summary: "Adds a GroupSetting" + description: "Adds an GroupSetting to the system" operationId: storeGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved GroupSetting object' + description: "Returns the saved GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings/create: get: tags: - group_settings - summary: 'Gets a new blank GroupSetting object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank GroupSetting object" + description: "Returns a blank object with default values" operationId: getGroupSettingsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank GroupSetting object' + description: "A blank GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}": get: tags: - group_settings - summary: 'Shows an GroupSetting' - description: 'Displays an GroupSetting by id' + summary: "Shows an GroupSetting" + description: "Displays an GroupSetting by id" operationId: showGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4611,47 +4307,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - group_settings - summary: 'Updates an GroupSetting' - description: 'Handles the updating of an GroupSetting by id' + summary: "Updates an GroupSetting" + description: "Handles the updating of an GroupSetting by id" operationId: updateGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4659,47 +4351,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - group_settings - summary: 'Deletes a GroupSetting' - description: 'Handles the deletion of an GroupSetting by id' + summary: "Deletes a GroupSetting" + description: "Handles the deletion of an GroupSetting by id" operationId: deleteGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4707,44 +4395,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}/edit": get: tags: - group_settings - summary: 'Shows an GroupSetting for editting' - description: 'Displays an GroupSetting by id' + summary: "Shows an GroupSetting for editting" + description: "Displays an GroupSetting by id" operationId: editGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4752,95 +4436,88 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings/bulk: post: tags: - group_settings - summary: 'Performs bulk actions on an array of group_settings' - description: '' + summary: "Performs bulk actions on an array of group_settings" + description: "" operationId: bulkGroupSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'An array of group_settings ids' + description: "An array of group_settings ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}/upload": put: tags: - group_settings - summary: 'Uploads a document to a group setting' - description: 'Handles the uploading of a document to a group setting' + summary: "Uploads a document to a group setting" + description: "Handles the uploading of a document to a group setting" operationId: uploadGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Group Setting Hashed ID' + description: "The Group Setting Hashed ID" required: true schema: type: string @@ -4848,46 +4525,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Group Setting object' + description: "Returns the Group Setting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preimport: post: tags: - imports - summary: 'Pre Import checks - returns a reference to the job and the headers of the CSV' - description: 'Pre Import checks - returns a reference to the job and the headers of the CSV' + summary: "Pre Import checks - returns a reference to the job and the headers of the CSV" + description: "Pre Import checks - returns a reference to the job and the headers of the CSV" operationId: preimport parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The CSV file' + description: "The CSV file" required: true content: multipart/form-data: @@ -4896,273 +4570,253 @@ paths: format: binary responses: 200: - description: 'Returns a reference to the file' + description: "Returns a reference to the file" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/import_json: post: tags: - import - summary: 'Import data from the system' - description: 'Import data from the system' + summary: "Import data from the system" + description: "Import data from the system" operationId: getImportJson parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/apple/confirm_purchase: post: tags: - postmark - summary: 'Processing webhooks from Apple for in app purchases' - description: 'Adds an credit to the system' + summary: "Processing webhooks from Apple for in app purchases" + description: "Adds an credit to the system" operationId: confirmApplePurchase parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/apple/process_webhook: post: tags: - postmark - summary: 'Processing event webhooks from Apple for in purchase / subscription status update' - description: 'Adds an credit to the system' + summary: "Processing event webhooks from Apple for in purchase / subscription status update" + description: "Adds an credit to the system" operationId: processAppleWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices: get: tags: - invoices - summary: 'Gets a list of 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of invoices' + description: "A list of invoices" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - invoices - summary: 'Adds a invoice' - description: 'Adds an invoice to the system' + 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' + - $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' + $ref: "#/components/schemas/FillableInvoice" responses: 200: - description: 'Returns the saved invoice object' + description: "Returns the saved invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/create: get: tags: - invoices - summary: 'Gets a new blank invoice object' - description: 'Returns a blank object with default values' + 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank invoice object' + description: "A blank invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}": get: tags: - invoices - summary: 'Shows an invoice' - description: 'Displays an invoice by id' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5170,47 +4824,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - invoices - summary: 'Updates an invoice' - description: 'Handles the updating of an invoice by id' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5218,47 +4868,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - invoices - summary: 'Deletes a invoice' - description: 'Handles the deletion of an invoice by id' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5266,44 +4912,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/edit": get: tags: - invoices - summary: 'Shows an invoice for editting' - description: 'Displays an invoice by id' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5311,104 +4953,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/bulk: post: tags: - invoices - summary: 'Performs bulk actions on an array of invoices' - description: '' + 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/{action}": get: tags: - invoices - summary: 'Performs a custom action on an invoice' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -5416,48 +5050,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoice/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/invoice/{invitation_key}/download": get: tags: - invoices - summary: 'Download a specific invoice by invitation key' - description: 'Downloads a specific invoice' + 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 + - $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' + description: "The Invoice Invitation Key" required: true schema: type: string @@ -5465,44 +5095,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice pdf' + description: "Returns the invoice pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/delivery_note': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/delivery_note": get: tags: - invoices - summary: 'Download a specific invoice delivery notes' - description: 'Downloads a specific invoice delivery notes' + 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 + - $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' + description: "The Invoice Hahsed Id" required: true schema: type: string @@ -5510,44 +5136,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice delivery note pdf' + description: "Returns the invoice delivery note pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/upload': + $ref: "#/components/schemas/Error" + "/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' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5555,134 +5177,124 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Invoice object' + description: "Returns the Invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/claim_license: get: tags: - claim_license - summary: 'Attempts to claim a white label license' - description: 'Attempts to claim a white label license' + summary: "Attempts to claim a white label license" + description: "Attempts to claim a white label license" operationId: getClaimLicense parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: license_key + - $ref: "#/components/parameters/X-Requested-With" + - name: license_key in: query - description: 'The license hash' + description: "The license hash" required: true schema: type: string format: string example: d87sh-s755s-s7d76-sdsd8 - - - name: product_id + - name: product_id in: query - description: 'The ID of the product purchased.' + description: "The ID of the product purchased." required: true schema: type: string format: string - example: '1' + example: "1" responses: 200: description: Success! headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/logout: post: tags: - logout - summary: 'Gets a list of logout' - description: 'Lists all logout' + summary: "Gets a list of logout" + description: "Lists all logout" operationId: getLogout parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'Success message' + description: "Success message" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/migration/purge/{company}': + $ref: "#/components/schemas/Error" + "/api/v1/migration/purge/{company}": post: tags: - migration - summary: 'Attempts to purge a company record and all its child records' - description: 'Attempts to purge a company record and all its child records' + summary: "Attempts to purge a company record and all its child records" + description: "Attempts to purge a company record and all its child records" operationId: postPurgeCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -5693,39 +5305,36 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/migration/purge_save_settings/{company}': + $ref: "#/components/schemas/Error" + "/api/v1/migration/purge_save_settings/{company}": post: tags: - migration - summary: 'Attempts to purge a companies child records but save the company record and its settings' - description: 'Attempts to purge a companies child records but save the company record and its settings' + summary: "Attempts to purge a companies child records but save the company record and its settings" + description: "Attempts to purge a companies child records but save the company record and its settings" operationId: postPurgeCompanySaveSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -5736,41 +5345,37 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/migration/start: post: tags: - migration - summary: 'Starts the migration from previous version of Invoice Ninja' - description: 'Starts the migration from previous version of Invoice Ninja' + summary: "Starts the migration from previous version of Invoice Ninja" + description: "Starts the migration from previous version of Invoice Ninja" operationId: postStartMigration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/X-API-PASSWORD' - - - name: migration + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/X-API-PASSWORD" + - name: migration in: query - description: 'The migraton file' + description: "The migraton file" required: true schema: type: object @@ -5781,199 +5386,185 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/one_time_token: post: tags: - one_time_token - summary: 'Attempts to create a one time token' - description: 'Attempts to create a one time token' + summary: "Attempts to create a one time token" + description: "Attempts to create a one time token" operationId: oneTimeToken parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments: get: tags: - payments - summary: 'Gets a list of payments' + summary: "Gets a list of payments" description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" operationId: getPayments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of payments' + description: "A list of payments" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - payments - summary: 'Adds a Payment' - description: 'Adds an Payment to the system' + summary: "Adds a Payment" + description: "Adds an Payment to the system" operationId: storePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The payment request' + description: "The payment request" required: true content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/create: get: tags: - payments - summary: 'Gets a new blank Payment object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Payment object" + description: "Returns a blank object with default values" operationId: getPaymentsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Payment object' + description: "A blank Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}": get: tags: - payments - summary: 'Shows an Payment' - description: 'Displays an Payment by id' + summary: "Shows an Payment" + description: "Displays an Payment by id" operationId: showPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -5981,47 +5572,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - payments - summary: 'Updates an Payment' - description: 'Handles the updating of an Payment by id' + summary: "Updates an Payment" + description: "Handles the updating of an Payment by id" operationId: updatePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6029,47 +5616,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - payments - summary: 'Deletes a Payment' - description: 'Handles the deletion of an Payment by id' + summary: "Deletes a Payment" + description: "Handles the deletion of an Payment by id" operationId: deletePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6077,44 +5660,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/edit": get: tags: - payments - summary: 'Shows an Payment for editting' - description: 'Displays an Payment by id' + summary: "Shows an Payment for editting" + description: "Displays an Payment by id" operationId: editPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6122,108 +5701,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/bulk: post: tags: - payments - summary: 'Performs bulk actions on an array of payments' - description: '' + summary: "Performs bulk actions on an array of payments" + description: "" operationId: bulkPayments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Payment response' + description: "The Payment response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/{action}": get: tags: - payments - summary: 'Performs a custom action on an Payment' + summary: "Performs a custom action on an Payment" description: "Performs a custom action on an Payment.\n\n The current range of actions are as follows\n - clone_to_Payment\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -6231,95 +5802,88 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/refund: post: tags: - payments - summary: 'Adds a Refund' - description: 'Adds an Refund to the system' + summary: "Adds a Refund" + description: "Adds an Refund to the system" operationId: storeRefund parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The refund request' + description: "The refund request" required: true content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/upload": put: tags: - payments - summary: 'Uploads a document to a payment' - description: 'Handles the uploading of a document to a payment' + summary: "Uploads a document to a payment" + description: "Handles the uploading of a document to a payment" operationId: uploadPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6327,176 +5891,162 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms: get: tags: - payment_terms - summary: 'Gets a list of payment terms' - description: 'Lists payment terms' + summary: "Gets a list of payment terms" + description: "Lists payment terms" operationId: getPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of payment terms' + description: "A list of payment terms" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - payment_terms - summary: 'Adds a Payment' - description: 'Adds a Payment Term to the system' + summary: "Adds a Payment" + description: "Adds a Payment Term to the system" operationId: storePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The payment_terms request' + description: "The payment_terms request" required: true content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms/create: get: tags: - payment_terms - summary: 'Gets a new blank PaymentTerm object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank PaymentTerm object" + description: "Returns a blank object with default values" operationId: getPaymentTermsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank PaymentTerm object' + description: "A blank PaymentTerm object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payment_terms/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/payment_terms/{id}": get: tags: - payment_terms - summary: 'Shows a Payment Term' - description: 'Displays an Payment Term by id' + summary: "Shows a Payment Term" + description: "Displays an Payment Term by id" operationId: showPaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6504,47 +6054,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment Term object' + description: "Returns the Payment Term object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - payment_terms - summary: 'Updates a Payment Term' - description: 'Handles the updating of an Payment Termby id' + summary: "Updates a Payment Term" + description: "Handles the updating of an Payment Termby id" operationId: updatePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6552,47 +6098,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment Term object' + description: "Returns the Payment Term object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - payment_termss - summary: 'Deletes a Payment Term' - description: 'Handles the deletion of an PaymentTerm by id' + summary: "Deletes a Payment Term" + description: "Handles the deletion of an PaymentTerm by id" operationId: deletePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6600,44 +6142,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payment_terms/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/payment_terms/{id}/edit": get: tags: - payment_terms - summary: 'Shows an Payment Term for editting' - description: 'Displays an Payment Term by id' + summary: "Shows an Payment Term for editting" + description: "Displays an Payment Term by id" operationId: editPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6645,325 +6183,304 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms/bulk: post: tags: - payment_terms - summary: 'Performs bulk actions on an array of payment terms' - description: '' + summary: "Performs bulk actions on an array of payment terms" + description: "" operationId: bulkPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Payment Ter,s' + description: "Payment Ter,s" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Payment Terms response' + description: "The Payment Terms response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/ping: get: tags: - ping - summary: 'Attempts to ping the API' - description: 'Attempts to ping the API' + summary: "Attempts to ping the API" + description: "Attempts to ping the API" operationId: getPing parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The company and user name' + description: "The company and user name" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" /api/v1/health_check: get: tags: - health_check - summary: 'Attempts to get a health check from the API' - description: 'Attempts to get a health check from the API' + summary: "Attempts to get a health check from the API" + description: "Attempts to get a health check from the API" operationId: getHealthCheck parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A key/value map of the system health' + description: "A key/value map of the system health" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" /api/v1/postmark_webhook: post: tags: - postmark - summary: 'Processing webhooks from PostMark' - description: 'Adds an credit to the system' + summary: "Processing webhooks from PostMark" + description: "Adds an credit to the system" operationId: postmarkWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preview: post: tags: - preview - summary: 'Returns a pdf preview' - description: 'Returns a pdf preview.' + summary: "Returns a pdf preview" + description: "Returns a pdf preview." operationId: getPreview parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The pdf response' + description: "The pdf response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preview/purchase_order: post: tags: - preview - summary: 'Returns a pdf preview for purchase order' - description: 'Returns a pdf preview for purchase order.' + summary: "Returns a pdf preview for purchase order" + description: "Returns a pdf preview for purchase order." operationId: getPreviewPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The pdf response' + description: "The pdf response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - + $ref: "#/components/schemas/Error" + /api/v1/projects: get: tags: - projects - summary: 'Gets a list of projects' - description: 'Lists projects' + summary: "Gets a list of projects" + description: "Lists projects" operationId: getProjects parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of projects' + description: "A list of projects" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - projects - summary: 'Adds a project' - description: 'Adds an project to a company' + summary: "Adds a project" + description: "Adds an project to a company" operationId: storeProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved project object' + description: "Returns the saved project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}": get: tags: - projects - summary: 'Shows a project' - description: 'Displays a project by id' + summary: "Shows a project" + description: "Displays a project by id" operationId: showProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -6971,47 +6488,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - projects - summary: 'Updates a project' - description: 'Handles the updating of a project by id' + summary: "Updates a project" + description: "Handles the updating of a project by id" operationId: updateProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7019,47 +6532,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the project object' + description: "Returns the project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - projects - summary: 'Deletes a project' - description: 'Handles the deletion of a project by id' + summary: "Deletes a project" + description: "Handles the deletion of a project by id" operationId: deleteProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7067,44 +6576,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}/edit": get: tags: - projects - summary: 'Shows a project for editting' - description: 'Displays a project by id' + summary: "Shows a project for editting" + description: "Displays a project by id" operationId: editProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7112,139 +6617,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the project object' + description: "Returns the project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/projects/create: get: tags: - projects - summary: 'Gets a new blank project object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank project object" + description: "Returns a blank object with default values" operationId: getProjectsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank project object' + description: "A blank project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/projects/bulk: post: tags: - projects - summary: 'Performs bulk actions on an array of projects' - description: '' + summary: "Performs bulk actions on an array of projects" + description: "" operationId: bulkProjects parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Project User response' + description: "The Project User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}/upload": put: tags: - projects - summary: 'Uploads a document to a project' - description: 'Handles the uploading of a document to a project' + summary: "Uploads a document to a project" + description: "Handles the uploading of a document to a project" operationId: uploadProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7252,167 +6747,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Project object' + description: "Returns the Project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders: get: tags: - purchase_orders - summary: 'Gets a list of purchase orders' + summary: "Gets a list of purchase orders" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" operationId: getPurchaseOrders parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of purchase orders' + description: "A list of purchase orders" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - purhcase_orders - summary: 'Adds a purchase order' - description: 'Adds an purchase order to the system' + summary: "Adds a purchase order" + description: "Adds an purchase order to the system" operationId: storePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved purchase order object' + description: "Returns the saved purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders/create: get: tags: - purchase_orders - summary: 'Gets a new blank purchase order object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank purchase order object" + description: "Returns a blank object with default values" operationId: getPurchaseOrderCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank purchase order object' + description: "A blank purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}": get: tags: - purchase_orders - summary: 'Shows an purcase orders' - description: 'Displays an purchase order by id' + summary: "Shows an purcase orders" + description: "Displays an purchase order by id" operationId: showPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase order Hashed ID' + description: "The Purchase order Hashed ID" required: true schema: type: string @@ -7420,47 +6902,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - purchase_orders - summary: 'Deletes a purchase order' - description: 'Handles the deletion of an purchase orders by id' + summary: "Deletes a purchase order" + description: "Handles the deletion of an purchase orders by id" operationId: deletePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purhcase order Hashed ID' + description: "The purhcase order Hashed ID" required: true schema: type: string @@ -7468,44 +6946,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/edit": get: tags: - purchase_orders - summary: 'Shows an purchase order for editting' - description: 'Displays an purchase order by id' + summary: "Shows an purchase order for editting" + description: "Displays an purchase order by id" operationId: editPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purchase order Hashed ID' + description: "The purchase order Hashed ID" required: true schema: type: string @@ -7513,48 +6987,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_order/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_order/{id}": put: tags: - purchase_orders - summary: 'Updates an purchase order' - description: 'Handles the updating of an purchase order by id' + summary: "Updates an purchase order" + description: "Handles the updating of an purchase order by id" operationId: updatePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purchase order Hashed ID' + description: "The purchase order Hashed ID" required: true schema: type: string @@ -7562,104 +7032,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders/bulk: post: tags: - purchase_orders - summary: 'Performs bulk actions on an array of purchase_orders' - description: '' + summary: "Performs bulk actions on an array of purchase_orders" + description: "" operationId: bulkPurchaseOrderss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Purchase Order IDS' + description: "Purchase Order IDS" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/{action}": get: tags: - purchase_orders - summary: 'Performs a custom action on an purchase order' + summary: "Performs a custom action on an purchase order" description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" operationId: actionPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase Order Hashed ID' + description: "The Purchase Order Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -7667,48 +7129,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/upload": put: tags: - purchase_orders - summary: 'Uploads a document to a purchase_orders' - description: 'Handles the uploading of a document to a purchase_order' + summary: "Uploads a document to a purchase_orders" + description: "Handles the uploading of a document to a purchase_order" operationId: uploadPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase Order Hashed ID' + description: "The Purchase Order Hashed ID" required: true schema: type: string @@ -7716,48 +7174,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Purchase Order object' + description: "Returns the Purchase Order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_order/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_order/{invitation_key}/download": get: tags: - purchase_orders - summary: 'Download a specific purchase order by invitation key' - description: 'Downloads a specific purchase order' + summary: "Download a specific purchase order by invitation key" + description: "Downloads a specific purchase order" operationId: downloadPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Purchase Order Invitation Key' + description: "The Purchase Order Invitation Key" required: true schema: type: string @@ -7765,163 +7219,150 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Purchase Order pdf' + description: "Returns the Purchase Order pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes: get: tags: - quotes - summary: 'Gets a list of quotes' + summary: "Gets a list of quotes" description: "Lists quotes, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the quotes, these are handled by the QuoteFilters class which defines the methods available" operationId: getQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of quotes' + description: "A list of quotes" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - quotes - summary: 'Adds a Quote' - description: 'Adds an Quote to the system' + summary: "Adds a Quote" + description: "Adds an Quote to the system" operationId: storeQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Quote object' + description: "Returns the saved Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes/create: get: tags: - quotes - summary: 'Gets a new blank Quote object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Quote object" + description: "Returns a blank object with default values" operationId: getQuotesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Quote object' + description: "A blank Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}": get: tags: - quotes - summary: 'Shows an Quote' - description: 'Displays an Quote by id' + summary: "Shows an Quote" + description: "Displays an Quote by id" operationId: showQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -7929,47 +7370,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - quotes - summary: 'Updates an Quote' - description: 'Handles the updating of an Quote by id' + summary: "Updates an Quote" + description: "Handles the updating of an Quote by id" operationId: updateQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -7977,47 +7414,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - quotes - summary: 'Deletes a Quote' - description: 'Handles the deletion of an Quote by id' + summary: "Deletes a Quote" + description: "Handles the deletion of an Quote by id" operationId: deleteQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8025,44 +7458,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/edit": get: tags: - quotes - summary: 'Shows an Quote for editting' - description: 'Displays an Quote by id' + summary: "Shows an Quote for editting" + description: "Displays an Quote by id" operationId: editQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8070,108 +7499,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes/bulk: post: tags: - quotes - summary: 'Performs bulk actions on an array of quotes' - description: '' + summary: "Performs bulk actions on an array of quotes" + description: "" operationId: bulkQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Quote response' + description: "The Quote response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/{action}": get: tags: - quotes - summary: 'Performs a custom action on an Quote' + summary: "Performs a custom action on an Quote" description: "Performs a custom action on an Quote.\n\n The current range of actions are as follows\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - convert\n - convert_to_invoice\n - email" operationId: actionQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -8179,48 +7600,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quote/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/quote/{invitation_key}/download": get: tags: - quotes - summary: 'Download a specific quote by invitation key' - description: 'Downloads a specific quote' + summary: "Download a specific quote by invitation key" + description: "Downloads a specific quote" operationId: downloadQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Quote Invitation Key' + description: "The Quote Invitation Key" required: true schema: type: string @@ -8228,44 +7645,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the quote pdf' + description: "Returns the quote pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/upload": put: tags: - quotes - summary: 'Uploads a document to a quote' - description: 'Handles the uploading of a document to a quote' + summary: "Uploads a document to a quote" + description: "Handles the uploading of a document to a quote" operationId: uploadQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8273,129 +7686,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses: get: tags: - recurring_expenses - summary: 'Gets a list of recurring_expenses' + summary: "Gets a list of recurring_expenses" description: "Lists recurring_expenses, 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 recurring_expenses, these are handled by the RecurringExpenseFilters class which defines the methods available" operationId: getRecurringExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of recurring_expenses' + description: "A list of recurring_expenses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_expenses - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}": get: tags: - recurring_expenses - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8403,47 +7805,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the recurring_expense object' + description: "Returns the recurring_expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_expenses - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8451,47 +7849,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_expenses - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8499,44 +7893,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}/edit": get: tags: - recurring_expenses - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8544,139 +7934,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses/create: get: tags: - recurring_expenses - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getRecurringExpensesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses/bulk: post: tags: - recurring_expenses - summary: 'Performs bulk actions on an array of recurring_expenses' - description: '' + summary: "Performs bulk actions on an array of recurring_expenses" + description: "" operationId: bulkRecurringExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringExpense User response' + description: "The RecurringExpense User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}/upload": put: tags: - recurring_expense - summary: 'Uploads a document to a recurring_expense' - description: 'Handles the uploading of a document to a recurring_expense' + summary: "Uploads a document to a recurring_expense" + description: "Handles the uploading of a document to a recurring_expense" operationId: uploadRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8684,167 +8064,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringExpense object' + description: "Returns the RecurringExpense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices: get: tags: - recurring_invoices - summary: 'Gets a list of recurring_invoices' + summary: "Gets a list of recurring_invoices" description: "Lists recurring_invoices, 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 recurring_invoices, these are handled by the RecurringInvoiceFilters class which defines the methods available" operationId: getRecurringInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of recurring_invoices' + description: "A list of recurring_invoices" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_invoices - summary: 'Adds a RecurringInvoice' - description: 'Adds an RecurringInvoice to the system' + summary: "Adds a RecurringInvoice" + description: "Adds an RecurringInvoice to the system" operationId: storeRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved RecurringInvoice object' + description: "Returns the saved RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices/create: get: tags: - recurring_invoices - summary: 'Gets a new blank RecurringInvoice object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank RecurringInvoice object" + description: "Returns a blank object with default values" operationId: getRecurringInvoicesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank RecurringInvoice object' + description: "A blank RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}": get: tags: - recurring_invoices - summary: 'Shows an RecurringInvoice' - description: 'Displays an RecurringInvoice by id' + summary: "Shows an RecurringInvoice" + description: "Displays an RecurringInvoice by id" operationId: showRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8852,47 +8219,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_invoices - summary: 'Updates an RecurringInvoice' - description: 'Handles the updating of an RecurringInvoice by id' + summary: "Updates an RecurringInvoice" + description: "Handles the updating of an RecurringInvoice by id" operationId: updateRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8900,47 +8263,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_invoices - summary: 'Deletes a RecurringInvoice' - description: 'Handles the deletion of an RecurringInvoice by id' + summary: "Deletes a RecurringInvoice" + description: "Handles the deletion of an RecurringInvoice by id" operationId: deleteRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8948,44 +8307,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/edit": get: tags: - recurring_invoices - summary: 'Shows an RecurringInvoice for editting' - description: 'Displays an RecurringInvoice by id' + summary: "Shows an RecurringInvoice for editting" + description: "Displays an RecurringInvoice by id" operationId: editRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8993,48 +8348,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoice/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: - invoices - summary: 'Download a specific invoice by invitation key' - description: 'Downloads a specific invoice' + summary: "Download a specific invoice by invitation key" + description: "Downloads a specific invoice" operationId: downloadRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Recurring Invoice Invitation Key' + description: "The Recurring Invoice Invitation Key" required: true schema: type: string @@ -9042,104 +8393,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the recurring invoice pdf' + description: "Returns the recurring invoice pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices/bulk: post: tags: - recurring_invoices - summary: 'Performs bulk actions on an array of recurring_invoices' - description: '' + summary: "Performs bulk actions on an array of recurring_invoices" + description: "" operationId: bulkRecurringInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed IDs' + description: "Hashed IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringInvoice response' + description: "The RecurringInvoice response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/{action}": get: tags: - recurring_invoices - summary: 'Performs a custom action on an RecurringInvoice' + summary: "Performs a custom action on an RecurringInvoice" description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -9147,48 +8490,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/upload": put: tags: - recurring_invoices - summary: 'Uploads a document to a recurring_invoice' - description: 'Handles the uploading of a document to a recurring_invoice' + summary: "Uploads a document to a recurring_invoice" + description: "Handles the uploading of a document to a recurring_invoice" operationId: uploadRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -9196,167 +8535,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes: get: tags: - recurring_quotes - summary: 'Gets a list of recurring_quotes' + summary: "Gets a list of recurring_quotes" description: "Lists recurring_quotes, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the recurring_quotes, these are handled by the RecurringQuoteFilters class which defines the methods available" operationId: getRecurringQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of recurring_quotes' + description: "A list of recurring_quotes" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_quotes - summary: 'Adds a RecurringQuote' - description: 'Adds an RecurringQuote to the system' + summary: "Adds a RecurringQuote" + description: "Adds an RecurringQuote to the system" operationId: storeRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved RecurringQuote object' + description: "Returns the saved RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes/create: get: tags: - recurring_quotes - summary: 'Gets a new blank RecurringQuote object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank RecurringQuote object" + description: "Returns a blank object with default values" operationId: getRecurringQuotesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank RecurringQuote object' + description: "A blank RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}": get: tags: - recurring_quotes - summary: 'Shows an RecurringQuote' - description: 'Displays an RecurringQuote by id' + summary: "Shows an RecurringQuote" + description: "Displays an RecurringQuote by id" operationId: showRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9364,47 +8690,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_quotes - summary: 'Updates an RecurringQuote' - description: 'Handles the updating of an RecurringQuote by id' + summary: "Updates an RecurringQuote" + description: "Handles the updating of an RecurringQuote by id" operationId: updateRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9412,47 +8734,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_quotes - summary: 'Deletes a RecurringQuote' - description: 'Handles the deletion of an RecurringQuote by id' + summary: "Deletes a RecurringQuote" + description: "Handles the deletion of an RecurringQuote by id" operationId: deleteRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9460,44 +8778,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}/edit": get: tags: - recurring_quotes - summary: 'Shows an RecurringQuote for editting' - description: 'Displays an RecurringQuote by id' + summary: "Shows an RecurringQuote for editting" + description: "Displays an RecurringQuote by id" operationId: editRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9505,108 +8819,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes/bulk: post: tags: - recurring_quotes - summary: 'Performs bulk actions on an array of recurring_quotes' - description: '' + summary: "Performs bulk actions on an array of recurring_quotes" + description: "" operationId: bulkRecurringQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringQuote response' + description: "The RecurringQuote response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}/{action}": get: tags: - recurring_quotes - summary: 'Performs a custom action on an RecurringQuote' + summary: "Performs a custom action on an RecurringQuote" description: "Performs a custom action on an RecurringQuote.\n\n The current range of actions are as follows\n - clone_to_RecurringQuote\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -9614,804 +8920,769 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/contacts: post: tags: - reports - summary: 'Contact reports' - description: 'Export contact reports' + summary: "Contact reports" + description: "Export contact reports" operationId: getContactReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/clients: post: tags: - reports - summary: 'Client reports' - description: 'Export client reports' + summary: "Client reports" + description: "Export client reports" operationId: getClientReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/credit: post: tags: - reports - summary: 'Credit reports' - description: 'Export credit reports' + summary: "Credit reports" + description: "Export credit reports" operationId: getCreditReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/documents: post: tags: - reports - summary: 'Document reports' - description: 'Export document reports' + summary: "Document reports" + description: "Export document reports" operationId: getDocumentReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/expense: post: tags: - reports - summary: 'Expense reports' - description: 'Export expense reports' + summary: "Expense reports" + description: "Export expense reports" operationId: getExpenseReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/invoice_items: post: tags: - reports - summary: 'Invoice item reports' - description: 'Export invoice item reports' + summary: "Invoice item reports" + description: "Export invoice item reports" operationId: getInvoiceItemReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/invoices: post: tags: - reports - summary: 'Invoice reports' - description: 'Export invoice reports' + summary: "Invoice reports" + description: "Export invoice reports" operationId: getInvoiceReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/payments: post: tags: - reports - summary: 'Payment reports' - description: 'Export payment reports' + summary: "Payment reports" + description: "Export payment reports" operationId: getPaymentReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/products: post: tags: - reports - summary: 'Product reports' - description: 'Export product reports' + summary: "Product reports" + description: "Export product reports" operationId: getProductReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/product_sales: post: tags: - reports - summary: 'Product Salesreports' - description: 'Export product sales reports' + summary: "Product Salesreports" + description: "Export product sales reports" operationId: getProductSalesReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/profitloss: post: tags: - reports - summary: 'Profit loss reports' - description: 'Profit loss report' + summary: "Profit loss reports" + description: "Profit loss report" operationId: getProfitLossReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/quote_items: post: tags: - reports - summary: 'Quote item reports' - description: 'Export Quote item reports' + summary: "Quote item reports" + description: "Export Quote item reports" operationId: getQuoteItemReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/quotes: post: tags: - reports - summary: 'Quote reports' - description: 'Export quote reports' + summary: "Quote reports" + description: "Export quote reports" operationId: getQuoteReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/recurring_invoices: post: tags: - reports - summary: 'Recurring Invoice reports' - description: 'Export recurring invoice reports' + summary: "Recurring Invoice reports" + description: "Export recurring invoice reports" operationId: getRecurringInvoiceReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/tasks: post: tags: - reports - summary: 'Task reports' - description: 'Export task reports' + summary: "Task reports" + description: "Export task reports" operationId: getTaskReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/self-update: post: tags: - update - summary: 'Performs a system update' - description: 'Performs a system update' + summary: "Performs a system update" + description: "Performs a system update" operationId: selfUpdate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-API-PASSWORD' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-API-PASSWORD" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Success/failure response' + description: "Success/failure response" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/statics: get: tags: - statics - summary: 'Gets a list of statics' - description: 'Lists all statics' + summary: "Gets a list of statics" + description: "Lists all statics" operationId: getStatics parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of static data' + description: "A list of static data" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions: get: tags: - subscriptions - summary: 'Gets a list of subscriptions' - description: 'Lists subscriptions.' + summary: "Gets a list of subscriptions" + description: "Lists subscriptions." operationId: getSubscriptions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of subscriptions' + description: "A list of subscriptions" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - subscriptions - summary: 'Adds a subscriptions' - description: 'Adds an subscriptions to the system' + summary: "Adds a subscriptions" + description: "Adds an subscriptions to the system" operationId: storeSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved subscriptions object' + description: "Returns the saved subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions/create: get: tags: - subscriptions - summary: 'Gets a new blank subscriptions object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank subscriptions object" + description: "Returns a blank object with default values" operationId: getSubscriptionsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank subscriptions object' + description: "A blank subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/subscriptions/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/subscriptions/{id}": get: tags: - subscriptions - summary: 'Shows an subscriptions' - description: 'Displays an subscriptions by id' + summary: "Shows an subscriptions" + description: "Displays an subscriptions by id" operationId: showSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10419,47 +9690,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Subscription object' + description: "Returns the Subscription object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - subscriptions - summary: 'Updates an subscriptions' - description: 'Handles the updating of an subscriptions by id' + summary: "Updates an subscriptions" + description: "Handles the updating of an subscriptions by id" operationId: updateSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10467,47 +9734,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the subscriptions object' + description: "Returns the subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - subscriptions - summary: 'Deletes a subscriptions' - description: 'Handles the deletion of an subscriptions by id' + summary: "Deletes a subscriptions" + description: "Handles the deletion of an subscriptions by id" operationId: deleteSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10515,44 +9778,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/subscriptions/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/subscriptions/{id}/edit": get: tags: - subscriptions - summary: 'Shows an subscriptions for editting' - description: 'Displays an subscriptions by id' + summary: "Shows an subscriptions for editting" + description: "Displays an subscriptions by id" operationId: editSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10560,102 +9819,97 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions/bulk: post: tags: - subscriptions - summary: 'Performs bulk actions on an array of subscriptions' - description: '' + summary: "Performs bulk actions on an array of subscriptions" + description: "" operationId: bulkSubscriptions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Subscription response' + description: "The Subscription response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/support/messages/send: post: tags: - support - summary: 'Sends a support message to Invoice Ninja team' - description: 'Allows a user to send a support message to the Invoice Ninja Team' + summary: "Sends a support message to Invoice Ninja team" + description: "Allows a user to send a support message to the Invoice Ninja Team" operationId: supportMessage parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The message' + description: "The message" required: true content: application/json: schema: properties: message: - description: 'The support message' + description: "The support message" type: string type: string responses: @@ -10663,83 +9917,76 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: type: array items: - description: 'Server response' + description: "Server response" type: string example: true default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/system_logs: get: tags: - system_logs - summary: 'Gets a list of system logs' + summary: "Gets a list of system logs" description: "Lists system logs, 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 system logs, these are handled by the SystemLogFilters class which defines the methods available" operationId: getSystemLogs parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of system logs' + description: "A list of system logs" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/SystemLog' + $ref: "#/components/schemas/SystemLog" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/system_logs/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/system_logs/{id}": get: tags: - system_logs - summary: 'Shows a system_logs' - description: 'Displays a system_logs by id' + summary: "Shows a system_logs" + description: "Displays a system_logs by id" operationId: showSystemLogs parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The system_logs Hashed ID' + description: "The system_logs Hashed ID" required: true schema: type: string @@ -10747,129 +9994,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the system_logs object' + description: "Returns the system_logs object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/SystemLog' + $ref: "#/components/schemas/SystemLog" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks: get: tags: - tasks - summary: 'Gets a list of tasks' + summary: "Gets a list of tasks" description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" operationId: getTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tasks' + description: "A list of tasks" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - tasks - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}": get: tags: - tasks - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10877,47 +10113,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the task object' + description: "Returns the task object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tasks - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10925,47 +10157,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tasks - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10973,44 +10201,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}/edit": get: tags: - tasks - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -11018,139 +10242,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/create: get: tags: - tasks - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getTasksCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/bulk: post: tags: - tasks - summary: 'Performs bulk actions on an array of tasks' - description: '' + summary: "Performs bulk actions on an array of tasks" + description: "" operationId: bulkTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Task User response' + description: "The Task User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}/upload": put: tags: - tasks - summary: 'Uploads a document to a task' - description: 'Handles the uploading of a document to a task' + summary: "Uploads a document to a task" + description: "Handles the uploading of a document to a task" operationId: uploadTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -11158,185 +10372,174 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Task object' + description: "Returns the Task object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/stort: post: tags: - tasks - summary: 'Sort tasks on KanBan' - description: 'Sorts tasks after drag and drop on the KanBan.' + summary: "Sort tasks on KanBan" + description: "Sorts tasks after drag and drop on the KanBan." operationId: sortTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns an Ok, 200 HTTP status' + description: "Returns an Ok, 200 HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_schedulers/: get: tags: - task_schedulers - summary: 'Task Scheduler Index' - description: 'Get all schedulers with associated jobs' + summary: "Task Scheduler Index" + description: "Get all schedulers with associated jobs" operationId: getTaskSchedulers parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - task_schedulers - summary: 'Create task scheduler with job ' + summary: "Create task scheduler with job " description: "Create task scheduler with a job (action(job) request should be sent via request also. Example: We want client report to be job which will be run\n * multiple times, we should send the same parameters in the request as we would send if we wanted to get report, see example" operationId: createTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/task_schedulers: get: tags: - task_schedulers - summary: 'Gets a new blank scheduler object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank scheduler object" + description: "Returns a blank object with default values" operationId: getTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank scheduler object' + description: "A blank scheduler object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_schedulers/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/task_schedulers/{id}": get: tags: - task_schedulers - summary: 'Show given scheduler' - description: 'Get scheduler with associated job' + summary: "Show given scheduler" + description: "Get scheduler with associated job" operationId: showTaskScheduler parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11347,32 +10550,29 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - task_schedulers - summary: 'Update task scheduler ' - description: 'Update task scheduler' + summary: "Update task scheduler " + description: "Update task scheduler" operationId: updateTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11383,42 +10583,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - task_schedulers - summary: 'Destroy Task Scheduler' - description: 'Destroy task scheduler and its associated job' + summary: "Destroy Task Scheduler" + description: "Destroy task scheduler and its associated job" operationId: destroyTaskScheduler parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11429,214 +10627,197 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_schedulers/bulk: post: tags: - task_schedulers - summary: 'Performs bulk actions on an array of task_schedulers' - description: '' + summary: "Performs bulk actions on an array of task_schedulers" + description: "" operationId: bulkTaskSchedulerActions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'array of ids' + description: "array of ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaskSchedule response' + description: "The TaskSchedule response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses: get: tags: - task_status - summary: 'Gets a list of task statuses' - description: 'Lists task statuses' + summary: "Gets a list of task statuses" + description: "Lists task statuses" operationId: getTaskStatuses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of task statuses' + description: "A list of task statuses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - task_status - summary: 'Adds a TaskStatus' - description: 'Adds a TaskStatusto the system' + summary: "Adds a TaskStatus" + description: "Adds a TaskStatusto the system" operationId: storeTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The task_status request' + description: "The task_status request" required: true content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" responses: 200: - description: 'Returns the saved TaskStatus object' + description: "Returns the saved TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses/create: get: tags: - task_status - summary: 'Gets a new blank TaskStatus object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank TaskStatus object" + description: "Returns a blank object with default values" operationId: getTaskStatussCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank TaskStatus object' + description: "A blank TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_statuses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/task_statuses/{id}": get: tags: - task_status - summary: 'Shows a TaskStatus Term' - description: 'Displays an TaskStatusby id' + summary: "Shows a TaskStatus Term" + description: "Displays an TaskStatusby id" operationId: showTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11644,47 +10825,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatusobject' + description: "Returns the TaskStatusobject" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - task_status - summary: 'Updates a TaskStatus Term' - description: 'Handles the updating of an TaskStatus Termby id' + summary: "Updates a TaskStatus Term" + description: "Handles the updating of an TaskStatus Termby id" operationId: updateTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11692,47 +10869,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatusobject' + description: "Returns the TaskStatusobject" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - task_statuss - summary: 'Deletes a TaskStatus Term' - description: 'Handles the deletion of an TaskStatus by id' + summary: "Deletes a TaskStatus Term" + description: "Handles the deletion of an TaskStatus by id" operationId: deleteTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11740,44 +10913,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_statuses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/task_statuses/{id}/edit": get: tags: - task_status - summary: 'Shows an TaskStatusfor editting' - description: 'Displays an TaskStatusby id' + summary: "Shows an TaskStatusfor editting" + description: "Displays an TaskStatusby id" operationId: editTaskStatuss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11785,171 +10954,162 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatus object' + description: "Returns the TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses/bulk: post: tags: - task_status - summary: 'Performs bulk actions on an array of task statuses' - description: '' + summary: "Performs bulk actions on an array of task statuses" + description: "" operationId: bulkTaskStatuss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'TaskStatus Ter,s' + description: "TaskStatus Ter,s" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaskStatus Terms response' + description: "The TaskStatus Terms response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates: get: tags: - tax_rates - summary: 'Gets a list of tax_rates' - description: 'Lists tax rates' + summary: "Gets a list of tax_rates" + description: "Lists tax rates" operationId: getTaxRates parameters: - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tax_rates' + description: "A list of tax_rates" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates/create: get: tags: - tax_rates - summary: 'Gets a new blank Tax Rate object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Tax Rate object" + description: "Returns a blank object with default values" operationId: getTaxRateCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A blank Tax Rate object' + description: "A blank Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tax_rates/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tax_rates/{id}": get: tags: - tax_rates - summary: 'Shows a Tax Rate' - description: 'Displays an TaxRate by id' + summary: "Shows a Tax Rate" + description: "Displays an TaxRate by id" operationId: showTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -11957,45 +11117,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Tax Rate object' + description: "Returns the Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tax_rates - summary: 'Updates a tax rate' - description: 'Handles the updating of a tax rate by id' + summary: "Updates a tax rate" + description: "Handles the updating of a tax rate by id" operationId: updateTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12003,45 +11160,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaxRate object' + description: "Returns the TaxRate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tax_rates - summary: 'Deletes a TaxRate' - description: 'Handles the deletion of an TaxRate by id' + summary: "Deletes a TaxRate" + description: "Handles the deletion of an TaxRate by id" operationId: deleteTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12049,42 +11203,39 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tax_rates/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tax_rates/{id}/edit": get: tags: - tax_rates - summary: 'Shows a Tax Rate for editting' - description: 'Displays a Tax Rate by id' + summary: "Shows a Tax Rate for editting" + description: "Displays a Tax Rate by id" operationId: editTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12092,230 +11243,215 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Tax Rate object' + description: "Returns the Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates/bulk: post: tags: - tax_rates - summary: 'Performs bulk actions on an array of TaxRates' - description: '' + summary: "Performs bulk actions on an array of TaxRates" + description: "" operationId: bulkTaxRates parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Tax Rates' + description: "Tax Rates" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaxRate List response' + description: "The TaxRate List response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/templates: post: tags: - templates - summary: 'Returns a entity template with the template variables replaced with the Entities' - description: 'Returns a entity template with the template variables replaced with the Entities' + summary: "Returns a entity template with the template variables replaced with the Entities" + description: "Returns a entity template with the template variables replaced with the Entities" operationId: getShowTemplate parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The template subject and body' + description: "The template subject and body" required: true content: application/json: schema: properties: subject: - description: 'The email template subject' + description: "The email template subject" type: string body: - description: 'The email template body' + description: "The email template body" type: string type: object responses: 200: - description: 'The template response' + description: "The template response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Template' + $ref: "#/components/schemas/Template" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens: get: tags: - tokens - summary: 'Gets a list of company tokens' + summary: "Gets a list of company tokens" description: "Lists company tokens.\n *\n * Query parameters can be added to performed more fine grained filtering of the tokens, these are handled by the TokenFilters class which defines the methods available" operationId: getTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tokens' + description: "A list of tokens" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - tokens - summary: 'Adds a token' - description: 'Adds an token to a company' + summary: "Adds a token" + description: "Adds an token to a company" operationId: storeToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved token object' + description: "Returns the saved token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tokens/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tokens/{id}": get: tags: - tokens - summary: 'Shows a token' - description: 'Displays a token by id' + summary: "Shows a token" + description: "Displays a token by id" operationId: showToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12323,47 +11459,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tokens - summary: 'Updates a token' - description: 'Handles the updating of a token by id' + summary: "Updates a token" + description: "Handles the updating of a token by id" operationId: updateToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12371,47 +11503,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tokens - summary: 'Deletes a token' - description: 'Handles the deletion of a token by id' + summary: "Deletes a token" + description: "Handles the deletion of a token by id" operationId: deleteToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12419,44 +11547,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tokens/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tokens/{id}/edit": get: tags: - tokens - summary: 'Shows a token for editting' - description: 'Displays a token by id' + summary: "Shows a token for editting" + description: "Displays a token by id" operationId: editToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12464,258 +11588,239 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens/create: get: tags: - tokens - summary: 'Gets a new blank token object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank token object" + description: "Returns a blank object with default values" operationId: getTokensCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank token object' + description: "A blank token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens/bulk: post: tags: - tokens - summary: 'Performs bulk actions on an array of tokens' - description: '' + summary: "Performs bulk actions on an array of tokens" + description: "" operationId: bulkTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Token ids' + description: "Token ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Token response' + description: "The Token response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users: get: tags: - users - summary: 'Gets a list of users' + summary: "Gets a list of users" description: "Lists users, 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 users, these are handled by the UserFilters class which defines the methods available" operationId: getUsers parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of users' + description: "A list of users" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - users - summary: 'Adds a User' - description: 'Adds an User to the system' + summary: "Adds a User" + description: "Adds an User to the system" operationId: storeUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved User object' + description: "Returns the saved User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users/create: get: tags: - users - summary: 'Gets a new blank User object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank User object" + description: "Returns a blank object with default values" operationId: getUsersCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank User object' + description: "A blank User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/users/{id}": get: tags: - users - summary: 'Shows an User' - description: 'Displays an User by id' + summary: "Shows an User" + description: "Displays an User by id" operationId: showUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12723,47 +11828,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - users - summary: 'Updates an User' - description: 'Handles the updating of an User by id' + summary: "Updates an User" + description: "Handles the updating of an User by id" operationId: updateUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12771,56 +11872,51 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - users - summary: 'Deletes a User' - description: 'Handles the deletion of an User by id' + summary: "Deletes a User" + description: "Handles the deletion of an User by id" operationId: deleteUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: token_name + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: token_name in: query - description: 'Customized name for the Users API Token' + description: "Customized name for the Users API Token" required: false schema: type: string format: string - example: 'iOS Device 11 iPad' - - - name: id + example: "iOS Device 11 iPad" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12828,44 +11924,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/users/{id}/edit": get: tags: - users - summary: 'Shows an User for editting' - description: 'Displays an User by id' + summary: "Shows an User for editting" + description: "Displays an User by id" operationId: editUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12873,99 +11965,92 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users/bulk: post: tags: - users - summary: 'Performs bulk actions on an array of users' - description: '' + summary: "Performs bulk actions on an array of users" + description: "" operationId: bulkUsers parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The User response' + description: "The User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/detach_from_company': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/detach_from_company": delete: tags: - users - summary: 'Detach an existing user to a company' - description: 'Detach an existing user from a company' + summary: "Detach an existing user to a company" + description: "Detach an existing user from a company" operationId: detachUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -12973,44 +12058,40 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/invite': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/invite": post: tags: - users - summary: 'Reconfirm an existing user to a company' - description: 'Reconfirm an existing user from a company' + summary: "Reconfirm an existing user to a company" + description: "Reconfirm an existing user from a company" operationId: inviteUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -13018,44 +12099,40 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/reconfirm': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/reconfirm": post: tags: - users - summary: 'Reconfirm an existing user to a company' - description: 'Reconfirm an existing user from a company' + summary: "Reconfirm an existing user to a company" + description: "Reconfirm an existing user from a company" operationId: inviteUserReconfirm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -13063,125 +12140,114 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors: get: tags: - vendors - summary: 'Gets a list of vendors' + summary: "Gets a list of vendors" description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" operationId: getVendors parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of vendors' + description: "A list of vendors" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - vendors - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}": get: tags: - vendors - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13189,47 +12255,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the vendor object' + description: "Returns the vendor object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - vendors - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13237,47 +12299,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - vendors - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13285,44 +12343,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}/edit": get: tags: - vendors - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13330,139 +12384,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors/create: get: tags: - vendors - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getVendorsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors/bulk: post: tags: - vendors - summary: 'Performs bulk actions on an array of vendors' - description: '' + summary: "Performs bulk actions on an array of vendors" + description: "" operationId: bulkVendors parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Vendor User response' + description: "The Vendor User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}/upload": put: tags: - vendors - summary: 'Uploads a document to a vendor' - description: 'Handles the uploading of a document to a vendor' + summary: "Uploads a document to a vendor" + description: "Handles the uploading of a document to a vendor" operationId: uploadVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13470,161 +12514,149 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Vendor object' + description: "Returns the Vendor object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webcron: get: tags: - webcron - summary: 'Executes the task scheduler via a webcron service' - description: 'Executes the task scheduler via a webcron service' + summary: "Executes the task scheduler via a webcron service" + description: "Executes the task scheduler via a webcron service" operationId: webcron parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks: get: tags: - webhooks - summary: 'Gets a list of Webhooks' + summary: "Gets a list of Webhooks" description: "Lists Webhooks, 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 Webhooks, these are handled by the WebhookFilters class which defines the methods available" operationId: getWebhooks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of Webhooks' + description: "A list of Webhooks" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - webhooks - summary: 'Adds a Webhook' - description: 'Adds an Webhook to a company' + summary: "Adds a Webhook" + description: "Adds an Webhook to a company" operationId: storeWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Webhook object' + description: "Returns the saved Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/webhooks/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/webhooks/{id}": get: tags: - webhooks - summary: 'Shows a Webhook' - description: 'Displays a Webhook by id' + summary: "Shows a Webhook" + description: "Displays a Webhook by id" operationId: showWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13632,47 +12664,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - webhooks - summary: 'Updates a Webhook' - description: 'Handles the updating of a Webhook by id' + summary: "Updates a Webhook" + description: "Handles the updating of a Webhook by id" operationId: updateWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13680,47 +12708,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - Webhooks - summary: 'Deletes a Webhook' - description: 'Handles the deletion of a Webhook by id' + summary: "Deletes a Webhook" + description: "Handles the deletion of a Webhook by id" operationId: deleteWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13728,44 +12752,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/webhooks/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/webhooks/{id}/edit": get: tags: - webhooks - summary: 'Shows a Webhook for editting' - description: 'Displays a Webhook by id' + summary: "Shows a Webhook for editting" + description: "Displays a Webhook by id" operationId: editWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13773,258 +12793,218 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks/create: get: tags: - webhooks - summary: 'Gets a new blank Webhook object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Webhook object" + description: "Returns a blank object with default values" operationId: getWebhooksCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Webhook object' + description: "A blank Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks/bulk: post: tags: - webhooks - summary: 'Performs bulk actions on an array of Webhooks' - description: '' + summary: "Performs bulk actions on an array of Webhooks" + description: "" operationId: bulkWebhooks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Webhook User response' + description: "The Webhook User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" + /api/v1/products: get: tags: - products - summary: 'List products' - description: "Lists products, 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 products, these are handled by the ProductFilters class which defines the methods available" + summary: "List products" + description: | + Lists products, search and filters allow fine grained lists to be generated. + Query parameters can be added to perform fine grained filtering of the products list, these are handled by the ProductFilters class + which defines the methods available operationId: getProducts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of products' + description: "A list of products" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - products - summary: 'Create Product' - description: 'Adds an Product to the system' + summary: "Create Product" + description: "Adds a product to a company" operationId: storeProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Product object' + description: "Returns the saved product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - /api/v1/products/create: + $ref: "#/components/schemas/Error" + "/api/v1/products/{id}": get: tags: - products - summary: 'Create product' - description: 'Returns a blank object with default values' - operationId: getProductsCreate - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'A blank Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}': - get: - tags: - - products - summary: 'Show product' - description: 'Displays an Product by id' + summary: "Show product" + description: "Displays a product by id" operationId: showProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -14032,47 +13012,55 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - products - summary: 'Update product' - description: 'Handles the updating of an Product by id' + summary: "Update product" + description: "Handles the updating of a product by id" operationId: updateProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -14080,47 +13068,55 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - products - summary: 'Delete product' - description: 'Handles the deletion of an Product by id' + summary: "Delete product" + description: "Handles the deletion of a product by id" operationId: deleteProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -14128,44 +13124,52 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/products/{id}/edit": get: tags: - products - summary: 'Show product' - description: 'Displays an Product by id' + summary: "Edit product" + description: "Displays an Product by id" operationId: editProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -14173,130 +13177,225 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" + "/api/v1/products/create": + get: + tags: + - products + summary: "Blank product" + description: "Returns a blank product object with default values" + operationId: getProductsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank Product 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/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" + 422: + description: "Validation error" + content: + application/json: + schema: + $ref: "#/components/schemas/ValidationError" + default: + description: "Unexpected Error" + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + /api/v1/products/bulk: post: tags: - products - summary: 'Bulk product actions' - description: '' + summary: "Bulk product actions" + description: "Archive / Restore / Delete in bulk" operationId: bulkProducts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed IDs' + description: "Hashed IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Product response' + description: "The Product response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/upload': + $ref: "#/components/schemas/Error" + + "/api/v1/products/{id}/upload": put: tags: - products - summary: 'Add product document' - description: 'Handles the uploading of a document to a product' + summary: "Add product document" + description: "Handles the uploading of a document to a product" operationId: uploadProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/client_include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string format: string example: D2J234DFA - responses: + produces: + - application/json + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + _method: + type: string + example: POST + documents: + type: array + format: binary 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" + /api/v1/clients: get: tags: @@ -14306,72 +13405,60 @@ paths: Lists clients. Fine grained filtering is also available using query parameters. operationId: getClients parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - $ref: '#/components/parameters/index' - - - name: name + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/index' + - name: name in: query description: Filter by client name required: false schema: type: string example: bob - - - name: balance + - name: balance in: query description: Filter by client balance, format uses an operator and value separated by a colon. lt,lte, gt, gte, eq required: false schema: type: string example: lt:10 - - - name: between_balance + - name: between_balance in: query description: Filter between client balances, format uses two values separated by a colon required: false schema: type: string example: 10:100 - - - name: email + - name: email in: query description: Filter by client email required: false schema: type: string example: bob@gmail.com - - - name: id_number + - name: id_number in: query description: Filter by client id_number required: false schema: type: string example: a1039883 - - - name: number + - name: number in: query description: Filter by client number required: false schema: type: string example: a1039883 - - - name: filter + - name: filter in: query description: Filters clients on columns - name, id_number, contact.first_name contact.last_name, contact.email, custom_value1-4 required: false schema: type: string example: a1039883 - - - name: sort + - name: sort in: query description: Returns the list sorted by column in ascending or descending order. required: false @@ -14400,36 +13487,21 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' post: tags: - clients summary: 'Create client' - description: 'Adds an client to a company' + description: 'Adds a client to a company' operationId: storeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' responses: 200: description: 'Returns the saved client object' @@ -14451,23 +13523,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}': get: tags: @@ -14476,74 +13536,10 @@ paths: description: 'Displays a client by id' operationId: showClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id - in: path - description: 'The Client Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the cl.ient 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/Client' - 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' - 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - put: - tags: - - clients - summary: 'Update client' - description: 'Handles the updating of a client by id' - operationId: updateClient - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14572,23 +13568,55 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + $ref: '#/components/responses/default' + put: + tags: + - clients + summary: 'Update client' + description: 'Handles the updating of a client by id' + operationId: updateClient + parameters: + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id + in: path + description: 'The Client Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the client object' + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/schemas/Client' + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' delete: tags: - clients @@ -14596,14 +13624,10 @@ paths: description: 'Handles the deletion of a client by id' operationId: deleteClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14628,23 +13652,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/edit': get: tags: @@ -14653,14 +13665,10 @@ paths: description: 'Displays a client by id' operationId: editClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14689,23 +13697,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/clients/create: get: tags: @@ -14714,12 +13710,9 @@ paths: description: 'Returns a blank object with default values' operationId: getClientsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' responses: 200: description: 'A blank client object' @@ -14741,37 +13734,22 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/clients/bulk: post: tags: - clients - summary: 'Bulk actions' - description: '' + summary: 'Bulk client actions' + description: 'Archive / Restore / Delete in bulk' operationId: bulkClients parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/index' requestBody: description: 'User credentials' required: true @@ -14804,23 +13782,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/upload': put: tags: @@ -14829,14 +13795,10 @@ paths: description: 'Handles the uploading of a document to a client, please note due to a quirk in REST you will need to use a _method parameter with value of POST' operationId: uploadClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14880,23 +13842,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/purge': post: tags: @@ -14905,14 +13855,10 @@ paths: description: 'Handles purging a client' operationId: purgeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14937,23 +13883,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge': post: tags: @@ -14962,14 +13896,10 @@ paths: description: 'Handles merging 2 clients' operationId: mergeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -14977,8 +13907,7 @@ paths: type: string format: string example: D2J234DFA - - - name: mergeable_client_hashed_id + - name: mergeable_client_hashed_id in: path description: 'The Mergeable Client Hashed ID' required: true @@ -15003,23 +13932,11 @@ paths: schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/client_statement: post: tags: @@ -15028,12 +13945,9 @@ paths: description: 'Return a PDF of the client statement' operationId: clientStatement parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/include' requestBody: description: 'Statment Options' required: true @@ -15072,29 +13986,13 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' components: parameters: X-API-SECRET: @@ -19377,27 +18275,23 @@ components: example: true type: object tags: - - - name: login + - name: login description: | - Attempts to authenticate with the API using a email/password combination. + Attempts to authenticate with the API using a email/password combination. externalDocs: - description: 'Find out more' - url: 'https://invoiceninja.github.io' - - - name: clients + description: "Find out more" + url: "https://invoiceninja.github.io" + - name: clients description: | - Endpoint definitions for interacting with clients. - - - name: products + Endpoint definitions for interacting with clients. + - name: products description: | - Endpoint definitions for interacting with products. - - - name: invoices + Endpoint definitions for interacting with products. + - name: invoices description: | - Endpoint definitions for interacting with invoices. + Endpoint definitions for interacting with invoices. externalDocs: - description: 'https://invoiceninja.github.io' - url: 'https://invoiceninja.github.io' + description: "https://invoiceninja.github.io" + url: "https://invoiceninja.github.io" security: - - ApiKeyAuth: [] \ No newline at end of file + - ApiKeyAuth: [] diff --git a/openapi/components/responses/401.yaml b/openapi/components/responses/401.yaml new file mode 100644 index 000000000000..69425b37899f --- /dev/null +++ b/openapi/components/responses/401.yaml @@ -0,0 +1,5 @@ +description: 'Authentication error' +content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' \ No newline at end of file diff --git a/openapi/components/responses/403.yaml b/openapi/components/responses/403.yaml new file mode 100644 index 000000000000..19061bac43d1 --- /dev/null +++ b/openapi/components/responses/403.yaml @@ -0,0 +1,5 @@ +description: 'Authorization error' +content: + application/json: + schema: + $ref: '#components/schemas/AuthorizationError' \ No newline at end of file diff --git a/openapi/components/responses/404.yaml b/openapi/components/responses/404.yaml new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/openapi/components/responses/422.yaml b/openapi/components/responses/422.yaml new file mode 100644 index 000000000000..ef144eae1cd2 --- /dev/null +++ b/openapi/components/responses/422.yaml @@ -0,0 +1,5 @@ +description: 'Validation error' +content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' \ No newline at end of file diff --git a/openapi/components/responses/default.yaml b/openapi/components/responses/default.yaml new file mode 100644 index 000000000000..a3bf73e8979e --- /dev/null +++ b/openapi/components/responses/default.yaml @@ -0,0 +1,5 @@ +description: 'Unexpected Error' +content: + application/json: + schema: + $ref: '#/components/schemas/Error' \ No newline at end of file diff --git a/openapi/misc/misc.yaml b/openapi/misc/misc.yaml index 81e1ea4727be..4fef1ce7a532 100644 --- a/openapi/misc/misc.yaml +++ b/openapi/misc/misc.yaml @@ -1,25 +1,21 @@ tags: - - - name: login + - name: login description: | - Attempts to authenticate with the API using a email/password combination. + Attempts to authenticate with the API using a email/password combination. externalDocs: - description: 'Find out more' - url: 'https://invoiceninja.github.io' - - - name: clients + description: "Find out more" + url: "https://invoiceninja.github.io" + - name: clients description: | - Endpoint definitions for interacting with clients. - - - name: products + Endpoint definitions for interacting with clients. + - name: products description: | - Endpoint definitions for interacting with products. - - - name: invoices + Endpoint definitions for interacting with products. + - name: invoices description: | - Endpoint definitions for interacting with invoices. + Endpoint definitions for interacting with invoices. externalDocs: - description: 'https://invoiceninja.github.io' - url: 'https://invoiceninja.github.io' + description: "https://invoiceninja.github.io" + url: "https://invoiceninja.github.io" security: - - ApiKeyAuth: [] \ No newline at end of file + - ApiKeyAuth: [] diff --git a/openapi/paths.yaml b/openapi/paths.yaml index 382a4cf1cdee..245d6784c4e2 100644 --- a/openapi/paths.yaml +++ b/openapi/paths.yaml @@ -3,25 +3,19 @@ paths: get: tags: - actvities - summary: 'Returns a list of actvities' - description: 'Lists all activities related to this company' + summary: "Returns a list of actvities" + description: "Lists all activities related to this company" operationId: getActivities parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/activity_include' - - - $ref: '#/components/parameters/index' - - - $ref: '#/components/parameters/per_page_meta' - - - $ref: '#/components/parameters/page_meta' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/activity_include" + - $ref: "#/components/parameters/index" + - $ref: "#/components/parameters/per_page_meta" + - $ref: "#/components/parameters/page_meta" responses: 200: - description: 'A list of actvities' + description: 'Returns the client object' headers: X-MINIMUM-CLIENT-VERSION: $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' @@ -32,31 +26,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Activity' - default: - description: 'Unexpected Error' + $ref: '#/components/schemas/Client' + 401: + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/actvities/download_entity/{activity_id}': + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + "/api/v1/actvities/download_entity/{activity_id}": get: tags: - actvities - summary: 'Returns a PDF for the given activity' - description: 'Returns a PDF for the given activity' + summary: "Returns a PDF for the given activity" + description: "Returns a PDF for the given activity" operationId: getActivityHistoricalEntityPdf parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/activity_include' - - - name: activity_id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/activity_include" + - name: activity_id in: path - description: 'The Activity Hashed ID' + description: "The Activity Hashed ID" required: true schema: type: string @@ -64,63 +60,64 @@ paths: example: D2J234DFA responses: 200: - description: 'PDF File' + description: "PDF File" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 404: - description: 'No file exists for the given record' - default: - description: 'Unexpected Error' + description: "No file exists for the given record" + 401: + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + /api/v1/login: post: tags: - login - summary: 'Attempts authentication' - description: 'Returns a CompanyUser object on success' + summary: "Attempts authentication" + description: "Returns a CompanyUser object on success" operationId: postLogin security: - [] parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/login_include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/login_include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: properties: email: - description: 'The users email address.' + description: "The users email address." type: string - example: 'demo@invoiceninja.com' + example: "demo@invoiceninja.com" password: - description: 'The user password. Must meet minimum criteria ~ > 6 characters' + description: "The user password. Must meet minimum criteria ~ > 6 characters" type: string - example: 'Password0' + example: "Password0" type: object responses: 200: - description: 'The Company User response' + description: 'Returns the company user object' headers: X-MINIMUM-CLIENT-VERSION: $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' @@ -131,209 +128,217 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: '#/components/schemas/Client' 401: - description: 'Authentication failure' + description: 'Authentication error' content: application/json: schema: - $ref: '#/components/schemas/AuthenticationError' + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/refresh: post: tags: - refresh - summary: 'Refresh data by timestamp' + summary: "Refresh data by timestamp" 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. - operationId: refresh + This endpoint can be used if you only need to access the most recent data from a certain point in time. + operationId: refresh parameters: - - - name: updated_at + - name: updated_at in: query - description: 'The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data.' + description: "The unix timestamp from which the refreshed data should be sent from, if no value is passed the system will assume you require all data." required: true schema: type: number format: integer example: 1676173763 - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: "#/components/schemas/CompanyUser" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/yodlee/refresh: post: tags: - yodlee - summary: 'Yodlee Webhook' - description: 'Webhook endpoint for Yodlee. Used to notify the system that a data point can be updated.' + summary: "Yodlee Webhook" + description: "Webhook endpoint for Yodlee. Used to notify the system that a data point can be updated." operationId: yodleeRefreshWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: '' + description: "" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations: get: tags: - bank_integrations - summary: 'Returns a list of Bank Integrations' - description: 'Lists all bank integrations' + summary: "Returns a list of Bank Integrations" + description: "Lists all bank integrations" operationId: getBankIntegrations parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/bank_integration_include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/bank_integration_include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_integrations - summary: 'Adds a bank_integration' - description: 'Adds an bank_integration to a company' + summary: "Adds a bank_integration" + description: "Adds an bank_integration to a company" operationId: storeBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_integration object' + description: "Returns the saved bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_integrations/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_integrations/{id}": get: tags: - bank_integrations - summary: 'Shows a bank_integration' - description: 'Displays a bank_integration by id' + summary: "Shows a bank_integration" + description: "Displays a bank_integration by id" operationId: showBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -341,47 +346,47 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_integrations - summary: 'Updates a bank_integration' - description: 'Handles the updating of a bank_integration by id' + summary: "Updates a bank_integration" + description: "Handles the updating of a bank_integration by id" operationId: updateBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -389,47 +394,47 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_integrations - summary: 'Deletes a bank_integration' - description: 'Handles the deletion of a bank_integration by id' + summary: "Deletes a bank_integration" + description: "Handles the deletion of a bank_integration by id" operationId: deleteBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -437,44 +442,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_integrations/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_integrations/{id}/edit": get: tags: - bank_integrations - summary: 'Shows a bank_integration for editing' - description: 'Displays a bank_integration by id' + summary: "Shows a bank_integration for editing" + description: "Displays a bank_integration by id" operationId: editBankIntegration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankIntegration Hashed ID' + description: "The BankIntegration Hashed ID" required: true schema: type: string @@ -482,345 +487,326 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/create: get: tags: - bank_integrations - summary: 'Gets a new blank bank_integration object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_integration object" + description: "Returns a blank object with default values" operationId: getBankIntegrationsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_integration object' + description: "A blank bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/bulk: post: tags: - bank_integrations - summary: 'Performs bulk actions on an array of bank_integrations' - description: '' + summary: "Performs bulk actions on an array of bank_integrations" + description: "" operationId: bulkBankIntegrations parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/refresh_accounts: post: tags: - bank_integrations - summary: 'Gets the list of accounts from the remote server' - description: 'Adds an bank_integration to a company' + summary: "Gets the list of accounts from the remote server" + description: "Adds an bank_integration to a company" operationId: getRefreshAccounts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_integration object' + description: "Returns the saved bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/remove_account/account_id: post: tags: - bank_integrations - summary: 'Removes an account from the integration' - description: 'Removes an account from the integration' + summary: "Removes an account from the integration" + description: "Removes an account from the integration" operationId: getRemoveAccount parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the bank_integration object' + description: "Returns the bank_integration object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_integrations/get_transactions/account_id: post: tags: - bank_integrations - summary: 'Retrieve transactions for a account' - description: 'Retrieve transactions for a account' + summary: "Retrieve transactions for a account" + description: "Retrieve transactions for a account" operationId: getAccountTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Retrieve transactions for a account' + description: "Retrieve transactions for a account" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankIntegration' + $ref: "#/components/schemas/BankIntegration" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transactions: get: tags: - bank_transactions - summary: 'Gets a list of bank_transactions' - description: 'Lists all bank integrations' + summary: "Gets a list of bank_transactions" + description: "Lists all bank integrations" operationId: getBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_transactions - summary: 'Adds a bank_transaction' - description: 'Adds an bank_transaction to a company' + summary: "Adds a bank_transaction" + description: "Adds an bank_transaction to a company" operationId: storeBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_transaction object' + description: "Returns the saved bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transactions/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transactions/{id}": get: tags: - bank_transactions - summary: 'Shows a bank_transaction' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction" + description: "Displays a bank_transaction by id" operationId: showBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -828,47 +814,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_transactions - summary: 'Updates a bank_transaction' - description: 'Handles the updating of a bank_transaction by id' + summary: "Updates a bank_transaction" + description: "Handles the updating of a bank_transaction by id" operationId: updateBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -876,47 +858,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_transactions - summary: 'Deletes a bank_transaction' - description: 'Handles the deletion of a bank_transaction by id' + summary: "Deletes a bank_transaction" + description: "Handles the deletion of a bank_transaction by id" operationId: deleteBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -924,44 +902,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transactions/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transactions/{id}/edit": get: tags: - bank_transactions - summary: 'Shows a bank_transaction for editing' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction for editing" + description: "Displays a bank_transaction by id" operationId: editBankTransaction parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The BankTransaction Hashed ID' + description: "The BankTransaction Hashed ID" required: true schema: type: string @@ -969,272 +943,251 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction object' + description: "Returns the bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transactions/create: get: tags: - bank_transactions - summary: 'Gets a new blank bank_transaction object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_transaction object" + description: "Returns a blank object with default values" operationId: getBankTransactionsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_transaction object' + description: "A blank bank_transaction object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransaction' + $ref: "#/components/schemas/BankTransaction" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transations/bulk: post: tags: - bank_transactions - summary: 'Performs bulk actions on an array of bank_transations' - description: '' + summary: "Performs bulk actions on an array of bank_transations" + description: "" operationId: bulkBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transations/match: post: tags: - bank_transactions - summary: 'Performs match actions on an array of bank_transactions' - description: '' + summary: "Performs match actions on an array of bank_transactions" + description: "" operationId: matchBankTransactions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transaction_rules: get: tags: - bank_transaction_rules - summary: 'Gets a list of bank_transaction_rules' - description: 'Lists all bank transaction rules' + summary: "Gets a list of bank_transaction_rules" + description: "Lists all bank transaction rules" operationId: getBankTransactionRules parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The number of bank integrations to return' + description: "The number of bank integrations to return" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'A list of bank integrations' + description: "A list of bank integrations" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - bank_transaction_rules - summary: 'Adds a bank_transaction rule' - description: 'Adds an bank_transaction to a company' + summary: "Adds a bank_transaction rule" + description: "Adds an bank_transaction to a company" operationId: storeBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved bank_transaction rule object' + description: "Returns the saved bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transaction_rules/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transaction_rules/{id}": get: tags: - bank_transaction_rules - summary: 'Shows a bank_transaction' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction" + description: "Displays a bank_transaction by id" operationId: showBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction RuleHashed ID' + description: "The Bank Transaction RuleHashed ID" required: true schema: type: string @@ -1242,47 +1195,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - bank_transaction_rules - summary: 'Updates a bank_transaction Rule' - description: 'Handles the updating of a bank_transaction rule by id' + summary: "Updates a bank_transaction Rule" + description: "Handles the updating of a bank_transaction rule by id" operationId: updateBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1290,47 +1239,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - bank_transaction_rules - summary: 'Deletes a bank_transaction rule' - description: 'Handles the deletion of a bank_transaction rule by id' + summary: "Deletes a bank_transaction rule" + description: "Handles the deletion of a bank_transaction rule by id" operationId: deleteBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1338,44 +1283,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/bank_transaction_rules/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/bank_transaction_rules/{id}/edit": get: tags: - bank_transaction_rules - summary: 'Shows a bank_transaction for editing' - description: 'Displays a bank_transaction by id' + summary: "Shows a bank_transaction for editing" + description: "Displays a bank_transaction by id" operationId: editBankTransactionRule parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Bank Transaction Rule Hashed ID' + description: "The Bank Transaction Rule Hashed ID" required: true schema: type: string @@ -1383,264 +1324,242 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the bank_transaction rule object' + description: "Returns the bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transaction_rules/create: get: tags: - bank_transaction_rules - summary: 'Gets a new blank bank_transaction rule object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank bank_transaction rule object" + description: "Returns a blank object with default values" operationId: getBankTransactionRulesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank bank_transaction rule object' + description: "A blank bank_transaction rule object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/BankTransactionRule' + $ref: "#/components/schemas/BankTransactionRule" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/bank_transation_rules/bulk: post: tags: - bank_transaction_rules - summary: 'Performs bulk actions on an array of bank_transation rules' - description: '' + summary: "Performs bulk actions on an array of bank_transation rules" + description: "" operationId: bulkBankTransactionRules parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Action paramters' + description: "Action paramters" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/charts/totals: post: tags: - charts - summary: 'Get chart data' - description: 'Get chart data' + summary: "Get chart data" + description: "Get chart data" operationId: getChartTotals parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' - - - name: rows + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + - name: rows in: query - description: 'The chart' + description: "The chart" required: false schema: type: number format: integer - example: '50' + example: "50" responses: 200: - description: 'json dataset of chart data' + description: "json dataset of chart data" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/client_gateway_tokens: get: tags: - client_gateway_tokens - summary: 'List of client tokens' + summary: "List of client tokens" description: "Lists client_gateway_tokens, 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 client_gateway_tokens, these are handled by the ClientGatewayTokenFilters class which defines the methods available" operationId: getClientGatewayTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of client_gateway_tokens' + description: "A list of client_gateway_tokens" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - client_gateway_tokens - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/client_gateway_tokens/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/client_gateway_tokens/{id}": get: tags: - client_gateway_tokens - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1648,47 +1567,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the cl.ient object' + description: "Returns the cl.ient object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - client_gateway_tokens - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1696,47 +1611,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - client_gateway_tokens - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1744,44 +1655,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/client_gateway_tokens/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/client_gateway_tokens/{id}/edit": get: tags: - client_gateway_tokens - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editClientGatewayToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The ClientGatewayToken Hashed ID' + description: "The ClientGatewayToken Hashed ID" required: true schema: type: string @@ -1789,208 +1696,192 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/client_gateway_tokens/create: get: tags: - client_gateway_tokens - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getClientGatewayTokensCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ClientGatewayToken' + $ref: "#/components/schemas/ClientGatewayToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - + $ref: "#/components/schemas/Error" + /api/v1/companies: get: tags: - companies - summary: 'Gets a list of companies' + summary: "Gets a list of companies" description: "Lists companies, 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 companies, these are handled by the CompanyFilters class which defines the methods available" operationId: getCompanies parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of companies' + description: "A list of companies" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - companies - summary: 'Adds a company' - description: 'Adds an company to the system' + summary: "Adds a company" + description: "Adds an company to the system" operationId: storeCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved company object' + description: "Returns the saved company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/companies/create: get: tags: - companies - summary: 'Gets a new blank company object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank company object" + description: "Returns a blank object with default values" operationId: getCompaniesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank company object' + description: "A blank company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}": get: tags: - companies - summary: 'Shows an company' - description: 'Displays an company by id' + summary: "Shows an company" + description: "Displays an company by id" operationId: showCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -1998,47 +1889,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - companies - summary: 'Updates an company' - description: 'Handles the updating of an company by id' + summary: "Updates an company" + description: "Handles the updating of an company by id" operationId: updateCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2046,47 +1933,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - companies - summary: 'Deletes a company' - description: 'Handles the deletion of an company by id' + summary: "Deletes a company" + description: "Handles the deletion of an company by id" operationId: deleteCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2094,44 +1977,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}/edit": get: tags: - companies - summary: 'Shows an company for editting' - description: 'Displays an company by id' + summary: "Shows an company for editting" + description: "Displays an company by id" operationId: editCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2139,48 +2018,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{id}/upload": put: tags: - companies - summary: 'Uploads a document to a company' - description: 'Handles the uploading of a document to a company' + summary: "Uploads a document to a company" + description: "Handles the uploading of a document to a company" operationId: uploadCompanies parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2188,48 +2063,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/companies/{company}/default': + $ref: "#/components/schemas/Error" + "/api/v1/companies/{company}/default": post: tags: - companies - summary: 'Sets the company as the default company.' - description: 'Sets the company as the default company.' + summary: "Sets the company as the default company." + description: "Sets the company as the default company." operationId: setDefaultCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -2237,167 +2108,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the company object' + description: "Returns the company object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Company' + $ref: "#/components/schemas/Company" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways: get: tags: - company_gateways - summary: 'Gets a list of company_gateways' + summary: "Gets a list of company_gateways" description: "Lists company_gateways, 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 company_gateways, these are handled by the CompanyGatewayFilters class which defines the methods available" operationId: getCompanyGateways parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of company_gateways' + description: "A list of company_gateways" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - company_gateways - summary: 'Adds a CompanyGateway' - description: 'Adds an CompanyGateway to the system' + summary: "Adds a CompanyGateway" + description: "Adds an CompanyGateway to the system" operationId: storeCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved CompanyGateway object' + description: "Returns the saved CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways/create: get: tags: - company_gateways - summary: 'Gets a new blank CompanyGateway object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank CompanyGateway object" + description: "Returns a blank object with default values" operationId: getCompanyGatewaysCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank CompanyGateway object' + description: "A blank CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/company_gateways/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/company_gateways/{id}": get: tags: - company_gateways - summary: 'Shows an CompanyGateway' - description: 'Displays an CompanyGateway by id' + summary: "Shows an CompanyGateway" + description: "Displays an CompanyGateway by id" operationId: showCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2405,47 +2263,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - company_gateways - summary: 'Updates an CompanyGateway' - description: 'Handles the updating of an CompanyGateway by id' + summary: "Updates an CompanyGateway" + description: "Handles the updating of an CompanyGateway by id" operationId: updateCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2453,47 +2307,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - company_gateways - summary: 'Deletes a CompanyGateway' - description: 'Handles the deletion of an CompanyGateway by id' + summary: "Deletes a CompanyGateway" + description: "Handles the deletion of an CompanyGateway by id" operationId: deleteCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2501,44 +2351,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/company_gateways/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/company_gateways/{id}/edit": get: tags: - company_gateways - summary: 'Shows an CompanyGateway for editting' - description: 'Displays an CompanyGateway by id' + summary: "Shows an CompanyGateway for editting" + description: "Displays an CompanyGateway by id" operationId: editCompanyGateway parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The CompanyGateway Hashed ID' + description: "The CompanyGateway Hashed ID" required: true schema: type: string @@ -2546,338 +2392,313 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the CompanyGateway object' + description: "Returns the CompanyGateway object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_gateways/bulk: post: tags: - company_gateways - summary: 'Performs bulk actions on an array of company_gateways' - description: '' + summary: "Performs bulk actions on an array of company_gateways" + description: "" operationId: bulkCompanyGateways parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Array of company gateway IDs' + description: "Array of company gateway IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Company Gateways response' + description: "The Company Gateways response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyGateway' + $ref: "#/components/schemas/CompanyGateway" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_ledger: get: tags: - company_ledger - summary: 'Gets a list of company_ledger' - description: 'Lists the company_ledger.' + summary: "Gets a list of company_ledger" + description: "Lists the company_ledger." operationId: getCompanyLedger parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of company_ledger' + description: "A list of company_ledger" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyLedger' + $ref: "#/components/schemas/CompanyLedger" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/company_users: post: tags: - company_user - summary: 'Update a company user record' - description: 'Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users' + summary: "Update a company user record" + description: "Attempts to update a company user record. A company user can modify only their settings fields. Full access for Admin users" operationId: updateCompanyUser parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyUser' + $ref: "#/components/schemas/CompanyUser" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/connected_account: post: tags: - connected_account - summary: 'Connect an oauth user to an existing user' - description: 'Refreshes the dataset' + summary: "Connect an oauth user to an existing user" + description: "Refreshes the dataset" operationId: connected_account parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/include_static' - - - $ref: '#/components/parameters/clear_cache' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/include_static" + - $ref: "#/components/parameters/clear_cache" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits: get: tags: - credits - summary: 'Gets a list of credits' + summary: "Gets a list of 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of credits' + description: "A list of credits" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - credits - summary: 'Adds a credit' - description: 'Adds an credit to the system' + summary: "Adds a 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits/create: get: tags: - credits - summary: 'Gets a new blank credit object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank credit object" + 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank credit object' + description: "A blank credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}": get: tags: - credits - summary: 'Shows an credit' - description: 'Displays an credit by id' + summary: "Shows an 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 + - $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' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2885,47 +2706,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit object' + description: "Returns the credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - Credits - summary: 'Updates an Credit' - description: 'Handles the updating of an Credit by id' + summary: "Updates an 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 + - $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' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2933,47 +2750,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Credit object' + description: "Returns the Credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - credits - summary: 'Deletes a credit' - description: 'Handles the deletion of an credit by id' + summary: "Deletes a 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 + - $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' + description: "The Credit Hashed ID" required: true schema: type: string @@ -2981,44 +2794,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}/edit": get: tags: - credits - summary: 'Shows an credit for editting' - description: 'Displays an credit by id' + summary: "Shows an credit for editting" + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -3026,95 +2835,88 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit object' + description: "Returns the credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/credits/bulk: post: tags: - credits - summary: 'Performs bulk actions on an array of credits' - description: '' + summary: "Performs bulk actions on an array of credits" + description: "" operationId: bulkCredits parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credit/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/credit/{invitation_key}/download": get: tags: - quotes - summary: 'Download a specific credit by invitation key' - description: 'Downloads a specific quote' + summary: "Download a specific credit by invitation key" + 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 + - $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' + description: "The Credit Invitation Key" required: true schema: type: string @@ -3122,44 +2924,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the credit pdf' + description: "Returns the credit pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/credits/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/credits/{id}/upload": put: tags: - credits - summary: 'Uploads a document to a credit' - description: 'Handles the uploading of a document to a credit' + summary: "Uploads a document to a credit" + 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 + - $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' + description: "The Credit Hashed ID" required: true schema: type: string @@ -3167,129 +2965,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Credit object' + description: "Returns the Credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs: get: tags: - designs - summary: 'Gets a list of designs' - description: 'Lists designs' + summary: "Gets a list of designs" + description: "Lists designs" operationId: getDesigns parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of designs' + description: "A list of designs" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - designs - summary: 'Adds a design' - description: 'Adds an design to a company' + summary: "Adds a design" + description: "Adds an design to a company" operationId: storeDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved design object' + description: "Returns the saved design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/designs/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/designs/{id}": get: tags: - designs - summary: 'Shows a design' - description: 'Displays a design by id' + summary: "Shows a design" + description: "Displays a design by id" operationId: showDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3297,47 +3084,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - designs - summary: 'Updates a design' - description: 'Handles the updating of a design by id' + summary: "Updates a design" + description: "Handles the updating of a design by id" operationId: updateDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3345,47 +3128,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the design object' + description: "Returns the design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - designs - summary: 'Deletes a design' - description: 'Handles the deletion of a design by id' + summary: "Deletes a design" + description: "Handles the deletion of a design by id" operationId: deleteDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3393,44 +3172,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/designs/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/designs/{id}/edit": get: tags: - designs - summary: 'Shows a design for editting' - description: 'Displays a design by id' + summary: "Shows a design for editting" + description: "Displays a design by id" operationId: editDesign parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Design Hashed ID' + description: "The Design Hashed ID" required: true schema: type: string @@ -3438,194 +3213,183 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the design object' + description: "Returns the design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs/create: get: tags: - designs - summary: 'Gets a new blank design object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank design object" + description: "Returns a blank object with default values" operationId: getDesignsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank design object' + description: "A blank design object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/designs/bulk: post: tags: - designs - summary: 'Performs bulk actions on an array of designs' - description: '' + summary: "Performs bulk actions on an array of designs" + description: "" operationId: bulkDesigns parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Design User response' + description: "The Design User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Design' + $ref: "#/components/schemas/Design" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/documents: get: tags: - documents - summary: 'Gets a list of documents' + summary: "Gets a list of documents" description: "Lists documents, 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 documents, these are handled by the DocumentsFilters class which defines the methods available" operationId: getDocuments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of documents' + description: "A list of documents" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Document' + $ref: "#/components/schemas/Document" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/emails: post: tags: - emails - summary: 'Sends an email for an entity' - description: 'Sends an email for an entity' + summary: "Sends an email for an entity" + description: "Sends an email for an entity" operationId: sendEmailTemplate parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The template subject and body' + description: "The template subject and body" required: true content: application/json: schema: properties: subject: - description: 'The email subject' + description: "The email subject" type: string body: - description: 'The email body' + description: "The email body" type: string entity: - description: 'The entity name' + description: "The entity name" type: string entity_id: - description: 'The entity_id' + description: "The entity_id" type: string template: - description: 'The template required' + description: "The template required" type: string type: object responses: @@ -3633,156 +3397,147 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Template' + $ref: "#/components/schemas/Template" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories: get: tags: - expense_categories - summary: 'Gets a list of expense_categories' - description: 'Lists tax rates' + summary: "Gets a list of expense_categories" + description: "Lists tax rates" operationId: getExpenseCategorys parameters: - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of expense_categories' + description: "A list of expense_categories" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - expense_categories - summary: 'Adds a expense category' - description: 'Adds an expense category to the system' + summary: "Adds a expense category" + description: "Adds an expense category to the system" operationId: storeExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved invoice object' + description: "Returns the saved invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories/create: get: tags: - expense_categories - summary: 'Gets a new blank Expens Category object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Expens Category object" + description: "Returns a blank object with default values" operationId: getExpenseCategoryCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A blank Expens Category object' + description: "A blank Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expense_categories/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/expense_categories/{id}": get: tags: - expense_categories - summary: 'Shows a Expens Category' - description: 'Displays an ExpenseCategory by id' + summary: "Shows a Expens Category" + description: "Displays an ExpenseCategory by id" operationId: showExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3790,45 +3545,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expens Category object' + description: "Returns the Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - expense_categories - summary: 'Updates a tax rate' - description: 'Handles the updating of a tax rate by id' + summary: "Updates a tax rate" + description: "Handles the updating of a tax rate by id" operationId: updateExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3836,45 +3588,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the ExpenseCategory object' + description: "Returns the ExpenseCategory object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - expense_categories - summary: 'Deletes a ExpenseCategory' - description: 'Handles the deletion of an ExpenseCategory by id' + summary: "Deletes a ExpenseCategory" + description: "Handles the deletion of an ExpenseCategory by id" operationId: deleteExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3882,42 +3631,39 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expense_categories/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/expense_categories/{id}/edit": get: tags: - expense_categories - summary: 'Shows a Expens Category for editting' - description: 'Displays a Expens Category by id' + summary: "Shows a Expens Category for editting" + description: "Displays a Expens Category by id" operationId: editExpenseCategory parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The ExpenseCategory Hashed ID' + description: "The ExpenseCategory Hashed ID" required: true schema: type: string @@ -3925,180 +3671,166 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expens Category object' + description: "Returns the Expens Category object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/ExpenseCategory' + $ref: "#/components/schemas/ExpenseCategory" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expense_categories/bulk: post: tags: - expense_categories - summary: 'Performs bulk actions on an array of ExpenseCategorys' - description: '' + summary: "Performs bulk actions on an array of ExpenseCategorys" + description: "" operationId: bulkExpenseCategorys parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Expens Categorys' + description: "Expens Categorys" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The ExpenseCategory List response' + description: "The ExpenseCategory List response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses: get: tags: - expenses - summary: 'Gets a list of expenses' + summary: "Gets a list of expenses" description: "Lists expenses, 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 expenses, these are handled by the ExpenseFilters class which defines the methods available" operationId: getExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of expenses' + description: "A list of expenses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - expenses - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}": get: tags: - expenses - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4106,47 +3838,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - expenses - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4154,47 +3882,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - expenses - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4202,44 +3926,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}/edit": get: tags: - expenses - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4247,139 +3967,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses/create: get: tags: - expenses - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getExpensesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/expenses/bulk: post: tags: - expenses - summary: 'Performs bulk actions on an array of expenses' - description: '' + summary: "Performs bulk actions on an array of expenses" + description: "" operationId: bulkExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Expense User response' + description: "The Expense User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/expenses/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/expenses/{id}/upload": put: tags: - expense - summary: 'Uploads a document to a expense' - description: 'Handles the uploading of a document to a expense' + summary: "Uploads a document to a expense" + description: "Handles the uploading of a document to a expense" operationId: uploadExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Expense Hashed ID' + description: "The Expense Hashed ID" required: true schema: type: string @@ -4387,199 +4097,185 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Expense object' + description: "Returns the Expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Expense' + $ref: "#/components/schemas/Expense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/export: post: tags: - export - summary: 'Export data from the system' - description: 'Export data from the system' + summary: "Export data from the system" + description: "Export data from the system" operationId: getExport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings: get: tags: - group_settings - summary: 'Gets a list of group_settings' + summary: "Gets a list of group_settings" description: "Lists group_settings, 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 group_settings, these are handled by the GroupSettingFilters class which defines the methods available" operationId: getGroupSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of group_settings' + description: "A list of group_settings" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - group_settings - summary: 'Adds a GroupSetting' - description: 'Adds an GroupSetting to the system' + summary: "Adds a GroupSetting" + description: "Adds an GroupSetting to the system" operationId: storeGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved GroupSetting object' + description: "Returns the saved GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings/create: get: tags: - group_settings - summary: 'Gets a new blank GroupSetting object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank GroupSetting object" + description: "Returns a blank object with default values" operationId: getGroupSettingsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank GroupSetting object' + description: "A blank GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}": get: tags: - group_settings - summary: 'Shows an GroupSetting' - description: 'Displays an GroupSetting by id' + summary: "Shows an GroupSetting" + description: "Displays an GroupSetting by id" operationId: showGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4587,47 +4283,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - group_settings - summary: 'Updates an GroupSetting' - description: 'Handles the updating of an GroupSetting by id' + summary: "Updates an GroupSetting" + description: "Handles the updating of an GroupSetting by id" operationId: updateGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4635,47 +4327,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - group_settings - summary: 'Deletes a GroupSetting' - description: 'Handles the deletion of an GroupSetting by id' + summary: "Deletes a GroupSetting" + description: "Handles the deletion of an GroupSetting by id" operationId: deleteGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4683,44 +4371,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}/edit": get: tags: - group_settings - summary: 'Shows an GroupSetting for editting' - description: 'Displays an GroupSetting by id' + summary: "Shows an GroupSetting for editting" + description: "Displays an GroupSetting by id" operationId: editGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The GroupSetting Hashed ID' + description: "The GroupSetting Hashed ID" required: true schema: type: string @@ -4728,95 +4412,88 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the GroupSetting object' + description: "Returns the GroupSetting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/GroupSetting' + $ref: "#/components/schemas/GroupSetting" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/group_settings/bulk: post: tags: - group_settings - summary: 'Performs bulk actions on an array of group_settings' - description: '' + summary: "Performs bulk actions on an array of group_settings" + description: "" operationId: bulkGroupSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'An array of group_settings ids' + description: "An array of group_settings ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/group_settings/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/group_settings/{id}/upload": put: tags: - group_settings - summary: 'Uploads a document to a group setting' - description: 'Handles the uploading of a document to a group setting' + summary: "Uploads a document to a group setting" + description: "Handles the uploading of a document to a group setting" operationId: uploadGroupSetting parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Group Setting Hashed ID' + description: "The Group Setting Hashed ID" required: true schema: type: string @@ -4824,46 +4501,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Group Setting object' + description: "Returns the Group Setting object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preimport: post: tags: - imports - summary: 'Pre Import checks - returns a reference to the job and the headers of the CSV' - description: 'Pre Import checks - returns a reference to the job and the headers of the CSV' + summary: "Pre Import checks - returns a reference to the job and the headers of the CSV" + description: "Pre Import checks - returns a reference to the job and the headers of the CSV" operationId: preimport parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The CSV file' + description: "The CSV file" required: true content: multipart/form-data: @@ -4872,273 +4546,253 @@ paths: format: binary responses: 200: - description: 'Returns a reference to the file' + description: "Returns a reference to the file" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/import_json: post: tags: - import - summary: 'Import data from the system' - description: 'Import data from the system' + summary: "Import data from the system" + description: "Import data from the system" operationId: getImportJson parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/apple/confirm_purchase: post: tags: - postmark - summary: 'Processing webhooks from Apple for in app purchases' - description: 'Adds an credit to the system' + summary: "Processing webhooks from Apple for in app purchases" + description: "Adds an credit to the system" operationId: confirmApplePurchase parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/apple/process_webhook: post: tags: - postmark - summary: 'Processing event webhooks from Apple for in purchase / subscription status update' - description: 'Adds an credit to the system' + summary: "Processing event webhooks from Apple for in purchase / subscription status update" + description: "Adds an credit to the system" operationId: processAppleWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices: get: tags: - invoices - summary: 'Gets a list of 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of invoices' + description: "A list of invoices" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - invoices - summary: 'Adds a invoice' - description: 'Adds an invoice to the system' + 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' + - $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' + $ref: "#/components/schemas/FillableInvoice" responses: 200: - description: 'Returns the saved invoice object' + description: "Returns the saved invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/create: get: tags: - invoices - summary: 'Gets a new blank invoice object' - description: 'Returns a blank object with default values' + 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank invoice object' + description: "A blank invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}": get: tags: - invoices - summary: 'Shows an invoice' - description: 'Displays an invoice by id' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5146,47 +4800,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - invoices - summary: 'Updates an invoice' - description: 'Handles the updating of an invoice by id' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5194,47 +4844,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - invoices - summary: 'Deletes a invoice' - description: 'Handles the deletion of an invoice by id' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5242,44 +4888,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/edit": get: tags: - invoices - summary: 'Shows an invoice for editting' - description: 'Displays an invoice by id' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5287,104 +4929,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/bulk: post: tags: - invoices - summary: 'Performs bulk actions on an array of invoices' - description: '' + 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' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/{action}": get: tags: - invoices - summary: 'Performs a custom action on an invoice' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -5392,48 +5026,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoice/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/invoice/{invitation_key}/download": get: tags: - invoices - summary: 'Download a specific invoice by invitation key' - description: 'Downloads a specific invoice' + 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 + - $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' + description: "The Invoice Invitation Key" required: true schema: type: string @@ -5441,44 +5071,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice pdf' + description: "Returns the invoice pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/delivery_note': + $ref: "#/components/schemas/Error" + "/api/v1/invoices/{id}/delivery_note": get: tags: - invoices - summary: 'Download a specific invoice delivery notes' - description: 'Downloads a specific invoice delivery notes' + 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 + - $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' + description: "The Invoice Hahsed Id" required: true schema: type: string @@ -5486,44 +5112,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice delivery note pdf' + description: "Returns the invoice delivery note pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/invoices/{id}/upload': + $ref: "#/components/schemas/Error" + "/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' + 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 + - $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' + description: "The Invoice Hashed ID" required: true schema: type: string @@ -5531,134 +5153,124 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Invoice object' + description: "Returns the Invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/claim_license: get: tags: - claim_license - summary: 'Attempts to claim a white label license' - description: 'Attempts to claim a white label license' + summary: "Attempts to claim a white label license" + description: "Attempts to claim a white label license" operationId: getClaimLicense parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: license_key + - $ref: "#/components/parameters/X-Requested-With" + - name: license_key in: query - description: 'The license hash' + description: "The license hash" required: true schema: type: string format: string example: d87sh-s755s-s7d76-sdsd8 - - - name: product_id + - name: product_id in: query - description: 'The ID of the product purchased.' + description: "The ID of the product purchased." required: true schema: type: string format: string - example: '1' + example: "1" responses: 200: description: Success! headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/logout: post: tags: - logout - summary: 'Gets a list of logout' - description: 'Lists all logout' + summary: "Gets a list of logout" + description: "Lists all logout" operationId: getLogout parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'Success message' + description: "Success message" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/migration/purge/{company}': + $ref: "#/components/schemas/Error" + "/api/v1/migration/purge/{company}": post: tags: - migration - summary: 'Attempts to purge a company record and all its child records' - description: 'Attempts to purge a company record and all its child records' + summary: "Attempts to purge a company record and all its child records" + description: "Attempts to purge a company record and all its child records" operationId: postPurgeCompany parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -5669,39 +5281,36 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/migration/purge_save_settings/{company}': + $ref: "#/components/schemas/Error" + "/api/v1/migration/purge_save_settings/{company}": post: tags: - migration - summary: 'Attempts to purge a companies child records but save the company record and its settings' - description: 'Attempts to purge a companies child records but save the company record and its settings' + summary: "Attempts to purge a companies child records but save the company record and its settings" + description: "Attempts to purge a companies child records but save the company record and its settings" operationId: postPurgeCompanySaveSettings parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: company + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: company in: path - description: 'The Company Hashed ID' + description: "The Company Hashed ID" required: true schema: type: string @@ -5712,41 +5321,37 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/migration/start: post: tags: - migration - summary: 'Starts the migration from previous version of Invoice Ninja' - description: 'Starts the migration from previous version of Invoice Ninja' + summary: "Starts the migration from previous version of Invoice Ninja" + description: "Starts the migration from previous version of Invoice Ninja" operationId: postStartMigration parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/X-API-PASSWORD' - - - name: migration + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/X-API-PASSWORD" + - name: migration in: query - description: 'The migraton file' + description: "The migraton file" required: true schema: type: object @@ -5757,199 +5362,185 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/one_time_token: post: tags: - one_time_token - summary: 'Attempts to create a one time token' - description: 'Attempts to create a one time token' + summary: "Attempts to create a one time token" + description: "Attempts to create a one time token" operationId: oneTimeToken parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The Company User response' + description: "The Company User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments: get: tags: - payments - summary: 'Gets a list of payments' + summary: "Gets a list of payments" description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" operationId: getPayments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of payments' + description: "A list of payments" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - payments - summary: 'Adds a Payment' - description: 'Adds an Payment to the system' + summary: "Adds a Payment" + description: "Adds an Payment to the system" operationId: storePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The payment request' + description: "The payment request" required: true content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/create: get: tags: - payments - summary: 'Gets a new blank Payment object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Payment object" + description: "Returns a blank object with default values" operationId: getPaymentsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Payment object' + description: "A blank Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}": get: tags: - payments - summary: 'Shows an Payment' - description: 'Displays an Payment by id' + summary: "Shows an Payment" + description: "Displays an Payment by id" operationId: showPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -5957,47 +5548,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - payments - summary: 'Updates an Payment' - description: 'Handles the updating of an Payment by id' + summary: "Updates an Payment" + description: "Handles the updating of an Payment by id" operationId: updatePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6005,47 +5592,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - payments - summary: 'Deletes a Payment' - description: 'Handles the deletion of an Payment by id' + summary: "Deletes a Payment" + description: "Handles the deletion of an Payment by id" operationId: deletePayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6053,44 +5636,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/edit": get: tags: - payments - summary: 'Shows an Payment for editting' - description: 'Displays an Payment by id' + summary: "Shows an Payment for editting" + description: "Displays an Payment by id" operationId: editPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6098,108 +5677,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/bulk: post: tags: - payments - summary: 'Performs bulk actions on an array of payments' - description: '' + summary: "Performs bulk actions on an array of payments" + description: "" operationId: bulkPayments parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Payment response' + description: "The Payment response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/{action}": get: tags: - payments - summary: 'Performs a custom action on an Payment' + summary: "Performs a custom action on an Payment" description: "Performs a custom action on an Payment.\n\n The current range of actions are as follows\n - clone_to_Payment\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -6207,95 +5778,88 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payments/refund: post: tags: - payments - summary: 'Adds a Refund' - description: 'Adds an Refund to the system' + summary: "Adds a Refund" + description: "Adds an Refund to the system" operationId: storeRefund parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The refund request' + description: "The refund request" required: true content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payments/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/payments/{id}/upload": put: tags: - payments - summary: 'Uploads a document to a payment' - description: 'Handles the uploading of a document to a payment' + summary: "Uploads a document to a payment" + description: "Handles the uploading of a document to a payment" operationId: uploadPayment parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Hashed ID' + description: "The Payment Hashed ID" required: true schema: type: string @@ -6303,176 +5867,162 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms: get: tags: - payment_terms - summary: 'Gets a list of payment terms' - description: 'Lists payment terms' + summary: "Gets a list of payment terms" + description: "Lists payment terms" operationId: getPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of payment terms' + description: "A list of payment terms" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - payment_terms - summary: 'Adds a Payment' - description: 'Adds a Payment Term to the system' + summary: "Adds a Payment" + description: "Adds a Payment Term to the system" operationId: storePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The payment_terms request' + description: "The payment_terms request" required: true content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" responses: 200: - description: 'Returns the saved Payment object' + description: "Returns the saved Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms/create: get: tags: - payment_terms - summary: 'Gets a new blank PaymentTerm object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank PaymentTerm object" + description: "Returns a blank object with default values" operationId: getPaymentTermsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank PaymentTerm object' + description: "A blank PaymentTerm object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Payment' + $ref: "#/components/schemas/Payment" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payment_terms/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/payment_terms/{id}": get: tags: - payment_terms - summary: 'Shows a Payment Term' - description: 'Displays an Payment Term by id' + summary: "Shows a Payment Term" + description: "Displays an Payment Term by id" operationId: showPaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6480,47 +6030,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment Term object' + description: "Returns the Payment Term object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - payment_terms - summary: 'Updates a Payment Term' - description: 'Handles the updating of an Payment Termby id' + summary: "Updates a Payment Term" + description: "Handles the updating of an Payment Termby id" operationId: updatePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6528,47 +6074,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment Term object' + description: "Returns the Payment Term object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - payment_termss - summary: 'Deletes a Payment Term' - description: 'Handles the deletion of an PaymentTerm by id' + summary: "Deletes a Payment Term" + description: "Handles the deletion of an PaymentTerm by id" operationId: deletePaymentTerm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6576,44 +6118,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/payment_terms/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/payment_terms/{id}/edit": get: tags: - payment_terms - summary: 'Shows an Payment Term for editting' - description: 'Displays an Payment Term by id' + summary: "Shows an Payment Term for editting" + description: "Displays an Payment Term by id" operationId: editPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Payment Term Hashed ID' + description: "The Payment Term Hashed ID" required: true schema: type: string @@ -6621,325 +6159,304 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Payment object' + description: "Returns the Payment object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/payment_terms/bulk: post: tags: - payment_terms - summary: 'Performs bulk actions on an array of payment terms' - description: '' + summary: "Performs bulk actions on an array of payment terms" + description: "" operationId: bulkPaymentTerms parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Payment Ter,s' + description: "Payment Ter,s" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Payment Terms response' + description: "The Payment Terms response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/PaymentTerm' + $ref: "#/components/schemas/PaymentTerm" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/ping: get: tags: - ping - summary: 'Attempts to ping the API' - description: 'Attempts to ping the API' + summary: "Attempts to ping the API" + description: "Attempts to ping the API" operationId: getPing parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The company and user name' + description: "The company and user name" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" /api/v1/health_check: get: tags: - health_check - summary: 'Attempts to get a health check from the API' - description: 'Attempts to get a health check from the API' + summary: "Attempts to get a health check from the API" + description: "Attempts to get a health check from the API" operationId: getHealthCheck parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A key/value map of the system health' + description: "A key/value map of the system health" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" /api/v1/postmark_webhook: post: tags: - postmark - summary: 'Processing webhooks from PostMark' - description: 'Adds an credit to the system' + summary: "Processing webhooks from PostMark" + description: "Adds an credit to the system" operationId: postmarkWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved credit object' + description: "Returns the saved credit object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preview: post: tags: - preview - summary: 'Returns a pdf preview' - description: 'Returns a pdf preview.' + summary: "Returns a pdf preview" + description: "Returns a pdf preview." operationId: getPreview parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The pdf response' + description: "The pdf response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/preview/purchase_order: post: tags: - preview - summary: 'Returns a pdf preview for purchase order' - description: 'Returns a pdf preview for purchase order.' + summary: "Returns a pdf preview for purchase order" + description: "Returns a pdf preview for purchase order." operationId: getPreviewPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'The pdf response' + description: "The pdf response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - + $ref: "#/components/schemas/Error" + /api/v1/projects: get: tags: - projects - summary: 'Gets a list of projects' - description: 'Lists projects' + summary: "Gets a list of projects" + description: "Lists projects" operationId: getProjects parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of projects' + description: "A list of projects" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - projects - summary: 'Adds a project' - description: 'Adds an project to a company' + summary: "Adds a project" + description: "Adds an project to a company" operationId: storeProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved project object' + description: "Returns the saved project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}": get: tags: - projects - summary: 'Shows a project' - description: 'Displays a project by id' + summary: "Shows a project" + description: "Displays a project by id" operationId: showProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -6947,47 +6464,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the expense object' + description: "Returns the expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - projects - summary: 'Updates a project' - description: 'Handles the updating of a project by id' + summary: "Updates a project" + description: "Handles the updating of a project by id" operationId: updateProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -6995,47 +6508,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the project object' + description: "Returns the project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - projects - summary: 'Deletes a project' - description: 'Handles the deletion of a project by id' + summary: "Deletes a project" + description: "Handles the deletion of a project by id" operationId: deleteProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7043,44 +6552,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}/edit": get: tags: - projects - summary: 'Shows a project for editting' - description: 'Displays a project by id' + summary: "Shows a project for editting" + description: "Displays a project by id" operationId: editProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7088,139 +6593,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the project object' + description: "Returns the project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/projects/create: get: tags: - projects - summary: 'Gets a new blank project object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank project object" + description: "Returns a blank object with default values" operationId: getProjectsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank project object' + description: "A blank project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/projects/bulk: post: tags: - projects - summary: 'Performs bulk actions on an array of projects' - description: '' + summary: "Performs bulk actions on an array of projects" + description: "" operationId: bulkProjects parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Project User response' + description: "The Project User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/projects/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/projects/{id}/upload": put: tags: - projects - summary: 'Uploads a document to a project' - description: 'Handles the uploading of a document to a project' + summary: "Uploads a document to a project" + description: "Handles the uploading of a document to a project" operationId: uploadProject parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Project Hashed ID' + description: "The Project Hashed ID" required: true schema: type: string @@ -7228,167 +6723,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Project object' + description: "Returns the Project object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Project' + $ref: "#/components/schemas/Project" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders: get: tags: - purchase_orders - summary: 'Gets a list of purchase orders' + summary: "Gets a list of purchase orders" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" operationId: getPurchaseOrders parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of purchase orders' + description: "A list of purchase orders" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - purhcase_orders - summary: 'Adds a purchase order' - description: 'Adds an purchase order to the system' + summary: "Adds a purchase order" + description: "Adds an purchase order to the system" operationId: storePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved purchase order object' + description: "Returns the saved purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders/create: get: tags: - purchase_orders - summary: 'Gets a new blank purchase order object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank purchase order object" + description: "Returns a blank object with default values" operationId: getPurchaseOrderCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank purchase order object' + description: "A blank purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}": get: tags: - purchase_orders - summary: 'Shows an purcase orders' - description: 'Displays an purchase order by id' + summary: "Shows an purcase orders" + description: "Displays an purchase order by id" operationId: showPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase order Hashed ID' + description: "The Purchase order Hashed ID" required: true schema: type: string @@ -7396,47 +6878,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - purchase_orders - summary: 'Deletes a purchase order' - description: 'Handles the deletion of an purchase orders by id' + summary: "Deletes a purchase order" + description: "Handles the deletion of an purchase orders by id" operationId: deletePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purhcase order Hashed ID' + description: "The purhcase order Hashed ID" required: true schema: type: string @@ -7444,44 +6922,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/edit": get: tags: - purchase_orders - summary: 'Shows an purchase order for editting' - description: 'Displays an purchase order by id' + summary: "Shows an purchase order for editting" + description: "Displays an purchase order by id" operationId: editPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purchase order Hashed ID' + description: "The purchase order Hashed ID" required: true schema: type: string @@ -7489,48 +6963,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_order/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_order/{id}": put: tags: - purchase_orders - summary: 'Updates an purchase order' - description: 'Handles the updating of an purchase order by id' + summary: "Updates an purchase order" + description: "Handles the updating of an purchase order by id" operationId: updatePurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The purchase order Hashed ID' + description: "The purchase order Hashed ID" required: true schema: type: string @@ -7538,104 +7008,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the purchase order object' + description: "Returns the purchase order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Credit' + $ref: "#/components/schemas/Credit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/purchase_orders/bulk: post: tags: - purchase_orders - summary: 'Performs bulk actions on an array of purchase_orders' - description: '' + summary: "Performs bulk actions on an array of purchase_orders" + description: "" operationId: bulkPurchaseOrderss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Purchase Order IDS' + description: "Purchase Order IDS" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Bulk Action response' + description: "The Bulk Action response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/{action}": get: tags: - purchase_orders - summary: 'Performs a custom action on an purchase order' + summary: "Performs a custom action on an purchase order" description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" operationId: actionPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase Order Hashed ID' + description: "The Purchase Order Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -7643,48 +7105,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Invoice' + $ref: "#/components/schemas/Invoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_orders/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_orders/{id}/upload": put: tags: - purchase_orders - summary: 'Uploads a document to a purchase_orders' - description: 'Handles the uploading of a document to a purchase_order' + summary: "Uploads a document to a purchase_orders" + description: "Handles the uploading of a document to a purchase_order" operationId: uploadPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Purchase Order Hashed ID' + description: "The Purchase Order Hashed ID" required: true schema: type: string @@ -7692,48 +7150,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Purchase Order object' + description: "Returns the Purchase Order object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/purchase_order/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/purchase_order/{invitation_key}/download": get: tags: - purchase_orders - summary: 'Download a specific purchase order by invitation key' - description: 'Downloads a specific purchase order' + summary: "Download a specific purchase order by invitation key" + description: "Downloads a specific purchase order" operationId: downloadPurchaseOrder parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Purchase Order Invitation Key' + description: "The Purchase Order Invitation Key" required: true schema: type: string @@ -7741,163 +7195,150 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Purchase Order pdf' + description: "Returns the Purchase Order pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes: get: tags: - quotes - summary: 'Gets a list of quotes' + summary: "Gets a list of quotes" description: "Lists quotes, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the quotes, these are handled by the QuoteFilters class which defines the methods available" operationId: getQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of quotes' + description: "A list of quotes" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - quotes - summary: 'Adds a Quote' - description: 'Adds an Quote to the system' + summary: "Adds a Quote" + description: "Adds an Quote to the system" operationId: storeQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Quote object' + description: "Returns the saved Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes/create: get: tags: - quotes - summary: 'Gets a new blank Quote object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Quote object" + description: "Returns a blank object with default values" operationId: getQuotesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Quote object' + description: "A blank Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}": get: tags: - quotes - summary: 'Shows an Quote' - description: 'Displays an Quote by id' + summary: "Shows an Quote" + description: "Displays an Quote by id" operationId: showQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -7905,47 +7346,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - quotes - summary: 'Updates an Quote' - description: 'Handles the updating of an Quote by id' + summary: "Updates an Quote" + description: "Handles the updating of an Quote by id" operationId: updateQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -7953,47 +7390,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - quotes - summary: 'Deletes a Quote' - description: 'Handles the deletion of an Quote by id' + summary: "Deletes a Quote" + description: "Handles the deletion of an Quote by id" operationId: deleteQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8001,44 +7434,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/edit": get: tags: - quotes - summary: 'Shows an Quote for editting' - description: 'Displays an Quote by id' + summary: "Shows an Quote for editting" + description: "Displays an Quote by id" operationId: editQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8046,108 +7475,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/quotes/bulk: post: tags: - quotes - summary: 'Performs bulk actions on an array of quotes' - description: '' + summary: "Performs bulk actions on an array of quotes" + description: "" operationId: bulkQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Quote response' + description: "The Quote response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/{action}": get: tags: - quotes - summary: 'Performs a custom action on an Quote' + summary: "Performs a custom action on an Quote" description: "Performs a custom action on an Quote.\n\n The current range of actions are as follows\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - convert\n - convert_to_invoice\n - email" operationId: actionQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -8155,48 +7576,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quote/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/quote/{invitation_key}/download": get: tags: - quotes - summary: 'Download a specific quote by invitation key' - description: 'Downloads a specific quote' + summary: "Download a specific quote by invitation key" + description: "Downloads a specific quote" operationId: downloadQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Quote Invitation Key' + description: "The Quote Invitation Key" required: true schema: type: string @@ -8204,44 +7621,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the quote pdf' + description: "Returns the quote pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/quotes/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/quotes/{id}/upload": put: tags: - quotes - summary: 'Uploads a document to a quote' - description: 'Handles the uploading of a document to a quote' + summary: "Uploads a document to a quote" + description: "Handles the uploading of a document to a quote" operationId: uploadQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Quote Hashed ID' + description: "The Quote Hashed ID" required: true schema: type: string @@ -8249,129 +7662,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Quote object' + description: "Returns the Quote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Quote' + $ref: "#/components/schemas/Quote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses: get: tags: - recurring_expenses - summary: 'Gets a list of recurring_expenses' + summary: "Gets a list of recurring_expenses" description: "Lists recurring_expenses, 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 recurring_expenses, these are handled by the RecurringExpenseFilters class which defines the methods available" operationId: getRecurringExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of recurring_expenses' + description: "A list of recurring_expenses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_expenses - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}": get: tags: - recurring_expenses - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8379,47 +7781,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the recurring_expense object' + description: "Returns the recurring_expense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_expenses - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8427,47 +7825,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_expenses - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8475,44 +7869,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}/edit": get: tags: - recurring_expenses - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8520,139 +7910,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses/create: get: tags: - recurring_expenses - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getRecurringExpensesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_expenses/bulk: post: tags: - recurring_expenses - summary: 'Performs bulk actions on an array of recurring_expenses' - description: '' + summary: "Performs bulk actions on an array of recurring_expenses" + description: "" operationId: bulkRecurringExpenses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringExpense User response' + description: "The RecurringExpense User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_expenses/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_expenses/{id}/upload": put: tags: - recurring_expense - summary: 'Uploads a document to a recurring_expense' - description: 'Handles the uploading of a document to a recurring_expense' + summary: "Uploads a document to a recurring_expense" + description: "Handles the uploading of a document to a recurring_expense" operationId: uploadRecurringExpense parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringExpense Hashed ID' + description: "The RecurringExpense Hashed ID" required: true schema: type: string @@ -8660,167 +8040,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringExpense object' + description: "Returns the RecurringExpense object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringExpense' + $ref: "#/components/schemas/RecurringExpense" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices: get: tags: - recurring_invoices - summary: 'Gets a list of recurring_invoices' + summary: "Gets a list of recurring_invoices" description: "Lists recurring_invoices, 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 recurring_invoices, these are handled by the RecurringInvoiceFilters class which defines the methods available" operationId: getRecurringInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of recurring_invoices' + description: "A list of recurring_invoices" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_invoices - summary: 'Adds a RecurringInvoice' - description: 'Adds an RecurringInvoice to the system' + summary: "Adds a RecurringInvoice" + description: "Adds an RecurringInvoice to the system" operationId: storeRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved RecurringInvoice object' + description: "Returns the saved RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices/create: get: tags: - recurring_invoices - summary: 'Gets a new blank RecurringInvoice object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank RecurringInvoice object" + description: "Returns a blank object with default values" operationId: getRecurringInvoicesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank RecurringInvoice object' + description: "A blank RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}": get: tags: - recurring_invoices - summary: 'Shows an RecurringInvoice' - description: 'Displays an RecurringInvoice by id' + summary: "Shows an RecurringInvoice" + description: "Displays an RecurringInvoice by id" operationId: showRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8828,47 +8195,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_invoices - summary: 'Updates an RecurringInvoice' - description: 'Handles the updating of an RecurringInvoice by id' + summary: "Updates an RecurringInvoice" + description: "Handles the updating of an RecurringInvoice by id" operationId: updateRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8876,47 +8239,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_invoices - summary: 'Deletes a RecurringInvoice' - description: 'Handles the deletion of an RecurringInvoice by id' + summary: "Deletes a RecurringInvoice" + description: "Handles the deletion of an RecurringInvoice by id" operationId: deleteRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8924,44 +8283,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/edit": get: tags: - recurring_invoices - summary: 'Shows an RecurringInvoice for editting' - description: 'Displays an RecurringInvoice by id' + summary: "Shows an RecurringInvoice for editting" + description: "Displays an RecurringInvoice by id" operationId: editRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -8969,48 +8324,44 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoice/{invitation_key}/download': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: - invoices - summary: 'Download a specific invoice by invitation key' - description: 'Downloads a specific invoice' + summary: "Download a specific invoice by invitation key" + description: "Downloads a specific invoice" operationId: downloadRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: invitation_key + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key in: path - description: 'The Recurring Invoice Invitation Key' + description: "The Recurring Invoice Invitation Key" required: true schema: type: string @@ -9018,104 +8369,96 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the recurring invoice pdf' + description: "Returns the recurring invoice pdf" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_invoices/bulk: post: tags: - recurring_invoices - summary: 'Performs bulk actions on an array of recurring_invoices' - description: '' + summary: "Performs bulk actions on an array of recurring_invoices" + description: "" operationId: bulkRecurringInvoices parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed IDs' + description: "Hashed IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringInvoice response' + description: "The RecurringInvoice response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/{action}": get: tags: - recurring_invoices - summary: 'Performs a custom action on an RecurringInvoice' + summary: "Performs a custom action on an RecurringInvoice" description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -9123,48 +8466,44 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_invoices/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_invoices/{id}/upload": put: tags: - recurring_invoices - summary: 'Uploads a document to a recurring_invoice' - description: 'Handles the uploading of a document to a recurring_invoice' + summary: "Uploads a document to a recurring_invoice" + description: "Handles the uploading of a document to a recurring_invoice" operationId: uploadRecurringInvoice parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringInvoice Hashed ID' + description: "The RecurringInvoice Hashed ID" required: true schema: type: string @@ -9172,167 +8511,154 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringInvoice object' + description: "Returns the RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringInvoice' + $ref: "#/components/schemas/RecurringInvoice" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes: get: tags: - recurring_quotes - summary: 'Gets a list of recurring_quotes' + summary: "Gets a list of recurring_quotes" description: "Lists recurring_quotes, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the recurring_quotes, these are handled by the RecurringQuoteFilters class which defines the methods available" operationId: getRecurringQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of recurring_quotes' + description: "A list of recurring_quotes" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - recurring_quotes - summary: 'Adds a RecurringQuote' - description: 'Adds an RecurringQuote to the system' + summary: "Adds a RecurringQuote" + description: "Adds an RecurringQuote to the system" operationId: storeRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved RecurringQuote object' + description: "Returns the saved RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes/create: get: tags: - recurring_quotes - summary: 'Gets a new blank RecurringQuote object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank RecurringQuote object" + description: "Returns a blank object with default values" operationId: getRecurringQuotesCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank RecurringQuote object' + description: "A blank RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}": get: tags: - recurring_quotes - summary: 'Shows an RecurringQuote' - description: 'Displays an RecurringQuote by id' + summary: "Shows an RecurringQuote" + description: "Displays an RecurringQuote by id" operationId: showRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9340,47 +8666,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - recurring_quotes - summary: 'Updates an RecurringQuote' - description: 'Handles the updating of an RecurringQuote by id' + summary: "Updates an RecurringQuote" + description: "Handles the updating of an RecurringQuote by id" operationId: updateRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9388,47 +8710,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - recurring_quotes - summary: 'Deletes a RecurringQuote' - description: 'Handles the deletion of an RecurringQuote by id' + summary: "Deletes a RecurringQuote" + description: "Handles the deletion of an RecurringQuote by id" operationId: deleteRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9436,44 +8754,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}/edit": get: tags: - recurring_quotes - summary: 'Shows an RecurringQuote for editting' - description: 'Displays an RecurringQuote by id' + summary: "Shows an RecurringQuote for editting" + description: "Displays an RecurringQuote by id" operationId: editRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string @@ -9481,108 +8795,100 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/recurring_quotes/bulk: post: tags: - recurring_quotes - summary: 'Performs bulk actions on an array of recurring_quotes' - description: '' + summary: "Performs bulk actions on an array of recurring_quotes" + description: "" operationId: bulkRecurringQuotes parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The RecurringQuote response' + description: "The RecurringQuote response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/recurring_quotes/{id}/{action}': + $ref: "#/components/schemas/Error" + "/api/v1/recurring_quotes/{id}/{action}": get: tags: - recurring_quotes - summary: 'Performs a custom action on an RecurringQuote' + summary: "Performs a custom action on an RecurringQuote" description: "Performs a custom action on an RecurringQuote.\n\n The current range of actions are as follows\n - clone_to_RecurringQuote\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionRecurringQuote parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The RecurringQuote Hashed ID' + description: "The RecurringQuote Hashed ID" required: true schema: type: string format: string example: D2J234DFA - - - name: action + - name: action in: path - description: 'The action string to be performed' + description: "The action string to be performed" required: true schema: type: string @@ -9590,804 +8896,769 @@ paths: example: clone_to_quote responses: 200: - description: 'Returns the RecurringQuote object' + description: "Returns the RecurringQuote object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/RecurringQuote' + $ref: "#/components/schemas/RecurringQuote" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/contacts: post: tags: - reports - summary: 'Contact reports' - description: 'Export contact reports' + summary: "Contact reports" + description: "Export contact reports" operationId: getContactReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/clients: post: tags: - reports - summary: 'Client reports' - description: 'Export client reports' + summary: "Client reports" + description: "Export client reports" operationId: getClientReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/credit: post: tags: - reports - summary: 'Credit reports' - description: 'Export credit reports' + summary: "Credit reports" + description: "Export credit reports" operationId: getCreditReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/documents: post: tags: - reports - summary: 'Document reports' - description: 'Export document reports' + summary: "Document reports" + description: "Export document reports" operationId: getDocumentReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/expense: post: tags: - reports - summary: 'Expense reports' - description: 'Export expense reports' + summary: "Expense reports" + description: "Export expense reports" operationId: getExpenseReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/invoice_items: post: tags: - reports - summary: 'Invoice item reports' - description: 'Export invoice item reports' + summary: "Invoice item reports" + description: "Export invoice item reports" operationId: getInvoiceItemReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/invoices: post: tags: - reports - summary: 'Invoice reports' - description: 'Export invoice reports' + summary: "Invoice reports" + description: "Export invoice reports" operationId: getInvoiceReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/payments: post: tags: - reports - summary: 'Payment reports' - description: 'Export payment reports' + summary: "Payment reports" + description: "Export payment reports" operationId: getPaymentReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/products: post: tags: - reports - summary: 'Product reports' - description: 'Export product reports' + summary: "Product reports" + description: "Export product reports" operationId: getProductReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/product_sales: post: tags: - reports - summary: 'Product Salesreports' - description: 'Export product sales reports' + summary: "Product Salesreports" + description: "Export product sales reports" operationId: getProductSalesReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/profitloss: post: tags: - reports - summary: 'Profit loss reports' - description: 'Profit loss report' + summary: "Profit loss reports" + description: "Profit loss report" operationId: getProfitLossReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/quote_items: post: tags: - reports - summary: 'Quote item reports' - description: 'Export Quote item reports' + summary: "Quote item reports" + description: "Export Quote item reports" operationId: getQuoteItemReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/quotes: post: tags: - reports - summary: 'Quote reports' - description: 'Export quote reports' + summary: "Quote reports" + description: "Export quote reports" operationId: getQuoteReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/recurring_invoices: post: tags: - reports - summary: 'Recurring Invoice reports' - description: 'Export recurring invoice reports' + summary: "Recurring Invoice reports" + description: "Export recurring invoice reports" operationId: getRecurringInvoiceReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/reports/tasks: post: tags: - reports - summary: 'Task reports' - description: 'Export task reports' + summary: "Task reports" + description: "Export task reports" operationId: getTaskReport parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/GenericReportSchema' + $ref: "#/components/schemas/GenericReportSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/self-update: post: tags: - update - summary: 'Performs a system update' - description: 'Performs a system update' + summary: "Performs a system update" + description: "Performs a system update" operationId: selfUpdate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-API-PASSWORD' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-API-PASSWORD" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Success/failure response' + description: "Success/failure response" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/statics: get: tags: - statics - summary: 'Gets a list of statics' - description: 'Lists all statics' + summary: "Gets a list of statics" + description: "Lists all statics" operationId: getStatics parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of static data' + description: "A list of static data" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions: get: tags: - subscriptions - summary: 'Gets a list of subscriptions' - description: 'Lists subscriptions.' + summary: "Gets a list of subscriptions" + description: "Lists subscriptions." operationId: getSubscriptions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of subscriptions' + description: "A list of subscriptions" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - subscriptions - summary: 'Adds a subscriptions' - description: 'Adds an subscriptions to the system' + summary: "Adds a subscriptions" + description: "Adds an subscriptions to the system" operationId: storeSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved subscriptions object' + description: "Returns the saved subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions/create: get: tags: - subscriptions - summary: 'Gets a new blank subscriptions object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank subscriptions object" + description: "Returns a blank object with default values" operationId: getSubscriptionsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank subscriptions object' + description: "A blank subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/subscriptions/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/subscriptions/{id}": get: tags: - subscriptions - summary: 'Shows an subscriptions' - description: 'Displays an subscriptions by id' + summary: "Shows an subscriptions" + description: "Displays an subscriptions by id" operationId: showSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10395,47 +9666,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Subscription object' + description: "Returns the Subscription object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - subscriptions - summary: 'Updates an subscriptions' - description: 'Handles the updating of an subscriptions by id' + summary: "Updates an subscriptions" + description: "Handles the updating of an subscriptions by id" operationId: updateSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10443,47 +9710,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the subscriptions object' + description: "Returns the subscriptions object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - subscriptions - summary: 'Deletes a subscriptions' - description: 'Handles the deletion of an subscriptions by id' + summary: "Deletes a subscriptions" + description: "Handles the deletion of an subscriptions by id" operationId: deleteSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10491,44 +9754,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/subscriptions/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/subscriptions/{id}/edit": get: tags: - subscriptions - summary: 'Shows an subscriptions for editting' - description: 'Displays an subscriptions by id' + summary: "Shows an subscriptions for editting" + description: "Displays an subscriptions by id" operationId: editSubscription parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Subscription Hashed ID' + description: "The Subscription Hashed ID" required: true schema: type: string @@ -10536,102 +9795,97 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the invoice object' + description: "Returns the invoice object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/subscriptions/bulk: post: tags: - subscriptions - summary: 'Performs bulk actions on an array of subscriptions' - description: '' + summary: "Performs bulk actions on an array of subscriptions" + description: "" operationId: bulkSubscriptions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Subscription response' + description: "The Subscription response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Subscription' + $ref: "#/components/schemas/Subscription" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/support/messages/send: post: tags: - support - summary: 'Sends a support message to Invoice Ninja team' - description: 'Allows a user to send a support message to the Invoice Ninja Team' + summary: "Sends a support message to Invoice Ninja team" + description: "Allows a user to send a support message to the Invoice Ninja Team" operationId: supportMessage parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The message' + description: "The message" required: true content: application/json: schema: properties: message: - description: 'The support message' + description: "The support message" type: string type: string responses: @@ -10639,83 +9893,76 @@ paths: description: Success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: type: array items: - description: 'Server response' + description: "Server response" type: string example: true default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/system_logs: get: tags: - system_logs - summary: 'Gets a list of system logs' + summary: "Gets a list of system logs" description: "Lists system logs, 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 system logs, these are handled by the SystemLogFilters class which defines the methods available" operationId: getSystemLogs parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of system logs' + description: "A list of system logs" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/SystemLog' + $ref: "#/components/schemas/SystemLog" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/system_logs/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/system_logs/{id}": get: tags: - system_logs - summary: 'Shows a system_logs' - description: 'Displays a system_logs by id' + summary: "Shows a system_logs" + description: "Displays a system_logs by id" operationId: showSystemLogs parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The system_logs Hashed ID' + description: "The system_logs Hashed ID" required: true schema: type: string @@ -10723,129 +9970,118 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the system_logs object' + description: "Returns the system_logs object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/SystemLog' + $ref: "#/components/schemas/SystemLog" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks: get: tags: - tasks - summary: 'Gets a list of tasks' + summary: "Gets a list of tasks" description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" operationId: getTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tasks' + description: "A list of tasks" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - tasks - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}": get: tags: - tasks - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10853,47 +10089,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the task object' + description: "Returns the task object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tasks - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10901,47 +10133,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tasks - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10949,44 +10177,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}/edit": get: tags: - tasks - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -10994,139 +10218,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/create: get: tags: - tasks - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getTasksCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/bulk: post: tags: - tasks - summary: 'Performs bulk actions on an array of tasks' - description: '' + summary: "Performs bulk actions on an array of tasks" + description: "" operationId: bulkTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Task User response' + description: "The Task User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tasks/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/tasks/{id}/upload": put: tags: - tasks - summary: 'Uploads a document to a task' - description: 'Handles the uploading of a document to a task' + summary: "Uploads a document to a task" + description: "Handles the uploading of a document to a task" operationId: uploadTask parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Task Hashed ID' + description: "The Task Hashed ID" required: true schema: type: string @@ -11134,185 +10348,174 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Task object' + description: "Returns the Task object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Task' + $ref: "#/components/schemas/Task" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tasks/stort: post: tags: - tasks - summary: 'Sort tasks on KanBan' - description: 'Sorts tasks after drag and drop on the KanBan.' + summary: "Sort tasks on KanBan" + description: "Sorts tasks after drag and drop on the KanBan." operationId: sortTasks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns an Ok, 200 HTTP status' + description: "Returns an Ok, 200 HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_schedulers/: get: tags: - task_schedulers - summary: 'Task Scheduler Index' - description: 'Get all schedulers with associated jobs' + summary: "Task Scheduler Index" + description: "Get all schedulers with associated jobs" operationId: getTaskSchedulers parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - task_schedulers - summary: 'Create task scheduler with job ' + summary: "Create task scheduler with job " description: "Create task scheduler with a job (action(job) request should be sent via request also. Example: We want client report to be job which will be run\n * multiple times, we should send the same parameters in the request as we would send if we wanted to get report, see example" operationId: createTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-Requested-With" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/invoices/task_schedulers: get: tags: - task_schedulers - summary: 'Gets a new blank scheduler object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank scheduler object" + description: "Returns a blank object with default values" operationId: getTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank scheduler object' + description: "A blank scheduler object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_schedulers/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/task_schedulers/{id}": get: tags: - task_schedulers - summary: 'Show given scheduler' - description: 'Get scheduler with associated job' + summary: "Show given scheduler" + description: "Get scheduler with associated job" operationId: showTaskScheduler parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11323,32 +10526,29 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - task_schedulers - summary: 'Update task scheduler ' - description: 'Update task scheduler' + summary: "Update task scheduler " + description: "Update task scheduler" operationId: updateTaskScheduler parameters: - - - $ref: '#/components/parameters/X-API-SECRET' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-SECRET" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11359,42 +10559,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" responses: 200: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - task_schedulers - summary: 'Destroy Task Scheduler' - description: 'Destroy task scheduler and its associated job' + summary: "Destroy Task Scheduler" + description: "Destroy task scheduler and its associated job" operationId: destroyTaskScheduler parameters: - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The Scheduler Hashed ID' + description: "The Scheduler Hashed ID" required: true schema: type: string @@ -11405,214 +10603,197 @@ paths: description: success headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_schedulers/bulk: post: tags: - task_schedulers - summary: 'Performs bulk actions on an array of task_schedulers' - description: '' + summary: "Performs bulk actions on an array of task_schedulers" + description: "" operationId: bulkTaskSchedulerActions parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'array of ids' + description: "array of ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaskSchedule response' + description: "The TaskSchedule response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskSchedulerSchema' + $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses: get: tags: - task_status - summary: 'Gets a list of task statuses' - description: 'Lists task statuses' + summary: "Gets a list of task statuses" + description: "Lists task statuses" operationId: getTaskStatuses parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of task statuses' + description: "A list of task statuses" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - task_status - summary: 'Adds a TaskStatus' - description: 'Adds a TaskStatusto the system' + summary: "Adds a TaskStatus" + description: "Adds a TaskStatusto the system" operationId: storeTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" requestBody: - description: 'The task_status request' + description: "The task_status request" required: true content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" responses: 200: - description: 'Returns the saved TaskStatus object' + description: "Returns the saved TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses/create: get: tags: - task_status - summary: 'Gets a new blank TaskStatus object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank TaskStatus object" + description: "Returns a blank object with default values" operationId: getTaskStatussCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank TaskStatus object' + description: "A blank TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_statuses/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/task_statuses/{id}": get: tags: - task_status - summary: 'Shows a TaskStatus Term' - description: 'Displays an TaskStatusby id' + summary: "Shows a TaskStatus Term" + description: "Displays an TaskStatusby id" operationId: showTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11620,47 +10801,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatusobject' + description: "Returns the TaskStatusobject" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - task_status - summary: 'Updates a TaskStatus Term' - description: 'Handles the updating of an TaskStatus Termby id' + summary: "Updates a TaskStatus Term" + description: "Handles the updating of an TaskStatus Termby id" operationId: updateTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11668,47 +10845,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatusobject' + description: "Returns the TaskStatusobject" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - task_statuss - summary: 'Deletes a TaskStatus Term' - description: 'Handles the deletion of an TaskStatus by id' + summary: "Deletes a TaskStatus Term" + description: "Handles the deletion of an TaskStatus by id" operationId: deleteTaskStatus parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11716,44 +10889,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/task_statuses/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/task_statuses/{id}/edit": get: tags: - task_status - summary: 'Shows an TaskStatusfor editting' - description: 'Displays an TaskStatusby id' + summary: "Shows an TaskStatusfor editting" + description: "Displays an TaskStatusby id" operationId: editTaskStatuss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The TaskStatusHashed ID' + description: "The TaskStatusHashed ID" required: true schema: type: string @@ -11761,171 +10930,162 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaskStatus object' + description: "Returns the TaskStatus object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/task_statuses/bulk: post: tags: - task_status - summary: 'Performs bulk actions on an array of task statuses' - description: '' + summary: "Performs bulk actions on an array of task statuses" + description: "" operationId: bulkTaskStatuss parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'TaskStatus Ter,s' + description: "TaskStatus Ter,s" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaskStatus Terms response' + description: "The TaskStatus Terms response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaskStatus' + $ref: "#/components/schemas/TaskStatus" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates: get: tags: - tax_rates - summary: 'Gets a list of tax_rates' - description: 'Lists tax rates' + summary: "Gets a list of tax_rates" + description: "Lists tax rates" operationId: getTaxRates parameters: - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tax_rates' + description: "A list of tax_rates" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates/create: get: tags: - tax_rates - summary: 'Gets a new blank Tax Rate object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Tax Rate object" + description: "Returns a blank object with default values" operationId: getTaxRateCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'A blank Tax Rate object' + description: "A blank Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tax_rates/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tax_rates/{id}": get: tags: - tax_rates - summary: 'Shows a Tax Rate' - description: 'Displays an TaxRate by id' + summary: "Shows a Tax Rate" + description: "Displays an TaxRate by id" operationId: showTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -11933,45 +11093,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Tax Rate object' + description: "Returns the Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tax_rates - summary: 'Updates a tax rate' - description: 'Handles the updating of a tax rate by id' + summary: "Updates a tax rate" + description: "Handles the updating of a tax rate by id" operationId: updateTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -11979,45 +11136,42 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the TaxRate object' + description: "Returns the TaxRate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tax_rates - summary: 'Deletes a TaxRate' - description: 'Handles the deletion of an TaxRate by id' + summary: "Deletes a TaxRate" + description: "Handles the deletion of an TaxRate by id" operationId: deleteTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12025,42 +11179,39 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tax_rates/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tax_rates/{id}/edit": get: tags: - tax_rates - summary: 'Shows a Tax Rate for editting' - description: 'Displays a Tax Rate by id' + summary: "Shows a Tax Rate for editting" + description: "Displays a Tax Rate by id" operationId: editTaxRate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - name: id in: path - description: 'The TaxRate Hashed ID' + description: "The TaxRate Hashed ID" required: true schema: type: string @@ -12068,230 +11219,215 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Tax Rate object' + description: "Returns the Tax Rate object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/TaxRate' + $ref: "#/components/schemas/TaxRate" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tax_rates/bulk: post: tags: - tax_rates - summary: 'Performs bulk actions on an array of TaxRates' - description: '' + summary: "Performs bulk actions on an array of TaxRates" + description: "" operationId: bulkTaxRates parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Tax Rates' + description: "Tax Rates" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The TaxRate List response' + description: "The TaxRate List response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/templates: post: tags: - templates - summary: 'Returns a entity template with the template variables replaced with the Entities' - description: 'Returns a entity template with the template variables replaced with the Entities' + summary: "Returns a entity template with the template variables replaced with the Entities" + description: "Returns a entity template with the template variables replaced with the Entities" operationId: getShowTemplate parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" requestBody: - description: 'The template subject and body' + description: "The template subject and body" required: true content: application/json: schema: properties: subject: - description: 'The email template subject' + description: "The email template subject" type: string body: - description: 'The email template body' + description: "The email template body" type: string type: object responses: 200: - description: 'The template response' + description: "The template response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Template' + $ref: "#/components/schemas/Template" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens: get: tags: - tokens - summary: 'Gets a list of company tokens' + summary: "Gets a list of company tokens" description: "Lists company tokens.\n *\n * Query parameters can be added to performed more fine grained filtering of the tokens, these are handled by the TokenFilters class which defines the methods available" operationId: getTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of tokens' + description: "A list of tokens" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - tokens - summary: 'Adds a token' - description: 'Adds an token to a company' + summary: "Adds a token" + description: "Adds an token to a company" operationId: storeToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved token object' + description: "Returns the saved token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tokens/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/tokens/{id}": get: tags: - tokens - summary: 'Shows a token' - description: 'Displays a token by id' + summary: "Shows a token" + description: "Displays a token by id" operationId: showToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12299,47 +11435,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - tokens - summary: 'Updates a token' - description: 'Handles the updating of a token by id' + summary: "Updates a token" + description: "Handles the updating of a token by id" operationId: updateToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12347,47 +11479,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - tokens - summary: 'Deletes a token' - description: 'Handles the deletion of a token by id' + summary: "Deletes a token" + description: "Handles the deletion of a token by id" operationId: deleteToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12395,44 +11523,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/tokens/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/tokens/{id}/edit": get: tags: - tokens - summary: 'Shows a token for editting' - description: 'Displays a token by id' + summary: "Shows a token for editting" + description: "Displays a token by id" operationId: editToken parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Token Hashed ID' + description: "The Token Hashed ID" required: true schema: type: string @@ -12440,258 +11564,239 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the token object' + description: "Returns the token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens/create: get: tags: - tokens - summary: 'Gets a new blank token object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank token object" + description: "Returns a blank object with default values" operationId: getTokensCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank token object' + description: "A blank token object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/tokens/bulk: post: tags: - tokens - summary: 'Performs bulk actions on an array of tokens' - description: '' + summary: "Performs bulk actions on an array of tokens" + description: "" operationId: bulkTokens parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Token ids' + description: "Token ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Token response' + description: "The Token response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/CompanyToken' + $ref: "#/components/schemas/CompanyToken" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users: get: tags: - users - summary: 'Gets a list of users' + summary: "Gets a list of users" description: "Lists users, 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 users, these are handled by the UserFilters class which defines the methods available" operationId: getUsers parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of users' + description: "A list of users" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - users - summary: 'Adds a User' - description: 'Adds an User to the system' + summary: "Adds a User" + description: "Adds an User to the system" operationId: storeUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved User object' + description: "Returns the saved User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users/create: get: tags: - users - summary: 'Gets a new blank User object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank User object" + description: "Returns a blank object with default values" operationId: getUsersCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank User object' + description: "A blank User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/users/{id}": get: tags: - users - summary: 'Shows an User' - description: 'Displays an User by id' + summary: "Shows an User" + description: "Displays an User by id" operationId: showUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12699,47 +11804,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - users - summary: 'Updates an User' - description: 'Handles the updating of an User by id' + summary: "Updates an User" + description: "Handles the updating of an User by id" operationId: updateUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12747,56 +11848,51 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - users - summary: 'Deletes a User' - description: 'Handles the deletion of an User by id' + summary: "Deletes a User" + description: "Handles the deletion of an User by id" operationId: deleteUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: token_name + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: token_name in: query - description: 'Customized name for the Users API Token' + description: "Customized name for the Users API Token" required: false schema: type: string format: string - example: 'iOS Device 11 iPad' - - - name: id + example: "iOS Device 11 iPad" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12804,44 +11900,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/users/{id}/edit": get: tags: - users - summary: 'Shows an User for editting' - description: 'Displays an User by id' + summary: "Shows an User for editting" + description: "Displays an User by id" operationId: editUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The User Hashed ID' + description: "The User Hashed ID" required: true schema: type: string @@ -12849,99 +11941,92 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the User object' + description: "Returns the User object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/users/bulk: post: tags: - users - summary: 'Performs bulk actions on an array of users' - description: '' + summary: "Performs bulk actions on an array of users" + description: "" operationId: bulkUsers parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed ids' + description: "Hashed ids" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The User response' + description: "The User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/User' + $ref: "#/components/schemas/User" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/detach_from_company': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/detach_from_company": delete: tags: - users - summary: 'Detach an existing user to a company' - description: 'Detach an existing user from a company' + summary: "Detach an existing user to a company" + description: "Detach an existing user from a company" operationId: detachUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -12949,44 +12034,40 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/invite': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/invite": post: tags: - users - summary: 'Reconfirm an existing user to a company' - description: 'Reconfirm an existing user from a company' + summary: "Reconfirm an existing user to a company" + description: "Reconfirm an existing user from a company" operationId: inviteUser parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -12994,44 +12075,40 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/users/{user}/reconfirm': + $ref: "#/components/schemas/Error" + "/api/v1/users/{user}/reconfirm": post: tags: - users - summary: 'Reconfirm an existing user to a company' - description: 'Reconfirm an existing user from a company' + summary: "Reconfirm an existing user to a company" + description: "Reconfirm an existing user from a company" operationId: inviteUserReconfirm parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: user + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: user in: path - description: 'The user hashed_id' + description: "The user hashed_id" required: true schema: type: string @@ -13039,125 +12116,114 @@ paths: example: FD767dfd7 responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors: get: tags: - vendors - summary: 'Gets a list of vendors' + summary: "Gets a list of vendors" description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" operationId: getVendors parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of vendors' + description: "A list of vendors" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - vendors - summary: 'Adds a client' - description: 'Adds an client to a company' + summary: "Adds a client" + description: "Adds an client to a company" operationId: storeVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved client object' + description: "Returns the saved client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}": get: tags: - vendors - summary: 'Shows a client' - description: 'Displays a client by id' + summary: "Shows a client" + description: "Displays a client by id" operationId: showVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13165,47 +12231,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the vendor object' + description: "Returns the vendor object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - vendors - summary: 'Updates a client' - description: 'Handles the updating of a client by id' + summary: "Updates a client" + description: "Handles the updating of a client by id" operationId: updateVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13213,47 +12275,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - vendors - summary: 'Deletes a client' - description: 'Handles the deletion of a client by id' + summary: "Deletes a client" + description: "Handles the deletion of a client by id" operationId: deleteVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13261,44 +12319,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}/edit": get: tags: - vendors - summary: 'Shows a client for editting' - description: 'Displays a client by id' + summary: "Shows a client for editting" + description: "Displays a client by id" operationId: editVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13306,139 +12360,129 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors/create: get: tags: - vendors - summary: 'Gets a new blank client object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank client object" + description: "Returns a blank object with default values" operationId: getVendorsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank client object' + description: "A blank client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/vendors/bulk: post: tags: - vendors - summary: 'Performs bulk actions on an array of vendors' - description: '' + summary: "Performs bulk actions on an array of vendors" + description: "" operationId: bulkVendors parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Vendor User response' + description: "The Vendor User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/vendors/{id}/upload': + $ref: "#/components/schemas/Error" + "/api/v1/vendors/{id}/upload": put: tags: - vendors - summary: 'Uploads a document to a vendor' - description: 'Handles the uploading of a document to a vendor' + summary: "Uploads a document to a vendor" + description: "Handles the uploading of a document to a vendor" operationId: uploadVendor parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Vendor Hashed ID' + description: "The Vendor Hashed ID" required: true schema: type: string @@ -13446,161 +12490,149 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Vendor object' + description: "Returns the Vendor object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Vendor' + $ref: "#/components/schemas/Vendor" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webcron: get: tags: - webcron - summary: 'Executes the task scheduler via a webcron service' - description: 'Executes the task scheduler via a webcron service' + summary: "Executes the task scheduler via a webcron service" + description: "Executes the task scheduler via a webcron service" operationId: webcron parameters: - - - $ref: '#/components/parameters/X-Requested-With' + - $ref: "#/components/parameters/X-Requested-With" responses: 200: - description: 'Success response' + description: "Success response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks: get: tags: - webhooks - summary: 'Gets a list of Webhooks' + summary: "Gets a list of Webhooks" description: "Lists Webhooks, 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 Webhooks, these are handled by the WebhookFilters class which defines the methods available" operationId: getWebhooks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" responses: 200: - description: 'A list of Webhooks' + description: "A list of Webhooks" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - webhooks - summary: 'Adds a Webhook' - description: 'Adds an Webhook to a company' + summary: "Adds a Webhook" + description: "Adds an Webhook to a company" operationId: storeWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Webhook object' + description: "Returns the saved Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/webhooks/{id}': + $ref: "#/components/schemas/Error" + "/api/v1/webhooks/{id}": get: tags: - webhooks - summary: 'Shows a Webhook' - description: 'Displays a Webhook by id' + summary: "Shows a Webhook" + description: "Displays a Webhook by id" operationId: showWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13608,47 +12640,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - webhooks - summary: 'Updates a Webhook' - description: 'Handles the updating of a Webhook by id' + summary: "Updates a Webhook" + description: "Handles the updating of a Webhook by id" operationId: updateWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13656,47 +12684,43 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - Webhooks - summary: 'Deletes a Webhook' - description: 'Handles the deletion of a Webhook by id' + summary: "Deletes a Webhook" + description: "Handles the deletion of a Webhook by id" operationId: deleteWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13704,44 +12728,40 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/webhooks/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/webhooks/{id}/edit": get: tags: - webhooks - summary: 'Shows a Webhook for editting' - description: 'Displays a Webhook by id' + summary: "Shows a Webhook for editting" + description: "Displays a Webhook by id" operationId: editWebhook parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Webhook Hashed ID' + description: "The Webhook Hashed ID" required: true schema: type: string @@ -13749,118 +12769,112 @@ paths: example: D2J234DFA responses: 200: - description: 'Returns the Webhook object' + description: "Returns the Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks/create: get: tags: - webhooks - summary: 'Gets a new blank Webhook object' - description: 'Returns a blank object with default values' + summary: "Gets a new blank Webhook object" + description: "Returns a blank object with default values" operationId: getWebhooksCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A blank Webhook object' + description: "A blank Webhook object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" /api/v1/webhooks/bulk: post: tags: - webhooks - summary: 'Performs bulk actions on an array of Webhooks' - description: '' + summary: "Performs bulk actions on an array of Webhooks" + description: "" operationId: bulkWebhooks parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'User credentials' + description: "User credentials" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Webhook User response' + description: "The Webhook User response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Webhook' + $ref: "#/components/schemas/Webhook" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' \ No newline at end of file + $ref: "#/components/schemas/Error" diff --git a/openapi/paths/clients.yaml b/openapi/paths/clients.yaml index 41f50989853f..261abd6dc9b7 100644 --- a/openapi/paths/clients.yaml +++ b/openapi/paths/clients.yaml @@ -7,72 +7,60 @@ Lists clients. Fine grained filtering is also available using query parameters. operationId: getClients parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - $ref: '#/components/parameters/index' - - - name: name + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/index' + - name: name in: query description: Filter by client name required: false schema: type: string example: bob - - - name: balance + - name: balance in: query description: Filter by client balance, format uses an operator and value separated by a colon. lt,lte, gt, gte, eq required: false schema: type: string example: lt:10 - - - name: between_balance + - name: between_balance in: query description: Filter between client balances, format uses two values separated by a colon required: false schema: type: string example: 10:100 - - - name: email + - name: email in: query description: Filter by client email required: false schema: type: string example: bob@gmail.com - - - name: id_number + - name: id_number in: query description: Filter by client id_number required: false schema: type: string example: a1039883 - - - name: number + - name: number in: query description: Filter by client number required: false schema: type: string example: a1039883 - - - name: filter + - name: filter in: query description: Filters clients on columns - name, id_number, contact.first_name contact.last_name, contact.email, custom_value1-4 required: false schema: type: string example: a1039883 - - - name: sort + - name: sort in: query description: Returns the list sorted by column in ascending or descending order. required: false @@ -101,36 +89,21 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' post: tags: - clients summary: 'Create client' - description: 'Adds an client to a company' + description: 'Adds a client to a company' operationId: storeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' responses: 200: description: 'Returns the saved client object' @@ -152,23 +125,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}': get: tags: @@ -177,74 +138,10 @@ description: 'Displays a client by id' operationId: showClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id - in: path - description: 'The Client Hashed ID' - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: 'Returns the cl.ient 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/Client' - 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' - 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - put: - tags: - - clients - summary: 'Update client' - description: 'Handles the updating of a client by id' - operationId: updateClient - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -273,23 +170,55 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' + $ref: '#/components/responses/default' + put: + tags: + - clients + summary: 'Update client' + description: 'Handles the updating of a client by id' + operationId: updateClient + parameters: + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id + in: path + description: 'The Client Hashed ID' + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: 'Returns the client object' + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + X-RateLimit-Remaining: + $ref: '#/components/headers/X-RateLimit-Remaining' + X-RateLimit-Limit: + $ref: '#/components/headers/X-RateLimit-Limit' content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/schemas/Client' + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' delete: tags: - clients @@ -297,14 +226,10 @@ description: 'Handles the deletion of a client by id' operationId: deleteClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -329,23 +254,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/edit': get: tags: @@ -354,14 +267,10 @@ description: 'Displays a client by id' operationId: editClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -390,23 +299,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/clients/create: get: tags: @@ -415,12 +312,9 @@ description: 'Returns a blank object with default values' operationId: getClientsCreate parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' responses: 200: description: 'A blank client object' @@ -442,37 +336,22 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/clients/bulk: post: tags: - clients - summary: 'Bulk actions' - description: '' + summary: 'Bulk client actions' + description: 'Archive / Restore / Delete in bulk' operationId: bulkClients parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/index' requestBody: description: 'User credentials' required: true @@ -505,23 +384,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/upload': put: tags: @@ -530,14 +397,10 @@ description: 'Handles the uploading of a document to a client, please note due to a quirk in REST you will need to use a _method parameter with value of POST' operationId: uploadClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -581,23 +444,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/purge': post: tags: @@ -606,14 +457,10 @@ description: 'Handles purging a client' operationId: purgeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -638,23 +485,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' '/api/v1/clients/{id}/{mergeable_client_hashed_id}/merge': post: tags: @@ -663,14 +498,10 @@ description: 'Handles merging 2 clients' operationId: mergeClient parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/client_include' - - - name: id + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/client_include' + - name: id in: path description: 'The Client Hashed ID' required: true @@ -678,8 +509,7 @@ type: string format: string example: D2J234DFA - - - name: mergeable_client_hashed_id + - name: mergeable_client_hashed_id in: path description: 'The Mergeable Client Hashed ID' required: true @@ -704,23 +534,11 @@ schema: $ref: '#components/schemas/AuthenticationError' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' + $ref: '#/components/responses/default' /api/v1/client_statement: post: tags: @@ -729,12 +547,9 @@ description: 'Return a PDF of the client statement' operationId: clientStatement parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: '#/components/parameters/X-API-TOKEN' + - $ref: '#/components/parameters/X-Requested-With' + - $ref: '#/components/parameters/include' requestBody: description: 'Statment Options' required: true @@ -773,26 +588,10 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + $ref: '#/components/responses/403' 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' + $ref: '#/components/responses/422' default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' \ No newline at end of file + $ref: '#/components/responses/default' \ No newline at end of file diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index a93b65a9a593..2cecf78a3a1d 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -2,139 +2,104 @@ get: tags: - products - summary: 'List products' - description: "Lists products, 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 products, these are handled by the ProductFilters class which defines the methods available" + summary: "List products" + description: | + Lists products, search and filters allow fine grained lists to be generated. + Query parameters can be added to perform fine grained filtering of the products list, these are handled by the ProductFilters class + which defines the methods available operationId: getProducts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'A list of products' + description: "A list of products" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" post: tags: - products - summary: 'Create Product' - description: 'Adds an Product to the system' + summary: "Create Product" + description: "Adds a product to a company" operationId: storeProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" responses: 200: - description: 'Returns the saved Product object' + description: "Returns the saved product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - /api/v1/products/create: + $ref: "#/components/schemas/Error" + "/api/v1/products/{id}": get: tags: - products - summary: 'Create product' - description: 'Returns a blank object with default values' - operationId: getProductsCreate - parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - responses: - 200: - description: 'A blank Product 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/Product' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}': - get: - tags: - - products - summary: 'Show product' - description: 'Displays an Product by id' + summary: "Show product" + description: "Displays a product by id" operationId: showProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -142,47 +107,55 @@ example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" put: tags: - products - summary: 'Update product' - description: 'Handles the updating of an Product by id' + summary: "Update product" + description: "Handles the updating of a product by id" operationId: updateProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -190,47 +163,55 @@ example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" delete: tags: - products - summary: 'Delete product' - description: 'Handles the deletion of an Product by id' + summary: "Delete product" + description: "Handles the deletion of a product by id" operationId: deleteProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -238,44 +219,52 @@ example: D2J234DFA responses: 200: - description: 'Returns a HTTP status' + description: "Returns a HTTP status" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/edit': + $ref: "#/components/schemas/Error" + "/api/v1/products/{id}/edit": get: tags: - products - summary: 'Edit product' - description: 'Displays an Product by id' + summary: "Edit product" + description: "Displays an Product by id" operationId: editProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string @@ -283,127 +272,221 @@ example: D2J234DFA responses: 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' + $ref: "#/components/schemas/Error" + "/api/v1/products/create": + get: + tags: + - products + summary: "Blank product" + description: "Returns a blank product object with default values" + operationId: getProductsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank Product 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/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" + 422: + description: "Validation error" + content: + application/json: + schema: + $ref: "#/components/schemas/ValidationError" + default: + description: "Unexpected Error" + content: + application/json: + schema: + $ref: "#/components/schemas/Error" + /api/v1/products/bulk: post: tags: - products - summary: 'Bulk product actions' - description: '' + summary: "Bulk product actions" + description: "Archive / Restore / Delete in bulk" operationId: bulkProducts parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/index' + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" requestBody: - description: 'Hashed IDs' + description: "Hashed IDs" required: true content: application/json: schema: type: array items: - description: 'Array of hashed IDs to be bulk ''actioned' + description: "Array of hashed IDs to be bulk 'actioned" type: integer - example: '[0,1,2,3]' + example: "[0,1,2,3]" responses: 200: - description: 'The Product response' + description: "The Product response" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' - '/api/v1/products/{id}/upload': + $ref: "#/components/schemas/Error" + + "/api/v1/products/{id}/upload": put: tags: - products - summary: 'Add product document' - description: 'Handles the uploading of a document to a product' + summary: "Add product document" + description: "Handles the uploading of a document to a product" operationId: uploadProduct parameters: - - - $ref: '#/components/parameters/X-API-TOKEN' - - - $ref: '#/components/parameters/X-Requested-With' - - - $ref: '#/components/parameters/include' - - - name: id + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/client_include" + - name: id in: path - description: 'The Product Hashed ID' + description: "The Product Hashed ID" required: true schema: type: string format: string example: D2J234DFA - responses: + produces: + - application/json + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + _method: + type: string + example: POST + documents: + type: array + format: binary 200: - description: 'Returns the Product object' + description: "Returns the Product object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Product' + $ref: "#/components/schemas/Product" + 401: + description: "Authentication error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthenticationError" + 403: + description: "Authorization error" + content: + application/json: + schema: + $ref: "#components/schemas/AuthorizationError" 422: - description: 'Validation error' + description: "Validation error" content: application/json: schema: - $ref: '#/components/schemas/ValidationError' + $ref: "#/components/schemas/ValidationError" default: - description: 'Unexpected Error' + description: "Unexpected Error" content: application/json: schema: - $ref: '#/components/schemas/Error' \ No newline at end of file + $ref: "#/components/schemas/Error" From aef722e0f8dedb1e743fdda295018ad468b1e805 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 15:08:56 +1100 Subject: [PATCH 05/33] OpenAPI docs --- app/Console/Commands/OpenApiYaml.php | 14 +- openapi/api-docs.yaml | 4223 +++++---------------- openapi/components/responses.yaml | 1 + openapi/components/responses/401.yaml | 11 +- openapi/components/responses/403.yaml | 11 +- openapi/components/responses/422.yaml | 11 +- openapi/components/responses/default.yaml | 11 +- openapi/components/schemas.yaml | 1 - openapi/paths.yaml | 3922 +++++-------------- openapi/paths/clients.yaml | 66 +- openapi/paths/products.yaml | 208 +- 11 files changed, 1875 insertions(+), 6604 deletions(-) create mode 100644 openapi/components/responses.yaml diff --git a/app/Console/Commands/OpenApiYaml.php b/app/Console/Commands/OpenApiYaml.php index 06ea62e50eaf..5c22ad0c8487 100644 --- a/app/Console/Commands/OpenApiYaml.php +++ b/app/Console/Commands/OpenApiYaml.php @@ -79,9 +79,18 @@ 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')); + + $directory = new DirectoryIterator($path . '/components/responses/'); + + foreach ($directory as $file) { + if ($file->isFile() && ! $file->isDot()) { + Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents("{$path}/components/responses/{$file->getFilename()}")); + } + } + Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/schemas.yaml')); //iterate schemas @@ -94,6 +103,7 @@ class OpenApiYaml extends Command } } + // Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/components/schemas/account.yaml')); Storage::disk('base')->append('/openapi/api-docs.yaml', file_get_contents($path.'/misc/misc.yaml')); } diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 8cc1473948d5..e198184e4d84 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -52,11 +52,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -95,11 +91,7 @@ paths: 404: description: "No file exists for the given record" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -154,11 +146,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -204,21 +192,13 @@ paths: schema: $ref: "#/components/schemas/CompanyUser" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/yodlee/refresh: post: tags: @@ -244,21 +224,13 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations: get: tags: @@ -294,21 +266,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - bank_integrations @@ -334,21 +298,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_integrations/{id}": get: tags: @@ -383,21 +339,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - bank_integrations @@ -431,21 +379,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - bank_integrations @@ -475,21 +415,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_integrations/{id}/edit": get: tags: @@ -524,21 +456,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/create: get: tags: @@ -565,21 +489,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/bulk: post: tags: @@ -612,18 +528,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/refresh_accounts: post: tags: @@ -649,18 +561,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankIntegration" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/remove_account/account_id: post: tags: @@ -686,18 +594,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankIntegration" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/get_transactions/account_id: post: tags: @@ -723,18 +627,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankIntegration" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transactions: get: tags: @@ -769,18 +669,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - bank_transactions @@ -805,18 +701,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_transactions/{id}": get: tags: @@ -850,18 +742,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - bank_transactions @@ -894,18 +782,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - bank_transactions @@ -934,18 +818,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_transactions/{id}/edit": get: tags: @@ -979,18 +859,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transactions/create: get: tags: @@ -1016,18 +892,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transations/bulk: post: tags: @@ -1060,18 +932,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transations/match: post: tags: @@ -1104,18 +972,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transaction_rules: get: tags: @@ -1150,18 +1014,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - bank_transaction_rules @@ -1186,18 +1046,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_transaction_rules/{id}": get: tags: @@ -1231,18 +1087,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - bank_transaction_rules @@ -1275,18 +1127,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - bank_transaction_rules @@ -1315,18 +1163,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_transaction_rules/{id}/edit": get: tags: @@ -1360,18 +1204,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transaction_rules/create: get: tags: @@ -1397,18 +1237,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transation_rules/bulk: post: tags: @@ -1441,18 +1277,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/charts/totals: post: tags: @@ -1484,17 +1316,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/client_gateway_tokens: get: @@ -1522,18 +1346,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - client_gateway_tokens @@ -1558,18 +1378,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/client_gateway_tokens/{id}": get: tags: @@ -1603,18 +1419,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - client_gateway_tokens @@ -1647,18 +1459,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - client_gateway_tokens @@ -1687,18 +1495,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/client_gateway_tokens/{id}/edit": get: tags: @@ -1732,18 +1536,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/client_gateway_tokens/create: get: tags: @@ -1769,18 +1569,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/companies: get: @@ -1807,18 +1603,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - companies @@ -1843,18 +1635,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/companies/create: get: tags: @@ -1880,18 +1668,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/companies/{id}": get: tags: @@ -1925,18 +1709,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - companies @@ -1969,18 +1749,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - companies @@ -2009,18 +1785,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/companies/{id}/edit": get: tags: @@ -2054,18 +1826,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/companies/{id}/upload": put: tags: @@ -2099,18 +1867,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/companies/{company}/default": post: tags: @@ -2144,18 +1908,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_gateways: get: tags: @@ -2181,18 +1941,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - company_gateways @@ -2218,17 +1974,9 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_gateways/create: get: tags: @@ -2254,18 +2002,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/company_gateways/{id}": get: tags: @@ -2299,18 +2043,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - company_gateways @@ -2343,18 +2083,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - company_gateways @@ -2383,18 +2119,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/company_gateways/{id}/edit": get: tags: @@ -2428,18 +2160,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_gateways/bulk: post: tags: @@ -2476,18 +2204,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_ledger: get: tags: @@ -2513,18 +2237,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyLedger" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_users: post: tags: @@ -2548,18 +2268,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyUser" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/connected_account: post: tags: @@ -2587,18 +2303,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/credits: get: tags: @@ -2624,18 +2336,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - credits @@ -2660,18 +2368,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/credits/create: get: tags: @@ -2697,18 +2401,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/credits/{id}": get: tags: @@ -2742,18 +2442,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - Credits @@ -2786,18 +2482,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - credits @@ -2826,18 +2518,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/credits/{id}/edit": get: tags: @@ -2871,18 +2559,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/credits/bulk: post: tags: @@ -2915,18 +2599,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/credit/{invitation_key}/download": get: tags: @@ -2956,18 +2636,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/credits/{id}/upload": put: tags: @@ -3001,18 +2677,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/designs: get: tags: @@ -3039,18 +2711,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - designs @@ -3075,18 +2743,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/designs/{id}": get: tags: @@ -3120,18 +2784,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - designs @@ -3164,18 +2824,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - designs @@ -3205,17 +2861,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/designs/{id}/edit": get: tags: @@ -3250,17 +2898,9 @@ paths: schema: $ref: "#/components/schemas/Design" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/designs/create: get: tags: @@ -3287,17 +2927,9 @@ paths: schema: $ref: "#/components/schemas/Design" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/designs/bulk: post: tags: @@ -3335,17 +2967,9 @@ paths: schema: $ref: "#/components/schemas/Design" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/documents: get: tags: @@ -3373,17 +2997,9 @@ paths: schema: $ref: "#/components/schemas/Document" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/emails: post: tags: @@ -3431,17 +3047,9 @@ paths: schema: $ref: "#/components/schemas/Template" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expense_categories: get: tags: @@ -3466,17 +3074,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - expense_categories @@ -3502,17 +3102,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expense_categories/create: get: tags: @@ -3538,17 +3130,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expense_categories/{id}": get: tags: @@ -3582,17 +3166,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - expense_categories @@ -3625,17 +3201,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - expense_categories @@ -3664,17 +3232,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expense_categories/{id}/edit": get: tags: @@ -3708,17 +3268,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expense_categories/bulk: post: tags: @@ -3756,17 +3308,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expenses: get: tags: @@ -3794,17 +3338,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - expenses @@ -3830,17 +3366,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expenses/{id}": get: tags: @@ -3875,17 +3403,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - expenses @@ -3919,17 +3439,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - expenses @@ -3959,17 +3471,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expenses/{id}/edit": get: tags: @@ -4004,17 +3508,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expenses/create: get: tags: @@ -4041,17 +3537,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expenses/bulk: post: tags: @@ -4089,17 +3577,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expenses/{id}/upload": put: tags: @@ -4134,17 +3614,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/export: post: tags: @@ -4165,17 +3637,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/group_settings: get: tags: @@ -4202,17 +3666,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - group_settings @@ -4238,17 +3694,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/group_settings/create: get: tags: @@ -4275,17 +3723,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/group_settings/{id}": get: tags: @@ -4320,17 +3760,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - group_settings @@ -4364,17 +3796,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - group_settings @@ -4404,17 +3828,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/group_settings/{id}/edit": get: tags: @@ -4449,17 +3865,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/group_settings/bulk: post: tags: @@ -4493,17 +3901,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/group_settings/{id}/upload": put: tags: @@ -4538,17 +3938,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/preimport: post: tags: @@ -4579,17 +3971,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/import_json: post: tags: @@ -4610,17 +3994,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/apple/confirm_purchase: post: tags: @@ -4643,17 +4019,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/apple/process_webhook: post: tags: @@ -4676,17 +4044,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/invoices: get: tags: @@ -4713,17 +4073,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - invoices @@ -4755,17 +4107,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/invoices/create: get: tags: @@ -4792,17 +4136,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}": get: tags: @@ -4837,17 +4173,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - invoices @@ -4881,17 +4209,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - invoices @@ -4921,17 +4241,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}/edit": get: tags: @@ -4966,17 +4278,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/invoices/bulk: post: tags: @@ -5010,17 +4314,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}/{action}": get: tags: @@ -5063,17 +4359,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoice/{invitation_key}/download": get: tags: @@ -5104,17 +4392,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}/delivery_note": get: tags: @@ -5145,17 +4425,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}/upload": put: tags: @@ -5190,17 +4462,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/claim_license: get: tags: @@ -5237,17 +4501,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/logout: post: tags: @@ -5271,17 +4527,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/migration/purge/{company}": post: tags: @@ -5311,17 +4559,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/migration/purge_save_settings/{company}": post: tags: @@ -5351,17 +4591,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/migration/start: post: tags: @@ -5392,17 +4624,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/one_time_token: post: tags: @@ -5423,17 +4647,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payments: get: tags: @@ -5460,17 +4676,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - payments @@ -5503,17 +4711,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payments/create: get: tags: @@ -5540,17 +4740,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payments/{id}": get: tags: @@ -5585,17 +4777,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - payments @@ -5629,17 +4813,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - payments @@ -5669,17 +4845,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payments/{id}/edit": get: tags: @@ -5714,17 +4882,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payments/bulk: post: tags: @@ -5762,17 +4922,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payments/{id}/{action}": get: tags: @@ -5815,17 +4967,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payments/refund: post: tags: @@ -5859,17 +5003,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payments/{id}/upload": put: tags: @@ -5904,17 +5040,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payment_terms: get: tags: @@ -5942,17 +5070,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - payment_terms @@ -5985,17 +5105,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payment_terms/create: get: tags: @@ -6022,17 +5134,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payment_terms/{id}": get: tags: @@ -6067,17 +5171,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - payment_terms @@ -6111,17 +5207,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - payment_termss @@ -6151,17 +5239,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payment_terms/{id}/edit": get: tags: @@ -6196,17 +5276,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payment_terms/bulk: post: tags: @@ -6244,17 +5316,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/ping: get: tags: @@ -6319,17 +5383,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/preview: post: tags: @@ -6350,17 +5406,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/preview/purchase_order: post: tags: @@ -6381,17 +5429,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/projects: get: @@ -6420,17 +5460,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - projects @@ -6456,17 +5488,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/projects/{id}": get: tags: @@ -6501,17 +5525,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - projects @@ -6545,17 +5561,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - projects @@ -6585,17 +5593,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/projects/{id}/edit": get: tags: @@ -6630,17 +5630,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/projects/create: get: tags: @@ -6667,17 +5659,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/projects/bulk: post: tags: @@ -6715,17 +5699,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/projects/{id}/upload": put: tags: @@ -6760,17 +5736,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/purchase_orders: get: tags: @@ -6797,17 +5765,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - purhcase_orders @@ -6833,17 +5793,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/purchase_orders/create: get: tags: @@ -6870,17 +5822,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_orders/{id}": get: tags: @@ -6915,17 +5859,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - purchase_orders @@ -6955,17 +5891,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_orders/{id}/edit": get: tags: @@ -7000,17 +5928,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_order/{id}": put: tags: @@ -7045,17 +5965,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/purchase_orders/bulk: post: tags: @@ -7089,17 +6001,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_orders/{id}/{action}": get: tags: @@ -7142,17 +6046,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_orders/{id}/upload": put: tags: @@ -7187,17 +6083,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_order/{invitation_key}/download": get: tags: @@ -7228,17 +6116,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/quotes: get: tags: @@ -7265,17 +6145,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - quotes @@ -7301,17 +6173,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/quotes/create: get: tags: @@ -7338,17 +6202,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quotes/{id}": get: tags: @@ -7383,17 +6239,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - quotes @@ -7427,17 +6275,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - quotes @@ -7467,17 +6307,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quotes/{id}/edit": get: tags: @@ -7512,17 +6344,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/quotes/bulk: post: tags: @@ -7560,17 +6384,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quotes/{id}/{action}": get: tags: @@ -7613,17 +6429,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quote/{invitation_key}/download": get: tags: @@ -7654,17 +6462,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quotes/{id}/upload": put: tags: @@ -7699,17 +6499,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_expenses: get: tags: @@ -7737,17 +6529,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - recurring_expenses @@ -7773,17 +6557,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_expenses/{id}": get: tags: @@ -7818,17 +6594,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - recurring_expenses @@ -7862,17 +6630,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - recurring_expenses @@ -7902,17 +6662,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_expenses/{id}/edit": get: tags: @@ -7947,17 +6699,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_expenses/create: get: tags: @@ -7984,17 +6728,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_expenses/bulk: post: tags: @@ -8032,17 +6768,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_expenses/{id}/upload": put: tags: @@ -8077,17 +6805,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_invoices: get: tags: @@ -8114,17 +6834,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - recurring_invoices @@ -8150,17 +6862,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_invoices/create: get: tags: @@ -8187,17 +6891,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoices/{id}": get: tags: @@ -8232,17 +6928,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - recurring_invoices @@ -8276,17 +6964,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - recurring_invoices @@ -8316,17 +6996,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoices/{id}/edit": get: tags: @@ -8361,17 +7033,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: @@ -8402,17 +7066,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_invoices/bulk: post: tags: @@ -8450,17 +7106,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoices/{id}/{action}": get: tags: @@ -8503,17 +7151,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoices/{id}/upload": put: tags: @@ -8548,17 +7188,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_quotes: get: tags: @@ -8585,17 +7217,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - recurring_quotes @@ -8621,17 +7245,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_quotes/create: get: tags: @@ -8658,17 +7274,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_quotes/{id}": get: tags: @@ -8703,17 +7311,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - recurring_quotes @@ -8747,17 +7347,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - recurring_quotes @@ -8787,17 +7379,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_quotes/{id}/edit": get: tags: @@ -8832,17 +7416,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_quotes/bulk: post: tags: @@ -8880,17 +7456,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_quotes/{id}/{action}": get: tags: @@ -8933,17 +7501,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/contacts: post: tags: @@ -8970,17 +7530,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/clients: post: tags: @@ -9007,17 +7559,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/credit: post: tags: @@ -9044,17 +7588,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/documents: post: tags: @@ -9081,17 +7617,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/expense: post: tags: @@ -9118,17 +7646,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/invoice_items: post: tags: @@ -9155,17 +7675,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/invoices: post: tags: @@ -9192,17 +7704,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/payments: post: tags: @@ -9229,17 +7733,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/products: post: tags: @@ -9266,17 +7762,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/product_sales: post: tags: @@ -9303,17 +7791,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/profitloss: post: tags: @@ -9340,17 +7820,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/quote_items: post: tags: @@ -9377,17 +7849,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/quotes: post: tags: @@ -9414,17 +7878,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/recurring_invoices: post: tags: @@ -9451,17 +7907,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/tasks: post: tags: @@ -9488,17 +7936,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/self-update: post: tags: @@ -9515,17 +7955,9 @@ paths: 200: description: "Success/failure response" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/statics: get: tags: @@ -9548,17 +7980,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/subscriptions: get: tags: @@ -9585,17 +8009,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - subscriptions @@ -9621,17 +8037,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/subscriptions/create: get: tags: @@ -9658,17 +8066,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/subscriptions/{id}": get: tags: @@ -9703,17 +8103,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - subscriptions @@ -9747,17 +8139,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - subscriptions @@ -9787,17 +8171,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/subscriptions/{id}/edit": get: tags: @@ -9832,17 +8208,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/subscriptions/bulk: post: tags: @@ -9880,17 +8248,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/support/messages/send: post: tags: @@ -9931,11 +8291,7 @@ paths: type: string example: true default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/system_logs: get: tags: @@ -9962,17 +8318,9 @@ paths: schema: $ref: "#/components/schemas/SystemLog" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/system_logs/{id}": get: tags: @@ -10007,17 +8355,9 @@ paths: schema: $ref: "#/components/schemas/SystemLog" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tasks: get: tags: @@ -10045,17 +8385,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - tasks @@ -10081,17 +8413,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tasks/{id}": get: tags: @@ -10126,17 +8450,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - tasks @@ -10170,17 +8486,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - tasks @@ -10210,17 +8518,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tasks/{id}/edit": get: tags: @@ -10255,17 +8555,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tasks/create: get: tags: @@ -10292,17 +8584,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tasks/bulk: post: tags: @@ -10340,17 +8624,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tasks/{id}/upload": put: tags: @@ -10385,17 +8661,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tasks/stort: post: tags: @@ -10418,17 +8686,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_schedulers/: get: tags: @@ -10449,11 +8709,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - task_schedulers @@ -10480,17 +8736,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/invoices/task_schedulers: get: tags: @@ -10517,17 +8765,9 @@ paths: schema: $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/task_schedulers/{id}": get: tags: @@ -10556,11 +8796,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - task_schedulers @@ -10595,17 +8831,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - task_schedulers @@ -10633,11 +8861,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_schedulers/bulk: post: tags: @@ -10675,17 +8899,9 @@ paths: schema: $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_statuses: get: tags: @@ -10713,17 +8929,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - task_status @@ -10756,17 +8964,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_statuses/create: get: tags: @@ -10793,17 +8993,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/task_statuses/{id}": get: tags: @@ -10838,17 +9030,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - task_status @@ -10882,17 +9066,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - task_statuss @@ -10922,17 +9098,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/task_statuses/{id}/edit": get: tags: @@ -10967,17 +9135,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_statuses/bulk: post: tags: @@ -11015,17 +9175,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tax_rates: get: tags: @@ -11050,17 +9202,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tax_rates/create: get: tags: @@ -11086,17 +9230,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tax_rates/{id}": get: tags: @@ -11130,17 +9266,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - tax_rates @@ -11173,17 +9301,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - tax_rates @@ -11212,17 +9332,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tax_rates/{id}/edit": get: tags: @@ -11256,17 +9368,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tax_rates/bulk: post: tags: @@ -11304,17 +9408,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/templates: post: tags: @@ -11353,17 +9449,9 @@ paths: schema: $ref: "#/components/schemas/Template" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tokens: get: tags: @@ -11391,17 +9479,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - tokens @@ -11427,17 +9507,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tokens/{id}": get: tags: @@ -11472,17 +9544,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - tokens @@ -11516,17 +9580,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - tokens @@ -11556,17 +9612,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tokens/{id}/edit": get: tags: @@ -11601,17 +9649,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tokens/create: get: tags: @@ -11638,17 +9678,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tokens/bulk: post: tags: @@ -11686,17 +9718,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/users: get: tags: @@ -11723,17 +9747,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - users @@ -11759,17 +9775,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/users/create: get: tags: @@ -11796,17 +9804,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{id}": get: tags: @@ -11841,17 +9841,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - users @@ -11885,17 +9877,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - users @@ -11933,17 +9917,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{id}/edit": get: tags: @@ -11978,17 +9954,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/users/bulk: post: tags: @@ -12026,17 +9994,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{user}/detach_from_company": delete: tags: @@ -12067,17 +10027,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{user}/invite": post: tags: @@ -12108,17 +10060,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{user}/reconfirm": post: tags: @@ -12149,17 +10093,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/vendors: get: tags: @@ -12187,17 +10123,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - vendors @@ -12223,17 +10151,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/vendors/{id}": get: tags: @@ -12268,17 +10188,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - vendors @@ -12312,17 +10224,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - vendors @@ -12352,17 +10256,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/vendors/{id}/edit": get: tags: @@ -12397,17 +10293,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/vendors/create: get: tags: @@ -12434,17 +10322,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/vendors/bulk: post: tags: @@ -12482,17 +10362,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/vendors/{id}/upload": put: tags: @@ -12527,17 +10399,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/webcron: get: tags: @@ -12558,17 +10422,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/webhooks: get: tags: @@ -12596,17 +10452,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - webhooks @@ -12632,17 +10480,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/webhooks/{id}": get: tags: @@ -12677,17 +10517,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - webhooks @@ -12721,17 +10553,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - Webhooks @@ -12761,17 +10585,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/webhooks/{id}/edit": get: tags: @@ -12806,17 +10622,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/webhooks/create: get: tags: @@ -12843,17 +10651,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/webhooks/bulk: post: tags: @@ -12891,17 +10691,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/products: get: @@ -12932,29 +10724,13 @@ paths: schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - products @@ -12979,18 +10755,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/products/{id}": get: tags: @@ -13025,29 +10797,13 @@ paths: schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - products @@ -13081,29 +10837,13 @@ paths: schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - products @@ -13133,29 +10873,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/products/{id}/edit": get: tags: @@ -13190,29 +10914,13 @@ paths: schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/products/create": get: tags: @@ -13239,29 +10947,13 @@ paths: schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/products/bulk: post: @@ -13300,29 +10992,13 @@ paths: schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/products/{id}/upload": put: @@ -13372,29 +11048,13 @@ paths: schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/clients: get: @@ -13481,11 +11141,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13517,11 +11173,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13562,11 +11214,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13606,11 +11254,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13646,11 +11290,7 @@ paths: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13691,11 +11331,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13728,11 +11364,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13776,11 +11408,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13836,11 +11464,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13877,11 +11501,7 @@ paths: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -13926,11 +11546,7 @@ paths: X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -14204,8 +11820,33 @@ components: type: apiKey in: header name: X-API-TOKEN - schemas: + responses: + 403: + description: 'Authorization error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthorizationError' + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + schemas: BankTransactionRule: properties: id: diff --git a/openapi/components/responses.yaml b/openapi/components/responses.yaml new file mode 100644 index 000000000000..0a28634fc9d8 --- /dev/null +++ b/openapi/components/responses.yaml @@ -0,0 +1 @@ + responses: \ No newline at end of file diff --git a/openapi/components/responses/401.yaml b/openapi/components/responses/401.yaml index 69425b37899f..6d28c573cdb9 100644 --- a/openapi/components/responses/401.yaml +++ b/openapi/components/responses/401.yaml @@ -1,5 +1,6 @@ -description: 'Authentication error' -content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' \ No newline at end of file + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' \ No newline at end of file diff --git a/openapi/components/responses/403.yaml b/openapi/components/responses/403.yaml index 19061bac43d1..4006e9873bab 100644 --- a/openapi/components/responses/403.yaml +++ b/openapi/components/responses/403.yaml @@ -1,5 +1,6 @@ -description: 'Authorization error' -content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' \ No newline at end of file + 403: + description: 'Authorization error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthorizationError' \ No newline at end of file diff --git a/openapi/components/responses/422.yaml b/openapi/components/responses/422.yaml index ef144eae1cd2..9f501539dda8 100644 --- a/openapi/components/responses/422.yaml +++ b/openapi/components/responses/422.yaml @@ -1,5 +1,6 @@ -description: 'Validation error' -content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' \ No newline at end of file + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' \ No newline at end of file diff --git a/openapi/components/responses/default.yaml b/openapi/components/responses/default.yaml index a3bf73e8979e..e88a677ff25e 100644 --- a/openapi/components/responses/default.yaml +++ b/openapi/components/responses/default.yaml @@ -1,5 +1,6 @@ -description: 'Unexpected Error' -content: - application/json: - schema: - $ref: '#/components/schemas/Error' \ No newline at end of file + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' \ No newline at end of file diff --git a/openapi/components/schemas.yaml b/openapi/components/schemas.yaml index 6b5e699ddcbb..575dea7f8a21 100644 --- a/openapi/components/schemas.yaml +++ b/openapi/components/schemas.yaml @@ -1,5 +1,4 @@ schemas: - BankTransactionRule: properties: id: diff --git a/openapi/paths.yaml b/openapi/paths.yaml index 245d6784c4e2..747691ef9e50 100644 --- a/openapi/paths.yaml +++ b/openapi/paths.yaml @@ -28,11 +28,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -71,11 +67,7 @@ paths: 404: description: "No file exists for the given record" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -130,11 +122,7 @@ paths: schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -180,21 +168,13 @@ paths: schema: $ref: "#/components/schemas/CompanyUser" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/yodlee/refresh: post: tags: @@ -220,21 +200,13 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations: get: tags: @@ -270,21 +242,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - bank_integrations @@ -310,21 +274,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_integrations/{id}": get: tags: @@ -359,21 +315,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - bank_integrations @@ -407,21 +355,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - bank_integrations @@ -451,21 +391,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_integrations/{id}/edit": get: tags: @@ -500,21 +432,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/create: get: tags: @@ -541,21 +465,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/bulk: post: tags: @@ -588,18 +504,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/refresh_accounts: post: tags: @@ -625,18 +537,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankIntegration" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/remove_account/account_id: post: tags: @@ -662,18 +570,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankIntegration" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_integrations/get_transactions/account_id: post: tags: @@ -699,18 +603,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankIntegration" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transactions: get: tags: @@ -745,18 +645,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - bank_transactions @@ -781,18 +677,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_transactions/{id}": get: tags: @@ -826,18 +718,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - bank_transactions @@ -870,18 +758,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - bank_transactions @@ -910,18 +794,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_transactions/{id}/edit": get: tags: @@ -955,18 +835,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transactions/create: get: tags: @@ -992,18 +868,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransaction" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transations/bulk: post: tags: @@ -1036,18 +908,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transations/match: post: tags: @@ -1080,18 +948,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transaction_rules: get: tags: @@ -1126,18 +990,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - bank_transaction_rules @@ -1162,18 +1022,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_transaction_rules/{id}": get: tags: @@ -1207,18 +1063,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - bank_transaction_rules @@ -1251,18 +1103,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - bank_transaction_rules @@ -1291,18 +1139,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/bank_transaction_rules/{id}/edit": get: tags: @@ -1336,18 +1180,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transaction_rules/create: get: tags: @@ -1373,18 +1213,14 @@ paths: application/json: schema: $ref: "#/components/schemas/BankTransactionRule" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/bank_transation_rules/bulk: post: tags: @@ -1417,18 +1253,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/charts/totals: post: tags: @@ -1460,17 +1292,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/client_gateway_tokens: get: @@ -1498,18 +1322,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - client_gateway_tokens @@ -1534,18 +1354,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/client_gateway_tokens/{id}": get: tags: @@ -1579,18 +1395,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - client_gateway_tokens @@ -1623,18 +1435,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - client_gateway_tokens @@ -1663,18 +1471,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/client_gateway_tokens/{id}/edit": get: tags: @@ -1708,18 +1512,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/client_gateway_tokens/create: get: tags: @@ -1745,18 +1545,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ClientGatewayToken" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/companies: get: @@ -1783,18 +1579,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - companies @@ -1819,18 +1611,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/companies/create: get: tags: @@ -1856,18 +1644,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/companies/{id}": get: tags: @@ -1901,18 +1685,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - companies @@ -1945,18 +1725,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - companies @@ -1985,18 +1761,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/companies/{id}/edit": get: tags: @@ -2030,18 +1802,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/companies/{id}/upload": put: tags: @@ -2075,18 +1843,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/companies/{company}/default": post: tags: @@ -2120,18 +1884,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Company" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_gateways: get: tags: @@ -2157,18 +1917,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - company_gateways @@ -2194,17 +1950,9 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_gateways/create: get: tags: @@ -2230,18 +1978,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/company_gateways/{id}": get: tags: @@ -2275,18 +2019,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - company_gateways @@ -2319,18 +2059,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - company_gateways @@ -2359,18 +2095,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/company_gateways/{id}/edit": get: tags: @@ -2404,18 +2136,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_gateways/bulk: post: tags: @@ -2452,18 +2180,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_ledger: get: tags: @@ -2489,18 +2213,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyLedger" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/company_users: post: tags: @@ -2524,18 +2244,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyUser" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/connected_account: post: tags: @@ -2563,18 +2279,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/credits: get: tags: @@ -2600,18 +2312,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - credits @@ -2636,18 +2344,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/credits/create: get: tags: @@ -2673,18 +2377,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/credits/{id}": get: tags: @@ -2718,18 +2418,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - Credits @@ -2762,18 +2458,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - credits @@ -2802,18 +2494,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/credits/{id}/edit": get: tags: @@ -2847,18 +2535,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/credits/bulk: post: tags: @@ -2891,18 +2575,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/credit/{invitation_key}/download": get: tags: @@ -2932,18 +2612,14 @@ paths: $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: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/credits/{id}/upload": put: tags: @@ -2977,18 +2653,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/designs: get: tags: @@ -3015,18 +2687,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - designs @@ -3051,18 +2719,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/designs/{id}": get: tags: @@ -3096,18 +2760,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - designs @@ -3140,18 +2800,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - designs @@ -3181,17 +2837,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/designs/{id}/edit": get: tags: @@ -3226,17 +2874,9 @@ paths: schema: $ref: "#/components/schemas/Design" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/designs/create: get: tags: @@ -3263,17 +2903,9 @@ paths: schema: $ref: "#/components/schemas/Design" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/designs/bulk: post: tags: @@ -3311,17 +2943,9 @@ paths: schema: $ref: "#/components/schemas/Design" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/documents: get: tags: @@ -3349,17 +2973,9 @@ paths: schema: $ref: "#/components/schemas/Document" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/emails: post: tags: @@ -3407,17 +3023,9 @@ paths: schema: $ref: "#/components/schemas/Template" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expense_categories: get: tags: @@ -3442,17 +3050,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - expense_categories @@ -3478,17 +3078,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expense_categories/create: get: tags: @@ -3514,17 +3106,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expense_categories/{id}": get: tags: @@ -3558,17 +3142,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - expense_categories @@ -3601,17 +3177,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - expense_categories @@ -3640,17 +3208,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expense_categories/{id}/edit": get: tags: @@ -3684,17 +3244,9 @@ paths: schema: $ref: "#/components/schemas/ExpenseCategory" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expense_categories/bulk: post: tags: @@ -3732,17 +3284,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expenses: get: tags: @@ -3770,17 +3314,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - expenses @@ -3806,17 +3342,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expenses/{id}": get: tags: @@ -3851,17 +3379,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - expenses @@ -3895,17 +3415,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - expenses @@ -3935,17 +3447,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expenses/{id}/edit": get: tags: @@ -3980,17 +3484,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expenses/create: get: tags: @@ -4017,17 +3513,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/expenses/bulk: post: tags: @@ -4065,17 +3553,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/expenses/{id}/upload": put: tags: @@ -4110,17 +3590,9 @@ paths: schema: $ref: "#/components/schemas/Expense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/export: post: tags: @@ -4141,17 +3613,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/group_settings: get: tags: @@ -4178,17 +3642,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - group_settings @@ -4214,17 +3670,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/group_settings/create: get: tags: @@ -4251,17 +3699,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/group_settings/{id}": get: tags: @@ -4296,17 +3736,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - group_settings @@ -4340,17 +3772,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - group_settings @@ -4380,17 +3804,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/group_settings/{id}/edit": get: tags: @@ -4425,17 +3841,9 @@ paths: schema: $ref: "#/components/schemas/GroupSetting" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/group_settings/bulk: post: tags: @@ -4469,17 +3877,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/group_settings/{id}/upload": put: tags: @@ -4514,17 +3914,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/preimport: post: tags: @@ -4555,17 +3947,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/import_json: post: tags: @@ -4586,17 +3970,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/apple/confirm_purchase: post: tags: @@ -4619,17 +3995,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/apple/process_webhook: post: tags: @@ -4652,17 +4020,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/invoices: get: tags: @@ -4689,17 +4049,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - invoices @@ -4731,17 +4083,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/invoices/create: get: tags: @@ -4768,17 +4112,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}": get: tags: @@ -4813,17 +4149,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - invoices @@ -4857,17 +4185,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - invoices @@ -4897,17 +4217,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}/edit": get: tags: @@ -4942,17 +4254,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/invoices/bulk: post: tags: @@ -4986,17 +4290,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}/{action}": get: tags: @@ -5039,17 +4335,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoice/{invitation_key}/download": get: tags: @@ -5080,17 +4368,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}/delivery_note": get: tags: @@ -5121,17 +4401,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/invoices/{id}/upload": put: tags: @@ -5166,17 +4438,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/claim_license: get: tags: @@ -5213,17 +4477,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/logout: post: tags: @@ -5247,17 +4503,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/migration/purge/{company}": post: tags: @@ -5287,17 +4535,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/migration/purge_save_settings/{company}": post: tags: @@ -5327,17 +4567,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/migration/start: post: tags: @@ -5368,17 +4600,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/one_time_token: post: tags: @@ -5399,17 +4623,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payments: get: tags: @@ -5436,17 +4652,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - payments @@ -5479,17 +4687,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payments/create: get: tags: @@ -5516,17 +4716,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payments/{id}": get: tags: @@ -5561,17 +4753,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - payments @@ -5605,17 +4789,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - payments @@ -5645,17 +4821,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payments/{id}/edit": get: tags: @@ -5690,17 +4858,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payments/bulk: post: tags: @@ -5738,17 +4898,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payments/{id}/{action}": get: tags: @@ -5791,17 +4943,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payments/refund: post: tags: @@ -5835,17 +4979,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payments/{id}/upload": put: tags: @@ -5880,17 +5016,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payment_terms: get: tags: @@ -5918,17 +5046,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - payment_terms @@ -5961,17 +5081,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payment_terms/create: get: tags: @@ -5998,17 +5110,9 @@ paths: schema: $ref: "#/components/schemas/Payment" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payment_terms/{id}": get: tags: @@ -6043,17 +5147,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - payment_terms @@ -6087,17 +5183,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - payment_termss @@ -6127,17 +5215,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/payment_terms/{id}/edit": get: tags: @@ -6172,17 +5252,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/payment_terms/bulk: post: tags: @@ -6220,17 +5292,9 @@ paths: schema: $ref: "#/components/schemas/PaymentTerm" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/ping: get: tags: @@ -6295,17 +5359,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/preview: post: tags: @@ -6326,17 +5382,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/preview/purchase_order: post: tags: @@ -6357,17 +5405,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/projects: get: @@ -6396,17 +5436,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - projects @@ -6432,17 +5464,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/projects/{id}": get: tags: @@ -6477,17 +5501,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - projects @@ -6521,17 +5537,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - projects @@ -6561,17 +5569,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/projects/{id}/edit": get: tags: @@ -6606,17 +5606,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/projects/create: get: tags: @@ -6643,17 +5635,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/projects/bulk: post: tags: @@ -6691,17 +5675,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/projects/{id}/upload": put: tags: @@ -6736,17 +5712,9 @@ paths: schema: $ref: "#/components/schemas/Project" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/purchase_orders: get: tags: @@ -6773,17 +5741,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - purhcase_orders @@ -6809,17 +5769,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/purchase_orders/create: get: tags: @@ -6846,17 +5798,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_orders/{id}": get: tags: @@ -6891,17 +5835,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - purchase_orders @@ -6931,17 +5867,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_orders/{id}/edit": get: tags: @@ -6976,17 +5904,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_order/{id}": put: tags: @@ -7021,17 +5941,9 @@ paths: schema: $ref: "#/components/schemas/Credit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/purchase_orders/bulk: post: tags: @@ -7065,17 +5977,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_orders/{id}/{action}": get: tags: @@ -7118,17 +6022,9 @@ paths: schema: $ref: "#/components/schemas/Invoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_orders/{id}/upload": put: tags: @@ -7163,17 +6059,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/purchase_order/{invitation_key}/download": get: tags: @@ -7204,17 +6092,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/quotes: get: tags: @@ -7241,17 +6121,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - quotes @@ -7277,17 +6149,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/quotes/create: get: tags: @@ -7314,17 +6178,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quotes/{id}": get: tags: @@ -7359,17 +6215,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - quotes @@ -7403,17 +6251,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - quotes @@ -7443,17 +6283,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quotes/{id}/edit": get: tags: @@ -7488,17 +6320,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/quotes/bulk: post: tags: @@ -7536,17 +6360,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quotes/{id}/{action}": get: tags: @@ -7589,17 +6405,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quote/{invitation_key}/download": get: tags: @@ -7630,17 +6438,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/quotes/{id}/upload": put: tags: @@ -7675,17 +6475,9 @@ paths: schema: $ref: "#/components/schemas/Quote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_expenses: get: tags: @@ -7713,17 +6505,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - recurring_expenses @@ -7749,17 +6533,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_expenses/{id}": get: tags: @@ -7794,17 +6570,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - recurring_expenses @@ -7838,17 +6606,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - recurring_expenses @@ -7878,17 +6638,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_expenses/{id}/edit": get: tags: @@ -7923,17 +6675,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_expenses/create: get: tags: @@ -7960,17 +6704,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_expenses/bulk: post: tags: @@ -8008,17 +6744,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_expenses/{id}/upload": put: tags: @@ -8053,17 +6781,9 @@ paths: schema: $ref: "#/components/schemas/RecurringExpense" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_invoices: get: tags: @@ -8090,17 +6810,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - recurring_invoices @@ -8126,17 +6838,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_invoices/create: get: tags: @@ -8163,17 +6867,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoices/{id}": get: tags: @@ -8208,17 +6904,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - recurring_invoices @@ -8252,17 +6940,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - recurring_invoices @@ -8292,17 +6972,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoices/{id}/edit": get: tags: @@ -8337,17 +7009,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: @@ -8378,17 +7042,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_invoices/bulk: post: tags: @@ -8426,17 +7082,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoices/{id}/{action}": get: tags: @@ -8479,17 +7127,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_invoices/{id}/upload": put: tags: @@ -8524,17 +7164,9 @@ paths: schema: $ref: "#/components/schemas/RecurringInvoice" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_quotes: get: tags: @@ -8561,17 +7193,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - recurring_quotes @@ -8597,17 +7221,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_quotes/create: get: tags: @@ -8634,17 +7250,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_quotes/{id}": get: tags: @@ -8679,17 +7287,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - recurring_quotes @@ -8723,17 +7323,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - recurring_quotes @@ -8763,17 +7355,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_quotes/{id}/edit": get: tags: @@ -8808,17 +7392,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/recurring_quotes/bulk: post: tags: @@ -8856,17 +7432,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/recurring_quotes/{id}/{action}": get: tags: @@ -8909,17 +7477,9 @@ paths: schema: $ref: "#/components/schemas/RecurringQuote" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/contacts: post: tags: @@ -8946,17 +7506,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/clients: post: tags: @@ -8983,17 +7535,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/credit: post: tags: @@ -9020,17 +7564,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/documents: post: tags: @@ -9057,17 +7593,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/expense: post: tags: @@ -9094,17 +7622,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/invoice_items: post: tags: @@ -9131,17 +7651,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/invoices: post: tags: @@ -9168,17 +7680,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/payments: post: tags: @@ -9205,17 +7709,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/products: post: tags: @@ -9242,17 +7738,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/product_sales: post: tags: @@ -9279,17 +7767,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/profitloss: post: tags: @@ -9316,17 +7796,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/quote_items: post: tags: @@ -9353,17 +7825,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/quotes: post: tags: @@ -9390,17 +7854,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/recurring_invoices: post: tags: @@ -9427,17 +7883,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/reports/tasks: post: tags: @@ -9464,17 +7912,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/self-update: post: tags: @@ -9491,17 +7931,9 @@ paths: 200: description: "Success/failure response" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/statics: get: tags: @@ -9524,17 +7956,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/subscriptions: get: tags: @@ -9561,17 +7985,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - subscriptions @@ -9597,17 +8013,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/subscriptions/create: get: tags: @@ -9634,17 +8042,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/subscriptions/{id}": get: tags: @@ -9679,17 +8079,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - subscriptions @@ -9723,17 +8115,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - subscriptions @@ -9763,17 +8147,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/subscriptions/{id}/edit": get: tags: @@ -9808,17 +8184,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/subscriptions/bulk: post: tags: @@ -9856,17 +8224,9 @@ paths: schema: $ref: "#/components/schemas/Subscription" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/support/messages/send: post: tags: @@ -9907,11 +8267,7 @@ paths: type: string example: true default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/system_logs: get: tags: @@ -9938,17 +8294,9 @@ paths: schema: $ref: "#/components/schemas/SystemLog" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/system_logs/{id}": get: tags: @@ -9983,17 +8331,9 @@ paths: schema: $ref: "#/components/schemas/SystemLog" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tasks: get: tags: @@ -10021,17 +8361,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - tasks @@ -10057,17 +8389,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tasks/{id}": get: tags: @@ -10102,17 +8426,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - tasks @@ -10146,17 +8462,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - tasks @@ -10186,17 +8494,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tasks/{id}/edit": get: tags: @@ -10231,17 +8531,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tasks/create: get: tags: @@ -10268,17 +8560,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tasks/bulk: post: tags: @@ -10316,17 +8600,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tasks/{id}/upload": put: tags: @@ -10361,17 +8637,9 @@ paths: schema: $ref: "#/components/schemas/Task" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tasks/stort: post: tags: @@ -10394,17 +8662,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_schedulers/: get: tags: @@ -10425,11 +8685,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - task_schedulers @@ -10456,17 +8712,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/invoices/task_schedulers: get: tags: @@ -10493,17 +8741,9 @@ paths: schema: $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/task_schedulers/{id}": get: tags: @@ -10532,11 +8772,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - task_schedulers @@ -10571,17 +8807,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - task_schedulers @@ -10609,11 +8837,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_schedulers/bulk: post: tags: @@ -10651,17 +8875,9 @@ paths: schema: $ref: "#/components/schemas/TaskSchedulerSchema" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_statuses: get: tags: @@ -10689,17 +8905,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - task_status @@ -10732,17 +8940,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_statuses/create: get: tags: @@ -10769,17 +8969,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/task_statuses/{id}": get: tags: @@ -10814,17 +9006,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - task_status @@ -10858,17 +9042,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - task_statuss @@ -10898,17 +9074,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/task_statuses/{id}/edit": get: tags: @@ -10943,17 +9111,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/task_statuses/bulk: post: tags: @@ -10991,17 +9151,9 @@ paths: schema: $ref: "#/components/schemas/TaskStatus" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tax_rates: get: tags: @@ -11026,17 +9178,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tax_rates/create: get: tags: @@ -11062,17 +9206,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tax_rates/{id}": get: tags: @@ -11106,17 +9242,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - tax_rates @@ -11149,17 +9277,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - tax_rates @@ -11188,17 +9308,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tax_rates/{id}/edit": get: tags: @@ -11232,17 +9344,9 @@ paths: schema: $ref: "#/components/schemas/TaxRate" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tax_rates/bulk: post: tags: @@ -11280,17 +9384,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/templates: post: tags: @@ -11329,17 +9425,9 @@ paths: schema: $ref: "#/components/schemas/Template" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tokens: get: tags: @@ -11367,17 +9455,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - tokens @@ -11403,17 +9483,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tokens/{id}": get: tags: @@ -11448,17 +9520,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - tokens @@ -11492,17 +9556,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - tokens @@ -11532,17 +9588,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/tokens/{id}/edit": get: tags: @@ -11577,17 +9625,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tokens/create: get: tags: @@ -11614,17 +9654,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/tokens/bulk: post: tags: @@ -11662,17 +9694,9 @@ paths: schema: $ref: "#/components/schemas/CompanyToken" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/users: get: tags: @@ -11699,17 +9723,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - users @@ -11735,17 +9751,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/users/create: get: tags: @@ -11772,17 +9780,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{id}": get: tags: @@ -11817,17 +9817,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - users @@ -11861,17 +9853,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - users @@ -11909,17 +9893,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{id}/edit": get: tags: @@ -11954,17 +9930,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/users/bulk: post: tags: @@ -12002,17 +9970,9 @@ paths: schema: $ref: "#/components/schemas/User" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{user}/detach_from_company": delete: tags: @@ -12043,17 +10003,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{user}/invite": post: tags: @@ -12084,17 +10036,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/users/{user}/reconfirm": post: tags: @@ -12125,17 +10069,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/vendors: get: tags: @@ -12163,17 +10099,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - vendors @@ -12199,17 +10127,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/vendors/{id}": get: tags: @@ -12244,17 +10164,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - vendors @@ -12288,17 +10200,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - vendors @@ -12328,17 +10232,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/vendors/{id}/edit": get: tags: @@ -12373,17 +10269,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/vendors/create: get: tags: @@ -12410,17 +10298,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/vendors/bulk: post: tags: @@ -12458,17 +10338,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/vendors/{id}/upload": put: tags: @@ -12503,17 +10375,9 @@ paths: schema: $ref: "#/components/schemas/Vendor" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/webcron: get: tags: @@ -12534,17 +10398,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/webhooks: get: tags: @@ -12572,17 +10428,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - webhooks @@ -12608,17 +10456,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/webhooks/{id}": get: tags: @@ -12653,17 +10493,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - webhooks @@ -12697,17 +10529,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - Webhooks @@ -12737,17 +10561,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/webhooks/{id}/edit": get: tags: @@ -12782,17 +10598,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/webhooks/create: get: tags: @@ -12819,17 +10627,9 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/webhooks/bulk: post: tags: @@ -12867,14 +10667,6 @@ paths: schema: $ref: "#/components/schemas/Webhook" 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' diff --git a/openapi/paths/clients.yaml b/openapi/paths/clients.yaml index 261abd6dc9b7..55efd92ea611 100644 --- a/openapi/paths/clients.yaml +++ b/openapi/paths/clients.yaml @@ -83,11 +83,7 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -119,11 +115,7 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -164,11 +156,7 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -208,11 +196,7 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -248,11 +232,7 @@ X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -293,11 +273,7 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -330,11 +306,7 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -378,11 +350,7 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -438,11 +406,7 @@ schema: $ref: '#/components/schemas/Client' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -479,11 +443,7 @@ X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: @@ -528,11 +488,7 @@ X-RateLimit-Limit: $ref: '#/components/headers/X-RateLimit-Limit' 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' + $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 422: diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index 2cecf78a3a1d..209b3d4fbf3a 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -27,29 +27,13 @@ schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' post: tags: - products @@ -74,18 +58,14 @@ application/json: schema: $ref: "#/components/schemas/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/products/{id}": get: tags: @@ -120,29 +100,13 @@ schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' put: tags: - products @@ -176,29 +140,13 @@ schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' delete: tags: - products @@ -228,29 +176,13 @@ X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/products/{id}/edit": get: tags: @@ -285,29 +217,13 @@ schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/products/create": get: tags: @@ -334,29 +250,13 @@ schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' /api/v1/products/bulk: post: @@ -395,29 +295,13 @@ schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' "/api/v1/products/{id}/upload": put: @@ -467,26 +351,10 @@ schema: $ref: "#/components/schemas/Product" 401: - description: "Authentication error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthenticationError" + $ref: '#/components/responses/401' 403: - description: "Authorization error" - content: - application/json: - schema: - $ref: "#components/schemas/AuthorizationError" + $ref: '#/components/responses/403' 422: - description: "Validation error" - content: - application/json: - schema: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/responses/422' default: - description: "Unexpected Error" - content: - application/json: - schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/responses/default' From b22760b98172833376cdeccf15f3ad82764383b2 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 15:10:13 +1100 Subject: [PATCH 06/33] OpenAPI docs --- openapi/paths.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/openapi/paths.yaml b/openapi/paths.yaml index 747691ef9e50..ebbd22a7ed7a 100644 --- a/openapi/paths.yaml +++ b/openapi/paths.yaml @@ -2836,6 +2836,10 @@ paths: $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: @@ -2873,6 +2877,10 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' 422: $ref: '#/components/responses/422' default: From df8bd671d9a622ae2cb75f7080954a9ae004f9f8 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 15:17:16 +1100 Subject: [PATCH 07/33] Add 4xx errors across all entities --- openapi/api-docs.yaml | 2507 ++++++++++++++++++++++++++++------------- openapi/paths.yaml | 2507 ++++++++++++++++++++++++++++------------- 2 files changed, 3464 insertions(+), 1550 deletions(-) diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index e198184e4d84..b04cae70cae0 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -39,26 +39,27 @@ paths: - $ref: "#/components/parameters/page_meta" responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Client' + $ref: "#/components/schemas/Client" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/actvities/download_entity/{activity_id}": get: tags: @@ -91,14 +92,14 @@ paths: 404: description: "No file exists for the given record" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' - + $ref: "#/components/responses/default" + /api/v1/login: post: tags: @@ -133,26 +134,26 @@ paths: type: object responses: 200: - description: 'Returns the company user object' + description: "Returns the company user object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Client' + $ref: "#/components/schemas/Client" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/refresh: post: tags: @@ -192,13 +193,13 @@ paths: schema: $ref: "#/components/schemas/CompanyUser" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/yodlee/refresh: post: tags: @@ -224,13 +225,13 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations: get: tags: @@ -266,13 +267,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - bank_integrations @@ -298,13 +299,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_integrations/{id}": get: tags: @@ -339,13 +340,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - bank_integrations @@ -379,13 +380,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - bank_integrations @@ -415,13 +416,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_integrations/{id}/edit": get: tags: @@ -456,13 +457,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/create: get: tags: @@ -489,13 +490,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/bulk: post: tags: @@ -529,13 +530,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/refresh_accounts: post: tags: @@ -562,13 +563,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/remove_account/account_id: post: tags: @@ -595,13 +596,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/get_transactions/account_id: post: tags: @@ -628,13 +629,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transactions: get: tags: @@ -670,13 +671,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - bank_transactions @@ -702,13 +703,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_transactions/{id}": get: tags: @@ -743,13 +744,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - bank_transactions @@ -783,13 +784,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - bank_transactions @@ -819,13 +820,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_transactions/{id}/edit": get: tags: @@ -860,13 +861,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transactions/create: get: tags: @@ -893,13 +894,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transations/bulk: post: tags: @@ -933,13 +934,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transations/match: post: tags: @@ -973,13 +974,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transaction_rules: get: tags: @@ -1015,13 +1016,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - bank_transaction_rules @@ -1047,13 +1048,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_transaction_rules/{id}": get: tags: @@ -1088,13 +1089,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - bank_transaction_rules @@ -1128,13 +1129,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - bank_transaction_rules @@ -1164,13 +1165,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_transaction_rules/{id}/edit": get: tags: @@ -1205,13 +1206,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transaction_rules/create: get: tags: @@ -1238,13 +1239,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transation_rules/bulk: post: tags: @@ -1278,13 +1279,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/charts/totals: post: tags: @@ -1316,9 +1317,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/client_gateway_tokens: get: @@ -1347,13 +1348,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - client_gateway_tokens @@ -1379,13 +1380,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/client_gateway_tokens/{id}": get: tags: @@ -1420,13 +1421,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - client_gateway_tokens @@ -1460,13 +1461,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - client_gateway_tokens @@ -1496,13 +1497,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/client_gateway_tokens/{id}/edit": get: tags: @@ -1537,13 +1538,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/client_gateway_tokens/create: get: tags: @@ -1570,13 +1571,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/companies: get: @@ -1604,13 +1605,13 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - companies @@ -1636,13 +1637,13 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/companies/create: get: tags: @@ -1669,13 +1670,13 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/companies/{id}": get: tags: @@ -1710,13 +1711,13 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - companies @@ -1750,13 +1751,14 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - companies @@ -1786,13 +1788,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/companies/{id}/edit": get: tags: @@ -1827,13 +1830,14 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/companies/{id}/upload": put: tags: @@ -1868,13 +1872,14 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/companies/{company}/default": post: tags: @@ -1909,13 +1914,14 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_gateways: get: tags: @@ -1942,13 +1948,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - company_gateways @@ -1973,10 +1980,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_gateways/create: get: tags: @@ -2003,13 +2014,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/company_gateways/{id}": get: tags: @@ -2044,13 +2056,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - company_gateways @@ -2084,13 +2097,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - company_gateways @@ -2120,13 +2134,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/company_gateways/{id}/edit": get: tags: @@ -2161,13 +2176,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_gateways/bulk: post: tags: @@ -2205,13 +2221,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_ledger: get: tags: @@ -2238,13 +2255,14 @@ paths: schema: $ref: "#/components/schemas/CompanyLedger" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_users: post: tags: @@ -2269,13 +2287,14 @@ paths: schema: $ref: "#/components/schemas/CompanyUser" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/connected_account: post: tags: @@ -2304,13 +2323,14 @@ paths: schema: $ref: "#/components/schemas/User" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/credits: get: tags: @@ -2337,13 +2357,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - credits @@ -2369,13 +2390,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/credits/create: get: tags: @@ -2402,13 +2424,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/credits/{id}": get: tags: @@ -2443,13 +2466,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - Credits @@ -2483,13 +2507,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - credits @@ -2519,13 +2544,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/credits/{id}/edit": get: tags: @@ -2560,13 +2586,14 @@ paths: schema: $ref: "#/components/schemas/Invoice" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/credits/bulk: post: tags: @@ -2600,13 +2627,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/credit/{invitation_key}/download": get: tags: @@ -2637,13 +2665,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/credits/{id}/upload": put: tags: @@ -2678,13 +2707,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/designs: get: tags: @@ -2712,13 +2742,14 @@ paths: schema: $ref: "#/components/schemas/Design" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - designs @@ -2744,13 +2775,14 @@ paths: schema: $ref: "#/components/schemas/Design" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/designs/{id}": get: tags: @@ -2785,13 +2817,14 @@ paths: schema: $ref: "#/components/schemas/Design" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - designs @@ -2825,13 +2858,14 @@ paths: schema: $ref: "#/components/schemas/Design" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - designs @@ -2860,10 +2894,15 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/designs/{id}/edit": get: tags: @@ -2897,10 +2936,15 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/designs/create: get: tags: @@ -2926,10 +2970,15 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/designs/bulk: post: tags: @@ -2966,10 +3015,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/documents: get: tags: @@ -2996,10 +3049,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Document" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/emails: post: tags: @@ -3046,10 +3103,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Template" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expense_categories: get: tags: @@ -3073,10 +3134,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - expense_categories @@ -3101,10 +3166,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expense_categories/create: get: tags: @@ -3129,10 +3198,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expense_categories/{id}": get: tags: @@ -3165,10 +3238,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - expense_categories @@ -3200,10 +3277,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - expense_categories @@ -3231,10 +3312,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expense_categories/{id}/edit": get: tags: @@ -3267,10 +3352,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expense_categories/bulk: post: tags: @@ -3307,10 +3396,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expenses: get: tags: @@ -3337,10 +3430,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - expenses @@ -3365,10 +3462,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expenses/{id}": get: tags: @@ -3402,10 +3503,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - expenses @@ -3438,10 +3543,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - expenses @@ -3470,10 +3579,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expenses/{id}/edit": get: tags: @@ -3507,10 +3620,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expenses/create: get: tags: @@ -3536,10 +3653,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expenses/bulk: post: tags: @@ -3576,10 +3697,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expenses/{id}/upload": put: tags: @@ -3613,10 +3738,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/export: post: tags: @@ -3636,10 +3765,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/group_settings: get: tags: @@ -3665,10 +3798,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - group_settings @@ -3693,10 +3830,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/group_settings/create: get: tags: @@ -3722,10 +3863,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/group_settings/{id}": get: tags: @@ -3759,10 +3904,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - group_settings @@ -3795,10 +3944,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - group_settings @@ -3827,10 +3980,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/group_settings/{id}/edit": get: tags: @@ -3864,10 +4021,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/group_settings/bulk: post: tags: @@ -3900,10 +4061,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/group_settings/{id}/upload": put: tags: @@ -3937,10 +4102,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/preimport: post: tags: @@ -3970,10 +4139,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/import_json: post: tags: @@ -3993,10 +4166,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/apple/confirm_purchase: post: tags: @@ -4018,10 +4195,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/apple/process_webhook: post: tags: @@ -4043,10 +4224,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/invoices: get: tags: @@ -4072,10 +4257,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - invoices @@ -4106,10 +4295,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/invoices/create: get: tags: @@ -4135,10 +4328,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}": get: tags: @@ -4172,10 +4369,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - invoices @@ -4208,10 +4409,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - invoices @@ -4240,10 +4445,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}/edit": get: tags: @@ -4277,10 +4486,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/invoices/bulk: post: tags: @@ -4313,10 +4526,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}/{action}": get: tags: @@ -4358,10 +4575,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoice/{invitation_key}/download": get: tags: @@ -4391,10 +4612,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}/delivery_note": get: tags: @@ -4424,10 +4649,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}/upload": put: tags: @@ -4461,10 +4690,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/claim_license: get: tags: @@ -4500,10 +4733,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/logout: post: tags: @@ -4526,10 +4763,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/migration/purge/{company}": post: tags: @@ -4558,10 +4799,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/migration/purge_save_settings/{company}": post: tags: @@ -4590,10 +4835,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/migration/start: post: tags: @@ -4623,10 +4872,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/one_time_token: post: tags: @@ -4646,10 +4899,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payments: get: tags: @@ -4675,10 +4932,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - payments @@ -4710,10 +4971,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payments/create: get: tags: @@ -4739,10 +5004,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payments/{id}": get: tags: @@ -4776,10 +5045,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - payments @@ -4812,10 +5085,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - payments @@ -4844,10 +5121,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payments/{id}/edit": get: tags: @@ -4881,10 +5162,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payments/bulk: post: tags: @@ -4921,10 +5206,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payments/{id}/{action}": get: tags: @@ -4966,10 +5255,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payments/refund: post: tags: @@ -5002,10 +5295,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payments/{id}/upload": put: tags: @@ -5039,10 +5336,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payment_terms: get: tags: @@ -5069,10 +5370,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - payment_terms @@ -5104,10 +5409,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payment_terms/create: get: tags: @@ -5133,10 +5442,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payment_terms/{id}": get: tags: @@ -5170,10 +5483,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - payment_terms @@ -5206,10 +5523,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - payment_termss @@ -5238,10 +5559,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payment_terms/{id}/edit": get: tags: @@ -5275,10 +5600,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payment_terms/bulk: post: tags: @@ -5315,10 +5644,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/ping: get: tags: @@ -5382,10 +5715,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/preview: post: tags: @@ -5405,10 +5742,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/preview/purchase_order: post: tags: @@ -5428,10 +5769,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/projects: get: @@ -5459,10 +5804,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - projects @@ -5487,10 +5836,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/projects/{id}": get: tags: @@ -5524,10 +5877,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - projects @@ -5560,10 +5917,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - projects @@ -5592,10 +5953,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/projects/{id}/edit": get: tags: @@ -5629,10 +5994,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/projects/create: get: tags: @@ -5658,10 +6027,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/projects/bulk: post: tags: @@ -5698,10 +6071,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/projects/{id}/upload": put: tags: @@ -5735,10 +6112,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/purchase_orders: get: tags: @@ -5764,10 +6145,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - purhcase_orders @@ -5792,10 +6177,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/purchase_orders/create: get: tags: @@ -5821,10 +6210,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_orders/{id}": get: tags: @@ -5858,10 +6251,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - purchase_orders @@ -5890,10 +6287,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_orders/{id}/edit": get: tags: @@ -5927,10 +6328,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_order/{id}": put: tags: @@ -5964,10 +6369,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/purchase_orders/bulk: post: tags: @@ -6000,10 +6409,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_orders/{id}/{action}": get: tags: @@ -6045,10 +6458,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_orders/{id}/upload": put: tags: @@ -6082,10 +6499,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_order/{invitation_key}/download": get: tags: @@ -6115,10 +6536,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/quotes: get: tags: @@ -6144,10 +6569,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - quotes @@ -6172,10 +6601,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/quotes/create: get: tags: @@ -6201,10 +6634,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quotes/{id}": get: tags: @@ -6238,10 +6675,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - quotes @@ -6274,10 +6715,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - quotes @@ -6306,10 +6751,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quotes/{id}/edit": get: tags: @@ -6343,10 +6792,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/quotes/bulk: post: tags: @@ -6383,10 +6836,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quotes/{id}/{action}": get: tags: @@ -6428,10 +6885,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quote/{invitation_key}/download": get: tags: @@ -6461,10 +6922,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quotes/{id}/upload": put: tags: @@ -6498,10 +6963,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_expenses: get: tags: @@ -6528,10 +6997,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - recurring_expenses @@ -6556,10 +7029,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_expenses/{id}": get: tags: @@ -6593,10 +7070,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - recurring_expenses @@ -6629,10 +7110,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - recurring_expenses @@ -6661,10 +7146,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_expenses/{id}/edit": get: tags: @@ -6698,10 +7187,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_expenses/create: get: tags: @@ -6727,10 +7220,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_expenses/bulk: post: tags: @@ -6767,10 +7264,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_expenses/{id}/upload": put: tags: @@ -6804,10 +7305,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_invoices: get: tags: @@ -6833,10 +7338,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - recurring_invoices @@ -6861,10 +7370,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_invoices/create: get: tags: @@ -6890,10 +7403,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}": get: tags: @@ -6927,10 +7444,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - recurring_invoices @@ -6963,10 +7484,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - recurring_invoices @@ -6995,10 +7520,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}/edit": get: tags: @@ -7032,10 +7561,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: @@ -7065,10 +7598,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_invoices/bulk: post: tags: @@ -7105,10 +7642,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}/{action}": get: tags: @@ -7150,10 +7691,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}/upload": put: tags: @@ -7187,10 +7732,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_quotes: get: tags: @@ -7216,10 +7765,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - recurring_quotes @@ -7244,10 +7797,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_quotes/create: get: tags: @@ -7273,10 +7830,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_quotes/{id}": get: tags: @@ -7310,10 +7871,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - recurring_quotes @@ -7346,10 +7911,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - recurring_quotes @@ -7378,10 +7947,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_quotes/{id}/edit": get: tags: @@ -7415,10 +7988,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_quotes/bulk: post: tags: @@ -7455,10 +8032,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_quotes/{id}/{action}": get: tags: @@ -7500,10 +8081,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/contacts: post: tags: @@ -7529,10 +8114,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/clients: post: tags: @@ -7558,10 +8147,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/credit: post: tags: @@ -7587,10 +8180,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/documents: post: tags: @@ -7616,10 +8213,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/expense: post: tags: @@ -7645,10 +8246,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/invoice_items: post: tags: @@ -7674,10 +8279,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/invoices: post: tags: @@ -7703,10 +8312,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/payments: post: tags: @@ -7732,10 +8345,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/products: post: tags: @@ -7761,10 +8378,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/product_sales: post: tags: @@ -7790,10 +8411,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/profitloss: post: tags: @@ -7819,10 +8444,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/quote_items: post: tags: @@ -7848,10 +8477,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/quotes: post: tags: @@ -7877,10 +8510,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/recurring_invoices: post: tags: @@ -7906,10 +8543,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/tasks: post: tags: @@ -7935,10 +8576,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/self-update: post: tags: @@ -7954,10 +8599,14 @@ paths: responses: 200: description: "Success/failure response" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/statics: get: tags: @@ -7979,10 +8628,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/subscriptions: get: tags: @@ -8008,10 +8661,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - subscriptions @@ -8036,10 +8693,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/subscriptions/create: get: tags: @@ -8065,10 +8726,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/subscriptions/{id}": get: tags: @@ -8102,10 +8767,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - subscriptions @@ -8138,10 +8807,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - subscriptions @@ -8170,10 +8843,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/subscriptions/{id}/edit": get: tags: @@ -8207,10 +8884,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/subscriptions/bulk: post: tags: @@ -8247,10 +8928,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/support/messages/send: post: tags: @@ -8291,7 +8976,7 @@ paths: type: string example: true default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/system_logs: get: tags: @@ -8317,10 +9002,14 @@ paths: application/json: schema: $ref: "#/components/schemas/SystemLog" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/system_logs/{id}": get: tags: @@ -8354,10 +9043,14 @@ paths: application/json: schema: $ref: "#/components/schemas/SystemLog" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tasks: get: tags: @@ -8384,10 +9077,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - tasks @@ -8412,10 +9109,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tasks/{id}": get: tags: @@ -8449,10 +9150,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - tasks @@ -8485,10 +9190,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - tasks @@ -8517,10 +9226,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tasks/{id}/edit": get: tags: @@ -8554,10 +9267,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tasks/create: get: tags: @@ -8583,10 +9300,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tasks/bulk: post: tags: @@ -8623,10 +9344,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tasks/{id}/upload": put: tags: @@ -8660,10 +9385,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tasks/stort: post: tags: @@ -8685,10 +9414,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_schedulers/: get: tags: @@ -8709,7 +9442,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - task_schedulers @@ -8735,10 +9468,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/invoices/task_schedulers: get: tags: @@ -8764,10 +9501,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskSchedulerSchema" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/task_schedulers/{id}": get: tags: @@ -8796,7 +9537,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - task_schedulers @@ -8830,10 +9571,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - task_schedulers @@ -8861,7 +9606,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_schedulers/bulk: post: tags: @@ -8898,10 +9643,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskSchedulerSchema" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_statuses: get: tags: @@ -8928,10 +9677,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - task_status @@ -8963,10 +9716,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_statuses/create: get: tags: @@ -8992,10 +9749,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/task_statuses/{id}": get: tags: @@ -9029,10 +9790,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - task_status @@ -9065,10 +9830,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - task_statuss @@ -9097,10 +9866,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/task_statuses/{id}/edit": get: tags: @@ -9134,10 +9907,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_statuses/bulk: post: tags: @@ -9174,10 +9951,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tax_rates: get: tags: @@ -9201,10 +9982,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tax_rates/create: get: tags: @@ -9229,10 +10014,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tax_rates/{id}": get: tags: @@ -9265,10 +10054,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - tax_rates @@ -9300,10 +10093,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - tax_rates @@ -9331,10 +10128,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tax_rates/{id}/edit": get: tags: @@ -9367,10 +10168,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tax_rates/bulk: post: tags: @@ -9407,10 +10212,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/templates: post: tags: @@ -9448,10 +10257,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Template" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tokens: get: tags: @@ -9478,10 +10291,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - tokens @@ -9506,10 +10323,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tokens/{id}": get: tags: @@ -9543,10 +10364,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - tokens @@ -9579,10 +10404,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - tokens @@ -9611,10 +10440,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tokens/{id}/edit": get: tags: @@ -9648,10 +10481,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tokens/create: get: tags: @@ -9677,10 +10514,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tokens/bulk: post: tags: @@ -9717,10 +10558,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/users: get: tags: @@ -9746,10 +10591,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - users @@ -9774,10 +10623,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/users/create: get: tags: @@ -9803,10 +10656,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{id}": get: tags: @@ -9840,10 +10697,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - users @@ -9876,10 +10737,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - users @@ -9916,10 +10781,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{id}/edit": get: tags: @@ -9953,10 +10822,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/users/bulk: post: tags: @@ -9993,10 +10866,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{user}/detach_from_company": delete: tags: @@ -10026,10 +10903,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{user}/invite": post: tags: @@ -10059,10 +10940,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{user}/reconfirm": post: tags: @@ -10092,10 +10977,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/vendors: get: tags: @@ -10122,10 +11011,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - vendors @@ -10150,10 +11043,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/vendors/{id}": get: tags: @@ -10187,10 +11084,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - vendors @@ -10223,10 +11124,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - vendors @@ -10255,10 +11160,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/vendors/{id}/edit": get: tags: @@ -10292,10 +11201,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/vendors/create: get: tags: @@ -10321,10 +11234,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/vendors/bulk: post: tags: @@ -10361,10 +11278,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/vendors/{id}/upload": put: tags: @@ -10398,10 +11319,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/webcron: get: tags: @@ -10421,10 +11346,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/webhooks: get: tags: @@ -10451,10 +11380,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - webhooks @@ -10479,10 +11412,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/webhooks/{id}": get: tags: @@ -10516,10 +11453,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - webhooks @@ -10552,10 +11493,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - Webhooks @@ -10584,10 +11529,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/webhooks/{id}/edit": get: tags: @@ -10621,10 +11570,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/webhooks/create: get: tags: @@ -10650,10 +11603,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/webhooks/bulk: post: tags: @@ -10690,10 +11647,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/products: get: diff --git a/openapi/paths.yaml b/openapi/paths.yaml index ebbd22a7ed7a..e4cc18be5806 100644 --- a/openapi/paths.yaml +++ b/openapi/paths.yaml @@ -15,26 +15,27 @@ paths: - $ref: "#/components/parameters/page_meta" responses: 200: - description: 'Returns the client object' + description: "Returns the client object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Client' + $ref: "#/components/schemas/Client" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/actvities/download_entity/{activity_id}": get: tags: @@ -67,14 +68,14 @@ paths: 404: description: "No file exists for the given record" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' - + $ref: "#/components/responses/default" + /api/v1/login: post: tags: @@ -109,26 +110,26 @@ paths: type: object responses: 200: - description: 'Returns the company user object' + description: "Returns the company user object" headers: X-MINIMUM-CLIENT-VERSION: - $ref: '#/components/headers/X-MINIMUM-CLIENT-VERSION' + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" X-RateLimit-Remaining: - $ref: '#/components/headers/X-RateLimit-Remaining' + $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: - $ref: '#/components/headers/X-RateLimit-Limit' + $ref: "#/components/headers/X-RateLimit-Limit" content: application/json: schema: - $ref: '#/components/schemas/Client' + $ref: "#/components/schemas/Client" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/refresh: post: tags: @@ -168,13 +169,13 @@ paths: schema: $ref: "#/components/schemas/CompanyUser" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/yodlee/refresh: post: tags: @@ -200,13 +201,13 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations: get: tags: @@ -242,13 +243,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - bank_integrations @@ -274,13 +275,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_integrations/{id}": get: tags: @@ -315,13 +316,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - bank_integrations @@ -355,13 +356,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - bank_integrations @@ -391,13 +392,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_integrations/{id}/edit": get: tags: @@ -432,13 +433,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/create: get: tags: @@ -465,13 +466,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/bulk: post: tags: @@ -505,13 +506,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/refresh_accounts: post: tags: @@ -538,13 +539,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/remove_account/account_id: post: tags: @@ -571,13 +572,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_integrations/get_transactions/account_id: post: tags: @@ -604,13 +605,13 @@ paths: schema: $ref: "#/components/schemas/BankIntegration" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transactions: get: tags: @@ -646,13 +647,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - bank_transactions @@ -678,13 +679,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_transactions/{id}": get: tags: @@ -719,13 +720,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - bank_transactions @@ -759,13 +760,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - bank_transactions @@ -795,13 +796,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_transactions/{id}/edit": get: tags: @@ -836,13 +837,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transactions/create: get: tags: @@ -869,13 +870,13 @@ paths: schema: $ref: "#/components/schemas/BankTransaction" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transations/bulk: post: tags: @@ -909,13 +910,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transations/match: post: tags: @@ -949,13 +950,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transaction_rules: get: tags: @@ -991,13 +992,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - bank_transaction_rules @@ -1023,13 +1024,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_transaction_rules/{id}": get: tags: @@ -1064,13 +1065,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - bank_transaction_rules @@ -1104,13 +1105,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - bank_transaction_rules @@ -1140,13 +1141,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/bank_transaction_rules/{id}/edit": get: tags: @@ -1181,13 +1182,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transaction_rules/create: get: tags: @@ -1214,13 +1215,13 @@ paths: schema: $ref: "#/components/schemas/BankTransactionRule" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/bank_transation_rules/bulk: post: tags: @@ -1254,13 +1255,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/charts/totals: post: tags: @@ -1292,9 +1293,9 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/client_gateway_tokens: get: @@ -1323,13 +1324,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - client_gateway_tokens @@ -1355,13 +1356,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/client_gateway_tokens/{id}": get: tags: @@ -1396,13 +1397,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - client_gateway_tokens @@ -1436,13 +1437,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - client_gateway_tokens @@ -1472,13 +1473,13 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/client_gateway_tokens/{id}/edit": get: tags: @@ -1513,13 +1514,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/client_gateway_tokens/create: get: tags: @@ -1546,13 +1547,13 @@ paths: schema: $ref: "#/components/schemas/ClientGatewayToken" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/companies: get: @@ -1580,13 +1581,13 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - companies @@ -1612,13 +1613,13 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/companies/create: get: tags: @@ -1645,13 +1646,13 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/companies/{id}": get: tags: @@ -1686,13 +1687,13 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - companies @@ -1726,13 +1727,14 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - companies @@ -1762,13 +1764,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/companies/{id}/edit": get: tags: @@ -1803,13 +1806,14 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/companies/{id}/upload": put: tags: @@ -1844,13 +1848,14 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/companies/{company}/default": post: tags: @@ -1885,13 +1890,14 @@ paths: schema: $ref: "#/components/schemas/Company" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_gateways: get: tags: @@ -1918,13 +1924,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - company_gateways @@ -1949,10 +1956,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyGateway" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_gateways/create: get: tags: @@ -1979,13 +1990,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/company_gateways/{id}": get: tags: @@ -2020,13 +2032,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - company_gateways @@ -2060,13 +2073,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - company_gateways @@ -2096,13 +2110,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/company_gateways/{id}/edit": get: tags: @@ -2137,13 +2152,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_gateways/bulk: post: tags: @@ -2181,13 +2197,14 @@ paths: schema: $ref: "#/components/schemas/CompanyGateway" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_ledger: get: tags: @@ -2214,13 +2231,14 @@ paths: schema: $ref: "#/components/schemas/CompanyLedger" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/company_users: post: tags: @@ -2245,13 +2263,14 @@ paths: schema: $ref: "#/components/schemas/CompanyUser" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/connected_account: post: tags: @@ -2280,13 +2299,14 @@ paths: schema: $ref: "#/components/schemas/User" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/credits: get: tags: @@ -2313,13 +2333,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - credits @@ -2345,13 +2366,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/credits/create: get: tags: @@ -2378,13 +2400,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/credits/{id}": get: tags: @@ -2419,13 +2442,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - Credits @@ -2459,13 +2483,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - credits @@ -2495,13 +2520,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/credits/{id}/edit": get: tags: @@ -2536,13 +2562,14 @@ paths: schema: $ref: "#/components/schemas/Invoice" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/credits/bulk: post: tags: @@ -2576,13 +2603,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/credit/{invitation_key}/download": get: tags: @@ -2613,13 +2641,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/credits/{id}/upload": put: tags: @@ -2654,13 +2683,14 @@ paths: schema: $ref: "#/components/schemas/Credit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/designs: get: tags: @@ -2688,13 +2718,14 @@ paths: schema: $ref: "#/components/schemas/Design" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - designs @@ -2720,13 +2751,14 @@ paths: schema: $ref: "#/components/schemas/Design" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/designs/{id}": get: tags: @@ -2761,13 +2793,14 @@ paths: schema: $ref: "#/components/schemas/Design" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - designs @@ -2801,13 +2834,14 @@ paths: schema: $ref: "#/components/schemas/Design" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - designs @@ -2837,13 +2871,14 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/designs/{id}/edit": get: tags: @@ -2878,13 +2913,14 @@ paths: schema: $ref: "#/components/schemas/Design" 401: - $ref: '#/components/responses/401' + $ref: "#/components/responses/401" 403: - $ref: '#/components/responses/403' + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/designs/create: get: tags: @@ -2910,10 +2946,15 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/designs/bulk: post: tags: @@ -2950,10 +2991,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Design" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/documents: get: tags: @@ -2980,10 +3025,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Document" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/emails: post: tags: @@ -3030,10 +3079,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Template" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expense_categories: get: tags: @@ -3057,10 +3110,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - expense_categories @@ -3085,10 +3142,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expense_categories/create: get: tags: @@ -3113,10 +3174,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expense_categories/{id}": get: tags: @@ -3149,10 +3214,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - expense_categories @@ -3184,10 +3253,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - expense_categories @@ -3215,10 +3288,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expense_categories/{id}/edit": get: tags: @@ -3251,10 +3328,14 @@ paths: application/json: schema: $ref: "#/components/schemas/ExpenseCategory" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expense_categories/bulk: post: tags: @@ -3291,10 +3372,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expenses: get: tags: @@ -3321,10 +3406,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - expenses @@ -3349,10 +3438,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expenses/{id}": get: tags: @@ -3386,10 +3479,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - expenses @@ -3422,10 +3519,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - expenses @@ -3454,10 +3555,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expenses/{id}/edit": get: tags: @@ -3491,10 +3596,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expenses/create: get: tags: @@ -3520,10 +3629,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/expenses/bulk: post: tags: @@ -3560,10 +3673,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/expenses/{id}/upload": put: tags: @@ -3597,10 +3714,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Expense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/export: post: tags: @@ -3620,10 +3741,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/group_settings: get: tags: @@ -3649,10 +3774,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - group_settings @@ -3677,10 +3806,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/group_settings/create: get: tags: @@ -3706,10 +3839,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/group_settings/{id}": get: tags: @@ -3743,10 +3880,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - group_settings @@ -3779,10 +3920,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - group_settings @@ -3811,10 +3956,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/group_settings/{id}/edit": get: tags: @@ -3848,10 +3997,14 @@ paths: application/json: schema: $ref: "#/components/schemas/GroupSetting" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/group_settings/bulk: post: tags: @@ -3884,10 +4037,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/group_settings/{id}/upload": put: tags: @@ -3921,10 +4078,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/preimport: post: tags: @@ -3954,10 +4115,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/import_json: post: tags: @@ -3977,10 +4142,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/apple/confirm_purchase: post: tags: @@ -4002,10 +4171,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/apple/process_webhook: post: tags: @@ -4027,10 +4200,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/invoices: get: tags: @@ -4056,10 +4233,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - invoices @@ -4090,10 +4271,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/invoices/create: get: tags: @@ -4119,10 +4304,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}": get: tags: @@ -4156,10 +4345,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - invoices @@ -4192,10 +4385,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - invoices @@ -4224,10 +4421,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}/edit": get: tags: @@ -4261,10 +4462,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/invoices/bulk: post: tags: @@ -4297,10 +4502,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}/{action}": get: tags: @@ -4342,10 +4551,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoice/{invitation_key}/download": get: tags: @@ -4375,10 +4588,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}/delivery_note": get: tags: @@ -4408,10 +4625,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/invoices/{id}/upload": put: tags: @@ -4445,10 +4666,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/claim_license: get: tags: @@ -4484,10 +4709,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/logout: post: tags: @@ -4510,10 +4739,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/migration/purge/{company}": post: tags: @@ -4542,10 +4775,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/migration/purge_save_settings/{company}": post: tags: @@ -4574,10 +4811,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/migration/start: post: tags: @@ -4607,10 +4848,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/one_time_token: post: tags: @@ -4630,10 +4875,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payments: get: tags: @@ -4659,10 +4908,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - payments @@ -4694,10 +4947,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payments/create: get: tags: @@ -4723,10 +4980,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payments/{id}": get: tags: @@ -4760,10 +5021,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - payments @@ -4796,10 +5061,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - payments @@ -4828,10 +5097,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payments/{id}/edit": get: tags: @@ -4865,10 +5138,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payments/bulk: post: tags: @@ -4905,10 +5182,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payments/{id}/{action}": get: tags: @@ -4950,10 +5231,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payments/refund: post: tags: @@ -4986,10 +5271,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payments/{id}/upload": put: tags: @@ -5023,10 +5312,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payment_terms: get: tags: @@ -5053,10 +5346,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - payment_terms @@ -5088,10 +5385,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payment_terms/create: get: tags: @@ -5117,10 +5418,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payment_terms/{id}": get: tags: @@ -5154,10 +5459,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - payment_terms @@ -5190,10 +5499,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - payment_termss @@ -5222,10 +5535,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/payment_terms/{id}/edit": get: tags: @@ -5259,10 +5576,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/payment_terms/bulk: post: tags: @@ -5299,10 +5620,14 @@ paths: application/json: schema: $ref: "#/components/schemas/PaymentTerm" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/ping: get: tags: @@ -5366,10 +5691,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/preview: post: tags: @@ -5389,10 +5718,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/preview/purchase_order: post: tags: @@ -5412,10 +5745,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/projects: get: @@ -5443,10 +5780,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - projects @@ -5471,10 +5812,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/projects/{id}": get: tags: @@ -5508,10 +5853,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - projects @@ -5544,10 +5893,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - projects @@ -5576,10 +5929,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/projects/{id}/edit": get: tags: @@ -5613,10 +5970,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/projects/create: get: tags: @@ -5642,10 +6003,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/projects/bulk: post: tags: @@ -5682,10 +6047,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/projects/{id}/upload": put: tags: @@ -5719,10 +6088,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/purchase_orders: get: tags: @@ -5748,10 +6121,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - purhcase_orders @@ -5776,10 +6153,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/purchase_orders/create: get: tags: @@ -5805,10 +6186,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_orders/{id}": get: tags: @@ -5842,10 +6227,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - purchase_orders @@ -5874,10 +6263,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_orders/{id}/edit": get: tags: @@ -5911,10 +6304,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_order/{id}": put: tags: @@ -5948,10 +6345,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/purchase_orders/bulk: post: tags: @@ -5984,10 +6385,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_orders/{id}/{action}": get: tags: @@ -6029,10 +6434,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_orders/{id}/upload": put: tags: @@ -6066,10 +6475,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/purchase_order/{invitation_key}/download": get: tags: @@ -6099,10 +6512,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/quotes: get: tags: @@ -6128,10 +6545,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - quotes @@ -6156,10 +6577,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/quotes/create: get: tags: @@ -6185,10 +6610,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quotes/{id}": get: tags: @@ -6222,10 +6651,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - quotes @@ -6258,10 +6691,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - quotes @@ -6290,10 +6727,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quotes/{id}/edit": get: tags: @@ -6327,10 +6768,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/quotes/bulk: post: tags: @@ -6367,10 +6812,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quotes/{id}/{action}": get: tags: @@ -6412,10 +6861,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quote/{invitation_key}/download": get: tags: @@ -6445,10 +6898,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/quotes/{id}/upload": put: tags: @@ -6482,10 +6939,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_expenses: get: tags: @@ -6512,10 +6973,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - recurring_expenses @@ -6540,10 +7005,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_expenses/{id}": get: tags: @@ -6577,10 +7046,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - recurring_expenses @@ -6613,10 +7086,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - recurring_expenses @@ -6645,10 +7122,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_expenses/{id}/edit": get: tags: @@ -6682,10 +7163,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_expenses/create: get: tags: @@ -6711,10 +7196,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_expenses/bulk: post: tags: @@ -6751,10 +7240,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_expenses/{id}/upload": put: tags: @@ -6788,10 +7281,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringExpense" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_invoices: get: tags: @@ -6817,10 +7314,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - recurring_invoices @@ -6845,10 +7346,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_invoices/create: get: tags: @@ -6874,10 +7379,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}": get: tags: @@ -6911,10 +7420,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - recurring_invoices @@ -6947,10 +7460,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - recurring_invoices @@ -6979,10 +7496,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}/edit": get: tags: @@ -7016,10 +7537,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: @@ -7049,10 +7574,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_invoices/bulk: post: tags: @@ -7089,10 +7618,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}/{action}": get: tags: @@ -7134,10 +7667,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}/upload": put: tags: @@ -7171,10 +7708,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_quotes: get: tags: @@ -7200,10 +7741,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - recurring_quotes @@ -7228,10 +7773,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_quotes/create: get: tags: @@ -7257,10 +7806,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_quotes/{id}": get: tags: @@ -7294,10 +7847,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - recurring_quotes @@ -7330,10 +7887,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - recurring_quotes @@ -7362,10 +7923,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_quotes/{id}/edit": get: tags: @@ -7399,10 +7964,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/recurring_quotes/bulk: post: tags: @@ -7439,10 +8008,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/recurring_quotes/{id}/{action}": get: tags: @@ -7484,10 +8057,14 @@ paths: application/json: schema: $ref: "#/components/schemas/RecurringQuote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/contacts: post: tags: @@ -7513,10 +8090,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/clients: post: tags: @@ -7542,10 +8123,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/credit: post: tags: @@ -7571,10 +8156,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/documents: post: tags: @@ -7600,10 +8189,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/expense: post: tags: @@ -7629,10 +8222,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/invoice_items: post: tags: @@ -7658,10 +8255,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/invoices: post: tags: @@ -7687,10 +8288,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/payments: post: tags: @@ -7716,10 +8321,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/products: post: tags: @@ -7745,10 +8354,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/product_sales: post: tags: @@ -7774,10 +8387,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/profitloss: post: tags: @@ -7803,10 +8420,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/quote_items: post: tags: @@ -7832,10 +8453,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/quotes: post: tags: @@ -7861,10 +8486,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/recurring_invoices: post: tags: @@ -7890,10 +8519,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/reports/tasks: post: tags: @@ -7919,10 +8552,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/self-update: post: tags: @@ -7938,10 +8575,14 @@ paths: responses: 200: description: "Success/failure response" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/statics: get: tags: @@ -7963,10 +8604,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/subscriptions: get: tags: @@ -7992,10 +8637,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - subscriptions @@ -8020,10 +8669,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/subscriptions/create: get: tags: @@ -8049,10 +8702,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/subscriptions/{id}": get: tags: @@ -8086,10 +8743,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - subscriptions @@ -8122,10 +8783,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - subscriptions @@ -8154,10 +8819,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/subscriptions/{id}/edit": get: tags: @@ -8191,10 +8860,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/subscriptions/bulk: post: tags: @@ -8231,10 +8904,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Subscription" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/support/messages/send: post: tags: @@ -8275,7 +8952,7 @@ paths: type: string example: true default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/system_logs: get: tags: @@ -8301,10 +8978,14 @@ paths: application/json: schema: $ref: "#/components/schemas/SystemLog" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/system_logs/{id}": get: tags: @@ -8338,10 +9019,14 @@ paths: application/json: schema: $ref: "#/components/schemas/SystemLog" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tasks: get: tags: @@ -8368,10 +9053,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - tasks @@ -8396,10 +9085,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tasks/{id}": get: tags: @@ -8433,10 +9126,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - tasks @@ -8469,10 +9166,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - tasks @@ -8501,10 +9202,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tasks/{id}/edit": get: tags: @@ -8538,10 +9243,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tasks/create: get: tags: @@ -8567,10 +9276,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tasks/bulk: post: tags: @@ -8607,10 +9320,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tasks/{id}/upload": put: tags: @@ -8644,10 +9361,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tasks/stort: post: tags: @@ -8669,10 +9390,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_schedulers/: get: tags: @@ -8693,7 +9418,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - task_schedulers @@ -8719,10 +9444,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/invoices/task_schedulers: get: tags: @@ -8748,10 +9477,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskSchedulerSchema" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/task_schedulers/{id}": get: tags: @@ -8780,7 +9513,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - task_schedulers @@ -8814,10 +9547,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - task_schedulers @@ -8845,7 +9582,7 @@ paths: X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_schedulers/bulk: post: tags: @@ -8882,10 +9619,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskSchedulerSchema" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_statuses: get: tags: @@ -8912,10 +9653,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - task_status @@ -8947,10 +9692,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_statuses/create: get: tags: @@ -8976,10 +9725,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/task_statuses/{id}": get: tags: @@ -9013,10 +9766,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - task_status @@ -9049,10 +9806,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - task_statuss @@ -9081,10 +9842,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/task_statuses/{id}/edit": get: tags: @@ -9118,10 +9883,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/task_statuses/bulk: post: tags: @@ -9158,10 +9927,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaskStatus" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tax_rates: get: tags: @@ -9185,10 +9958,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tax_rates/create: get: tags: @@ -9213,10 +9990,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tax_rates/{id}": get: tags: @@ -9249,10 +10030,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - tax_rates @@ -9284,10 +10069,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - tax_rates @@ -9315,10 +10104,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tax_rates/{id}/edit": get: tags: @@ -9351,10 +10144,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TaxRate" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tax_rates/bulk: post: tags: @@ -9391,10 +10188,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/templates: post: tags: @@ -9432,10 +10233,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Template" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tokens: get: tags: @@ -9462,10 +10267,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - tokens @@ -9490,10 +10299,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tokens/{id}": get: tags: @@ -9527,10 +10340,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - tokens @@ -9563,10 +10380,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - tokens @@ -9595,10 +10416,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/tokens/{id}/edit": get: tags: @@ -9632,10 +10457,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tokens/create: get: tags: @@ -9661,10 +10490,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/tokens/bulk: post: tags: @@ -9701,10 +10534,14 @@ paths: application/json: schema: $ref: "#/components/schemas/CompanyToken" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/users: get: tags: @@ -9730,10 +10567,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - users @@ -9758,10 +10599,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/users/create: get: tags: @@ -9787,10 +10632,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{id}": get: tags: @@ -9824,10 +10673,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - users @@ -9860,10 +10713,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - users @@ -9900,10 +10757,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{id}/edit": get: tags: @@ -9937,10 +10798,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/users/bulk: post: tags: @@ -9977,10 +10842,14 @@ paths: application/json: schema: $ref: "#/components/schemas/User" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{user}/detach_from_company": delete: tags: @@ -10010,10 +10879,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{user}/invite": post: tags: @@ -10043,10 +10916,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/users/{user}/reconfirm": post: tags: @@ -10076,10 +10953,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/vendors: get: tags: @@ -10106,10 +10987,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - vendors @@ -10134,10 +11019,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/vendors/{id}": get: tags: @@ -10171,10 +11060,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - vendors @@ -10207,10 +11100,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - vendors @@ -10239,10 +11136,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/vendors/{id}/edit": get: tags: @@ -10276,10 +11177,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/vendors/create: get: tags: @@ -10305,10 +11210,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/vendors/bulk: post: tags: @@ -10345,10 +11254,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/vendors/{id}/upload": put: tags: @@ -10382,10 +11295,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/webcron: get: tags: @@ -10405,10 +11322,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/webhooks: get: tags: @@ -10435,10 +11356,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" post: tags: - webhooks @@ -10463,10 +11388,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/webhooks/{id}": get: tags: @@ -10500,10 +11429,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" put: tags: - webhooks @@ -10536,10 +11469,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" delete: tags: - Webhooks @@ -10568,10 +11505,14 @@ paths: $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' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" "/api/v1/webhooks/{id}/edit": get: tags: @@ -10605,10 +11546,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/webhooks/create: get: tags: @@ -10634,10 +11579,14 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" /api/v1/webhooks/bulk: post: tags: @@ -10674,7 +11623,11 @@ paths: application/json: schema: $ref: "#/components/schemas/Webhook" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" 422: - $ref: '#/components/responses/422' + $ref: "#/components/responses/422" default: - $ref: '#/components/responses/default' + $ref: "#/components/responses/default" From 93c3d007f3df4563af815215b75bc3f0fb669534 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 15:20:21 +1100 Subject: [PATCH 08/33] Update API docs with product filters --- openapi/api-docs.yaml | 7 +++++++ openapi/paths/products.yaml | 21 +++++++++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index b04cae70cae0..28be00fbd705 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -11670,6 +11670,13 @@ paths: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - name: filter + in: query + description: Filter by product name + required: false + schema: + type: string + example: bob responses: 200: description: "A list of products" diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index 209b3d4fbf3a..fe9e08892b09 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -12,6 +12,27 @@ - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - name: filter + in: query + description: Filter by product name + required: false + schema: + type: string + example: bob + - name: product_key + in: query + description: Filter by product key + required: false + schema: + type: string + example: bob + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc product_key|desc responses: 200: description: "A list of products" From fb669e31f3c8033c6aaf06139acea6fdf8676170 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 15:28:38 +1100 Subject: [PATCH 09/33] Fixes for product docs --- openapi/api-docs.yaml | 17 +++++++++++++++-- openapi/paths/products.yaml | 3 +-- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 28be00fbd705..ce3353187743 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -11677,6 +11677,20 @@ paths: schema: type: string example: bob + - name: product_key + in: query + description: Filter by product key + required: false + schema: + type: string + example: bob + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc product_key|desc responses: 200: description: "A list of products" @@ -11987,8 +12001,6 @@ paths: type: string format: string example: D2J234DFA - produces: - - application/json requestBody: required: true content: @@ -12002,6 +12014,7 @@ paths: documents: type: array format: binary + responses: 200: description: "Returns the Product object" headers: diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index fe9e08892b09..a84a0d474b48 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -343,8 +343,6 @@ type: string format: string example: D2J234DFA - produces: - - application/json requestBody: required: true content: @@ -358,6 +356,7 @@ documents: type: array format: binary + responses: 200: description: "Returns the Product object" headers: From 3889c3cb5305144a3f076e52524b4d60a2750b3a Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 19:58:40 +1100 Subject: [PATCH 10/33] openapi --- app/Console/Commands/OpenApiYaml.php | 10 + openapi/api-docs.yaml | 2149 ++++++++++++++------------ openapi/components.yaml | 193 +-- openapi/paths.yaml | 471 +----- openapi/paths/clients.yaml | 6 + openapi/paths/products.yaml | 7 + 6 files changed, 1195 insertions(+), 1641 deletions(-) diff --git a/app/Console/Commands/OpenApiYaml.php b/app/Console/Commands/OpenApiYaml.php index 5c22ad0c8487..204f06b9abad 100644 --- a/app/Console/Commands/OpenApiYaml.php +++ b/app/Console/Commands/OpenApiYaml.php @@ -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')); //iterate schemas diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index ce3353187743..b679c33b5c82 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -4232,472 +4232,7 @@ paths: $ref: "#/components/responses/422" 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: get: tags: @@ -7572,7 +7107,7 @@ paths: "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: - - invoices + - recurring_invoices summary: "Download a specific invoice by invitation key" description: "Downloads a specific invoice" operationId: downloadRecurringInvoice @@ -9476,7 +9011,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/invoices/task_schedulers: + /api/v1/task_schedulers/create: get: tags: - task_schedulers @@ -11656,387 +11191,6 @@ paths: default: $ref: "#/components/responses/default" - /api/v1/products: - get: - tags: - - products - summary: "List products" - description: | - Lists products, search and filters allow fine grained lists to be generated. - Query parameters can be added to perform fine grained filtering of the products list, these are handled by the ProductFilters class - which defines the methods available - operationId: getProducts - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: filter - in: query - description: Filter by product name - required: false - schema: - type: string - example: bob - - name: product_key - in: query - description: Filter by product key - required: false - schema: - type: string - example: bob - - name: sort - in: query - description: Returns the list sorted by column in ascending or descending order. - required: false - schema: - type: string - example: id|desc product_key|desc - responses: - 200: - description: "A list of products" - 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/Product" - 401: - $ref: '#/components/responses/401' - 403: - $ref: '#/components/responses/403' - 422: - $ref: '#/components/responses/422' - default: - $ref: '#/components/responses/default' - post: - tags: - - products - summary: "Create Product" - description: "Adds a product to a company" - operationId: storeProduct - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved product 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/Product" - 401: - $ref: '#/components/responses/401' - 403: - $ref: '#/components/responses/403' - 422: - $ref: '#/components/responses/422' - default: - $ref: '#/components/responses/default' - "/api/v1/products/{id}": - get: - tags: - - products - summary: "Show product" - description: "Displays a product by id" - operationId: showProduct - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Product Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the product 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/Product" - 401: - $ref: '#/components/responses/401' - 403: - $ref: '#/components/responses/403' - 422: - $ref: '#/components/responses/422' - default: - $ref: '#/components/responses/default' - put: - tags: - - products - summary: "Update product" - description: "Handles the updating of a product by id" - operationId: updateProduct - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Product Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Product 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/Product" - 401: - $ref: '#/components/responses/401' - 403: - $ref: '#/components/responses/403' - 422: - $ref: '#/components/responses/422' - default: - $ref: '#/components/responses/default' - delete: - tags: - - products - summary: "Delete product" - description: "Handles the deletion of a product by id" - operationId: deleteProduct - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Product 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/products/{id}/edit": - get: - tags: - - products - summary: "Edit product" - description: "Displays an Product by id" - operationId: editProduct - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Product Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Product 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/Product" - 401: - $ref: '#/components/responses/401' - 403: - $ref: '#/components/responses/403' - 422: - $ref: '#/components/responses/422' - default: - $ref: '#/components/responses/default' - "/api/v1/products/create": - get: - tags: - - products - summary: "Blank product" - description: "Returns a blank product object with default values" - operationId: getProductsCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank Product 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/Product" - 401: - $ref: '#/components/responses/401' - 403: - $ref: '#/components/responses/403' - 422: - $ref: '#/components/responses/422' - default: - $ref: '#/components/responses/default' - - /api/v1/products/bulk: - post: - tags: - - products - summary: "Bulk product actions" - description: "Archive / Restore / Delete in bulk" - operationId: bulkProducts - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "Hashed IDs" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Product response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Product" - 401: - $ref: '#/components/responses/401' - 403: - $ref: '#/components/responses/403' - 422: - $ref: '#/components/responses/422' - default: - $ref: '#/components/responses/default' - - "/api/v1/products/{id}/upload": - put: - tags: - - products - summary: "Add product document" - description: "Handles the uploading of a document to a product" - operationId: uploadProduct - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/client_include" - - name: id - in: path - description: "The Product Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - requestBody: - required: true - content: - multipart/form-data: - schema: - type: object - properties: - _method: - type: string - example: POST - documents: - type: array - format: binary - responses: - 200: - description: "Returns the Product 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/Product" - 401: - $ref: '#/components/responses/401' - 403: - $ref: '#/components/responses/403' - 422: - $ref: '#/components/responses/422' - default: - $ref: '#/components/responses/default' - /api/v1/clients: get: tags: @@ -12050,6 +11204,12 @@ paths: - $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/client_include' - $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 in: query description: Filter by client name @@ -12590,7 +11750,1009 @@ paths: $ref: '#/components/responses/422' default: $ref: '#/components/responses/default' + /api/v1/products: + get: + tags: + - products + summary: "List products" + description: | + Lists products, search and filters allow fine grained lists to be generated. + Query parameters can be added to perform fine grained filtering of the products list, these are handled by the ProductFilters class + which defines the methods available + operationId: getProducts + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/status" + - $ref: "#/components/parameters/client_id" + - $ref: "#/components/parameters/created_at" + - $ref: "#/components/parameters/updated_at" + - $ref: "#/components/parameters/is_deleted" + - $ref: "#/components/parameters/filter_deleted_clients" + - $ref: "#/components/parameters/vendor_id" + - name: filter + in: query + description: Filter by product name + required: false + schema: + type: string + example: bob + - name: product_key + in: query + description: Filter by product key + required: false + schema: + type: string + example: bob + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc product_key|desc + responses: + 200: + description: "A list of products" + 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/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + post: + tags: + - products + summary: "Create Product" + description: "Adds a product to a company" + operationId: storeProduct + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved product 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/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + "/api/v1/products/{id}": + get: + tags: + - products + summary: "Show product" + description: "Displays a product by id" + operationId: showProduct + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Product Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the product 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/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + put: + tags: + - products + summary: "Update product" + description: "Handles the updating of a product by id" + operationId: updateProduct + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Product Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Product 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/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + delete: + tags: + - products + summary: "Delete product" + description: "Handles the deletion of a product by id" + operationId: deleteProduct + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Product 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/products/{id}/edit": + get: + tags: + - products + summary: "Edit product" + description: "Displays an Product by id" + operationId: editProduct + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Product Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Product 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/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + "/api/v1/products/create": + get: + tags: + - products + summary: "Blank product" + description: "Returns a blank product object with default values" + operationId: getProductsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank Product 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/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + + /api/v1/products/bulk: + post: + tags: + - products + summary: "Bulk product actions" + description: "Archive / Restore / Delete in bulk" + operationId: bulkProducts + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "Hashed IDs" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Product response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + + "/api/v1/products/{id}/upload": + put: + tags: + - products + summary: "Add product document" + description: "Handles the uploading of a document to a product" + operationId: uploadProduct + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/client_include" + - name: id + in: path + description: "The Product Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + requestBody: + required: true + content: + multipart/form-data: + schema: + type: object + properties: + _method: + type: string + example: POST + documents: + type: array + format: binary + responses: + 200: + description: "Returns the Product 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/Product" + 401: + $ref: '#/components/responses/401' + 403: + $ref: '#/components/responses/403' + 422: + $ref: '#/components/responses/422' + default: + $ref: '#/components/responses/default' + + /api/v1/invoices: + get: + tags: + - invoices + summary: "List invoices" + description: | + Lists invoices, search and filters allow fine grained lists to be generated. + Query 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" + - $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: client_status + in: query + description: | + A comma separated list of invoice status strings. Valid options include: + - all + - paid + - unpaid + - overdue + required: false + schema: + type: string + example: ?client_status=paid,unpaid + - name: number + in: query + description: | + Search invoices by invoice number + required: false + schema: + type: string + example: ?number=INV-001 + - name: filter + in: query + description: | + Searches across a range of columns including: + - number + - po_number + - date + - amount + - balance + - custom_value1 + - custom_value2 + - custom_value3 + - custom_value4 + required: false + schema: + type: string + example: ?filter=bob + - name: without_deleted_clients + in: query + description: | + Returns the invoice list without the invoices of deleted clients. + required: false + schema: + type: string + example: ?without_deleted_clients= + - name: overdue + in: query + description: | + Returns the list of invoices that are overdue + required: false + schema: + type: string + example: ?over_due= + - name: payable + in: query + description: | + Returns the invoice list that are payable for a defined client. Please note, you must pass the client_id as the value for this query parameter + required: false + schema: + type: string + example: ?payable={client_id} + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc number|desc balance|asc + - name: private_notes + in: query + description: | + Searches on the private_notes field of the invoices + required: false + schema: + type: string + example: ?private_notes=super secret + 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: "Create invoice" + description: "Adds a invoice to a company" + 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/{id}": + get: + tags: + - invoices + summary: "Show 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: "Update 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: "Delete 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: "Edit invoice" + 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/create: + get: + tags: + - invoices + summary: "Blank invoice" + 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/bulk: + post: + tags: + - invoices + summary: "Bulk invoice actions" + 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: + deprecated: true + tags: + - invoices + summary: "Custom invoice action" + description: | + Performs a custom action on an invoice. + The current range of actions are as follows + - clone_to_invoice + - clone_to_quote + - history + - delivery_note + - mark_paid + - download + - archive + - delete + - 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 invoice PDF" + 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 delivery note" + 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: "Add invoice document" + 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" components: + headers: + X-MINIMUM-CLIENT-VERSION: + description: 'The API version' + schema: + type: number + X-RateLimit-Remaining: + description: 'The number of requests left for the time window.' + schema: + type: integer + X-RateLimit-Limit: + description: 'The total number of requests in a given time window.' + schema: + type: integer + components: + securitySchemes: + ApiKeyAuth: + type: apiKey + in: header + name: X-API-TOKEN + responses: + 422: + description: 'Validation error' + content: + application/json: + schema: + $ref: '#/components/schemas/ValidationError' + 403: + description: 'Authorization error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthorizationError' + 401: + description: 'Authentication error' + content: + application/json: + schema: + $ref: '#components/schemas/AuthenticationError' + + default: + description: 'Unexpected Error' + content: + application/json: + schema: + $ref: '#/components/schemas/Error' parameters: X-API-SECRET: name: X-API-SECRET @@ -12782,51 +12944,76 @@ components: schema: type: number example: user - headers: - X-MINIMUM-CLIENT-VERSION: - description: 'The API version' + +########################### Generic filters available across all filter ################################## + status: + name: status + in: query + description: | + Filter the entity based on their status. ie active / archived / deleted. Format is a comma separated string with any of the following options: + - active + - archived + - deleted + required: false schema: - type: number - X-RateLimit-Remaining: - description: 'The number of requests left for the time window.' + type: string + example: ?status=archived,deleted + client_id: + name: client_id + in: query + description: | + Filters the entity list by client_id. Suitable when you only want the entities of a specific client. + required: false + schema: + type: string + example: ?client_id={client_id} + created_at: + name: created_at + in: query + description: | + Filters the entity list by the created at timestamp. Parameter value can be a datetime string or unix timestamp + required: false schema: type: integer - X-RateLimit-Limit: - description: 'The total number of requests in a given time window.' + example: ?created_at=2022-01-10 + updated_at: + name: updated_at + in: query + description: | + Filters the entity list by the updated at timestamp. Parameter value can be a datetime string or unix timestamp + required: false schema: type: integer - components: - securitySchemes: - ApiKeyAuth: - type: apiKey - in: header - name: X-API-TOKEN - responses: - 403: - description: 'Authorization error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthorizationError' + example: ?updated_at=2022-01-10 + is_deleted: + name: is_deleted + in: query + description: | + Filters the entity list by entities that have been deleted. + required: false + schema: + type: booleans + example: ?is_deleted=true + vendor_id: + name: vendor_id + in: query + description: | + Filters the entity list by an associated vendor + required: false + schema: + type: string + example: ?vendor_id={vendor_id} + filter_deleted_clients: + name: filter_deleted_clients + in: query + description: | + Filters the entity list and only returns entities for clients that have not been deleted + required: false + schema: + type: string + example: ?filter_deleted_clients=true + ########################### Generic filters available across all filter ################################## - default: - description: 'Unexpected Error' - content: - application/json: - schema: - $ref: '#/components/schemas/Error' - 422: - description: 'Validation error' - content: - application/json: - schema: - $ref: '#/components/schemas/ValidationError' - 401: - description: 'Authentication error' - content: - application/json: - schema: - $ref: '#components/schemas/AuthenticationError' schemas: BankTransactionRule: properties: @@ -16675,6 +16862,99 @@ components: type: string example: JSON type: object + Activity: + properties: + id: + description: 'The id field of the activity' + type: string + example: Opnel5aKBz + activity_type_id: + description: 'The activity type id' + type: string + example: Opnel5aKBz + client_id: + description: 'The client hashed id' + type: string + example: Opnel5aKBz + company_id: + description: 'The company hashed id' + type: string + example: Opnel5aKBz + user_id: + description: 'The user hashed id' + type: string + example: Opnel5aKBz + invoice_id: + description: 'The invoice hashed id' + type: string + example: Opnel5aKBz + payment_id: + description: 'The payment hashed id' + type: string + example: Opnel5aKBz + credit_id: + description: 'The credit hashed id' + type: string + example: Opnel5aKBz + updated_at: + description: 'Unixtimestamp the last time the record was updated' + type: integer + example: '343421434' + expense_id: + description: 'The expense hashed id' + type: string + example: Opnel5aKBz + is_system: + description: 'Defines is the activity was performed by the system' + type: boolean + example: true + contact_id: + description: 'The contact hashed id' + type: string + example: Opnel5aKBz + task_id: + description: 'The task hashed id' + type: string + example: Opnel5aKBz + notes: + description: 'Activity Notes' + type: string + example: Opnel5aKBz + token_id: + description: 'The hashed ID of the token who performed the action' + type: string + example: Opnel5aKBz + ip: + description: 'The IP Address of the user who performed the action' + type: string + example: 192.168.1.252 + user: + $ref: '#/components/schemas/User' + client: + $ref: '#/components/schemas/Client' + contact: + $ref: '#/components/schemas/ClientContact' + recurring_invoice: + $ref: '#/components/schemas/RecurringInvoice' + invoice: + $ref: '#/components/schemas/Invoice' + credit: + $ref: '#/components/schemas/Credit' + quote: + $ref: '#/components/schemas/Quote' + payment: + $ref: '#/components/schemas/Payment' + expense: + $ref: '#/components/schemas/Expense' + task: + $ref: '#/components/schemas/Task' + purchase_order: + $ref: '#/components/schemas/PurchaseOrder' + vendor: + $ref: '#/components/schemas/Vendor' + vendor_contact: + $ref: '#/components/schemas/VendorContact' + type: object BankTransaction: properties: id: @@ -16777,99 +17057,6 @@ components: type: string example: USD type: object - Activity: - properties: - id: - description: 'The id field of the activity' - type: string - example: Opnel5aKBz - activity_type_id: - description: 'The activity type id' - type: string - example: Opnel5aKBz - client_id: - description: 'The client hashed id' - type: string - example: Opnel5aKBz - company_id: - description: 'The company hashed id' - type: string - example: Opnel5aKBz - user_id: - description: 'The user hashed id' - type: string - example: Opnel5aKBz - invoice_id: - description: 'The invoice hashed id' - type: string - example: Opnel5aKBz - payment_id: - description: 'The payment hashed id' - type: string - example: Opnel5aKBz - credit_id: - description: 'The credit hashed id' - type: string - example: Opnel5aKBz - updated_at: - description: 'Unixtimestamp the last time the record was updated' - type: integer - example: '343421434' - expense_id: - description: 'The expense hashed id' - type: string - example: Opnel5aKBz - is_system: - description: 'Defines is the activity was performed by the system' - type: boolean - example: true - contact_id: - description: 'The contact hashed id' - type: string - example: Opnel5aKBz - task_id: - description: 'The task hashed id' - type: string - example: Opnel5aKBz - notes: - description: 'Activity Notes' - type: string - example: Opnel5aKBz - token_id: - description: 'The hashed ID of the token who performed the action' - type: string - example: Opnel5aKBz - ip: - description: 'The IP Address of the user who performed the action' - type: string - example: 192.168.1.252 - user: - $ref: '#/components/schemas/User' - client: - $ref: '#/components/schemas/Client' - contact: - $ref: '#/components/schemas/ClientContact' - recurring_invoice: - $ref: '#/components/schemas/RecurringInvoice' - invoice: - $ref: '#/components/schemas/Invoice' - credit: - $ref: '#/components/schemas/Credit' - quote: - $ref: '#/components/schemas/Quote' - payment: - $ref: '#/components/schemas/Payment' - expense: - $ref: '#/components/schemas/Expense' - task: - $ref: '#/components/schemas/Task' - purchase_order: - $ref: '#/components/schemas/PurchaseOrder' - vendor: - $ref: '#/components/schemas/Vendor' - vendor_contact: - $ref: '#/components/schemas/VendorContact' - type: object BTRules: properties: data_key: diff --git a/openapi/components.yaml b/openapi/components.yaml index 040a5958ae45..65782649627f 100644 --- a/openapi/components.yaml +++ b/openapi/components.yaml @@ -1,195 +1,4 @@ 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: X-MINIMUM-CLIENT-VERSION: description: 'The API version' @@ -208,4 +17,4 @@ components: ApiKeyAuth: type: apiKey in: header - name: X-API-TOKEN \ No newline at end of file + name: X-API-TOKEN \ No newline at end of file diff --git a/openapi/paths.yaml b/openapi/paths.yaml index e4cc18be5806..8fb171a2f31c 100644 --- a/openapi/paths.yaml +++ b/openapi/paths.yaml @@ -4208,472 +4208,7 @@ paths: $ref: "#/components/responses/422" 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: get: tags: @@ -7548,7 +7083,7 @@ paths: "/api/v1/recurring_invoice/{invitation_key}/download": get: tags: - - invoices + - recurring_invoices summary: "Download a specific invoice by invitation key" description: "Downloads a specific invoice" operationId: downloadRecurringInvoice @@ -9452,7 +8987,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/invoices/task_schedulers: + /api/v1/task_schedulers/create: get: tags: - task_schedulers diff --git a/openapi/paths/clients.yaml b/openapi/paths/clients.yaml index 55efd92ea611..ba4fb19277a4 100644 --- a/openapi/paths/clients.yaml +++ b/openapi/paths/clients.yaml @@ -11,6 +11,12 @@ - $ref: '#/components/parameters/X-Requested-With' - $ref: '#/components/parameters/client_include' - $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 in: query description: Filter by client name diff --git a/openapi/paths/products.yaml b/openapi/paths/products.yaml index a84a0d474b48..cb87d455447f 100644 --- a/openapi/paths/products.yaml +++ b/openapi/paths/products.yaml @@ -12,6 +12,13 @@ - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/status" + - $ref: "#/components/parameters/client_id" + - $ref: "#/components/parameters/created_at" + - $ref: "#/components/parameters/updated_at" + - $ref: "#/components/parameters/is_deleted" + - $ref: "#/components/parameters/filter_deleted_clients" + - $ref: "#/components/parameters/vendor_id" - name: filter in: query description: Filter by product name From 4f966c775c47aaa47520b491ef3fbc6348f72744 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 19:58:52 +1100 Subject: [PATCH 11/33] openapi --- openapi/components/parameters.yaml | 192 ++++++ .../parameters/default_filters.yaml | 68 ++ openapi/paths/invoices.yaml | 585 ++++++++++++++++++ 3 files changed, 845 insertions(+) create mode 100644 openapi/components/parameters.yaml create mode 100644 openapi/components/parameters/default_filters.yaml create mode 100644 openapi/paths/invoices.yaml diff --git a/openapi/components/parameters.yaml b/openapi/components/parameters.yaml new file mode 100644 index 000000000000..2ec66fbb7dc9 --- /dev/null +++ b/openapi/components/parameters.yaml @@ -0,0 +1,192 @@ + 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 + \ No newline at end of file diff --git a/openapi/components/parameters/default_filters.yaml b/openapi/components/parameters/default_filters.yaml new file mode 100644 index 000000000000..a6a489a019b5 --- /dev/null +++ b/openapi/components/parameters/default_filters.yaml @@ -0,0 +1,68 @@ +########################### Generic filters available across all filter ################################## + status: + name: status + in: query + description: | + Filter the entity based on their status. ie active / archived / deleted. Format is a comma separated string with any of the following options: + - active + - archived + - deleted + required: false + schema: + type: string + example: ?status=archived,deleted + client_id: + name: client_id + in: query + description: | + Filters the entity list by client_id. Suitable when you only want the entities of a specific client. + required: false + schema: + type: string + example: ?client_id={client_id} + created_at: + name: created_at + in: query + description: | + Filters the entity list by the created at timestamp. Parameter value can be a datetime string or unix timestamp + required: false + schema: + type: integer + example: ?created_at=2022-01-10 + updated_at: + name: updated_at + in: query + description: | + Filters the entity list by the updated at timestamp. Parameter value can be a datetime string or unix timestamp + required: false + schema: + type: integer + example: ?updated_at=2022-01-10 + is_deleted: + name: is_deleted + in: query + description: | + Filters the entity list by entities that have been deleted. + required: false + schema: + type: booleans + example: ?is_deleted=true + vendor_id: + name: vendor_id + in: query + description: | + Filters the entity list by an associated vendor + required: false + schema: + type: string + example: ?vendor_id={vendor_id} + filter_deleted_clients: + name: filter_deleted_clients + in: query + description: | + Filters the entity list and only returns entities for clients that have not been deleted + required: false + schema: + type: string + example: ?filter_deleted_clients=true + ########################### Generic filters available across all filter ################################## diff --git a/openapi/paths/invoices.yaml b/openapi/paths/invoices.yaml new file mode 100644 index 000000000000..2008cf9c23f6 --- /dev/null +++ b/openapi/paths/invoices.yaml @@ -0,0 +1,585 @@ + /api/v1/invoices: + get: + tags: + - invoices + summary: "List invoices" + description: | + Lists invoices with the option to chain multiple query parameters allowing fine grained filtering of the list. + + operationId: getInvoices + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/status" + - $ref: "#/components/parameters/client_id" + - $ref: "#/components/parameters/created_at" + - $ref: "#/components/parameters/updated_at" + - $ref: "#/components/parameters/is_deleted" + - $ref: "#/components/parameters/filter_deleted_clients" + - $ref: "#/components/parameters/vendor_id" + - name: client_status + in: query + description: | + A comma separated list of invoice status strings. Valid options include: + - all + - paid + - unpaid + - overdue + required: false + schema: + type: string + example: ?client_status=paid,unpaid + - name: number + in: query + description: | + Search invoices by invoice number + required: false + schema: + type: string + example: ?number=INV-001 + - name: filter + in: query + description: | + Searches across a range of columns including: + - number + - po_number + - date + - amount + - balance + - custom_value1 + - custom_value2 + - custom_value3 + - custom_value4 + required: false + schema: + type: string + example: ?filter=bob + - name: without_deleted_clients + in: query + description: | + Returns the invoice list without the invoices of deleted clients. + required: false + schema: + type: string + example: ?without_deleted_clients= + - name: overdue + in: query + description: | + Returns the list of invoices that are overdue + required: false + schema: + type: string + example: ?over_due= + - name: payable + in: query + description: | + Returns the invoice list that are payable for a defined client. Please note, you must pass the client_id as the value for this query parameter + required: false + schema: + type: string + example: ?payable={client_id} + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc number|desc balance|asc + - name: private_notes + in: query + description: | + Searches on the private_notes field of the invoices + required: false + schema: + type: string + example: ?private_notes=super secret + 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: "Create invoice" + description: "Adds a invoice to a company" + 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 entity" + 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: "Show 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: "Update 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: "Delete 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: "Edit invoice" + description: "Displays an invoice by id for editting" + 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/create: + get: + tags: + - invoices + summary: "Blank invoice" + 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/bulk: + post: + tags: + - invoices + summary: "Bulk invoice actions" + description: "" + operationId: bulkInvoices + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "Bulk action details" + required: true + content: + application/json: + schema: + type: object + properties: + action: + type: string + description: "The action to be performed" + examples: + bulk_download: + value: bulk_download + summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) + account: + value: account + summary: The associated Account + bank_transactions: + value: bank_transactions + summary: The associated Bank Transactions + ids: + 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: + deprecated: true + tags: + - invoices + summary: "Custom invoice action" + description: | + Performs a custom action on an invoice. + The current range of actions are as follows + - clone_to_invoice + - clone_to_quote + - history + - delivery_note + - mark_paid + - download + - archive + - delete + - 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 invoice PDF" + 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 delivery note" + 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: "Add invoice document" + 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" \ No newline at end of file From 9aadac237794dcfc7925f32bb0be98b5ff0ec42d Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 20:05:13 +1100 Subject: [PATCH 12/33] Invoice API Documentation --- openapi/api-docs.yaml | 71 +++++++++++++++++++++++++++++++------ openapi/paths/invoices.yaml | 45 +++++++++++++++++++---- 2 files changed, 99 insertions(+), 17 deletions(-) diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index b679c33b5c82..329e314a1580 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -12144,9 +12144,8 @@ paths: - invoices summary: "List invoices" description: | - Lists invoices, search and filters allow fine grained lists to be generated. - Query 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" + Lists invoices with the option to chain multiple query parameters allowing fine grained filtering of the list. + operationId: getInvoices parameters: - $ref: "#/components/parameters/X-API-TOKEN" @@ -12275,7 +12274,7 @@ paths: $ref: "#/components/schemas/FillableInvoice" responses: 200: - description: "Returns the saved invoice object" + description: "Returns the saved invoice entity" headers: X-MINIMUM-CLIENT-VERSION: $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" @@ -12419,7 +12418,7 @@ paths: tags: - invoices summary: "Edit invoice" - description: "Displays an invoice by id" + description: "Displays an invoice by id for editting" operationId: editInvoice parameters: - $ref: "#/components/parameters/X-API-TOKEN" @@ -12502,16 +12501,66 @@ paths: - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/index" requestBody: - description: "User credentials" + description: "Bulk action details" 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]" + type: object + properties: + action: + type: string + description: "The action to be performed" + examples: + bulk_download: + value: bulk_download + summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) + download: + value: download + summary: Download a single PDF. (Returns a single PDF object) + bulk_print: + value: bulk_print + summary: Merges an array of Invoice PDFs for easy one click printing. + auto_bill: + value: auto_bill + summary: Attempts to automatically bill the invoices with the payment method on file. + clone_to_invoice: + value: clone_to_invoice + summary: Returns a clone of the invoice. + clone_to_quote: + value: clone_to_quote + summary: Returns a quote cloned using the properties of the given invoice. + mark_paid: + value: mark_paid + summary: Marks an array of invoices as paid. + mark_sent: + value: mark_sent + summary: Marks an array of invoices as sent. + restore: + value: restore + summary: Restores an array of invoices + delete: + value: delete + summary: Deletes an array of invoices + archive: + value: archive + summary: Archives an array of invoices + cancel: + value: cancel + summary: Cancels an array of invoices + email: + value: email + summary: Emails an array of invoices + send_email: + value: send_email + summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` + ids: + 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" diff --git a/openapi/paths/invoices.yaml b/openapi/paths/invoices.yaml index 2008cf9c23f6..1e5ef306854c 100644 --- a/openapi/paths/invoices.yaml +++ b/openapi/paths/invoices.yaml @@ -375,12 +375,45 @@ bulk_download: value: bulk_download summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) - account: - value: account - summary: The associated Account - bank_transactions: - value: bank_transactions - summary: The associated Bank Transactions + download: + value: download + summary: Download a single PDF. (Returns a single PDF object) + bulk_print: + value: bulk_print + summary: Merges an array of Invoice PDFs for easy one click printing. + auto_bill: + value: auto_bill + summary: Attempts to automatically bill the invoices with the payment method on file. + clone_to_invoice: + value: clone_to_invoice + summary: Returns a clone of the invoice. + clone_to_quote: + value: clone_to_quote + summary: Returns a quote cloned using the properties of the given invoice. + mark_paid: + value: mark_paid + summary: Marks an array of invoices as paid. + mark_sent: + value: mark_sent + summary: Marks an array of invoices as sent. + restore: + value: restore + summary: Restores an array of invoices + delete: + value: delete + summary: Deletes an array of invoices + archive: + value: archive + summary: Archives an array of invoices + cancel: + value: cancel + summary: Cancels an array of invoices + email: + value: email + summary: Emails an array of invoices + send_email: + value: send_email + summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` ids: type: array items: From 7cdf3f37b03686f22bfb6e2f6cef96a458f3e9d3 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 20:30:10 +1100 Subject: [PATCH 13/33] Invoice API Documentation --- openapi/api-docs.yaml | 85 ++++++++++++++++--------------------- openapi/paths/invoices.yaml | 85 ++++++++++++++++--------------------- 2 files changed, 72 insertions(+), 98 deletions(-) diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 329e314a1580..a1a08663cbf6 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -12494,7 +12494,37 @@ paths: tags: - invoices summary: "Bulk invoice actions" - description: "" + description: | + There are multiple actions that are available including: + - bulk_download + summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) + - download + summary: Download a single PDF. (Returns a single PDF object) + - bulk_print + summary: Merges an array of Invoice PDFs for easy one click printing. + - auto_bill + summary: Attempts to automatically bill the invoices with the payment method on file. + - clone_to_invoice + summary: Returns a clone of the invoice. + - clone_to_quote + summary: Returns a quote cloned using the properties of the given invoice. + - mark_paid + summary: Marks an array of invoices as paid. + - mark_sent + summary: Marks an array of invoices as sent. + - restore + summary: Restores an array of invoices + - delete + summary: Deletes an array of invoices + - archive + summary: Archives an array of invoices + - cancel + summary: Cancels an array of invoices + - email + summary: Emails an array of invoices + - send_email + summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` + operationId: bulkInvoices parameters: - $ref: "#/components/parameters/X-API-TOKEN" @@ -12510,57 +12540,14 @@ paths: properties: action: type: string - description: "The action to be performed" - examples: - bulk_download: - value: bulk_download - summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) - download: - value: download - summary: Download a single PDF. (Returns a single PDF object) - bulk_print: - value: bulk_print - summary: Merges an array of Invoice PDFs for easy one click printing. - auto_bill: - value: auto_bill - summary: Attempts to automatically bill the invoices with the payment method on file. - clone_to_invoice: - value: clone_to_invoice - summary: Returns a clone of the invoice. - clone_to_quote: - value: clone_to_quote - summary: Returns a quote cloned using the properties of the given invoice. - mark_paid: - value: mark_paid - summary: Marks an array of invoices as paid. - mark_sent: - value: mark_sent - summary: Marks an array of invoices as sent. - restore: - value: restore - summary: Restores an array of invoices - delete: - value: delete - summary: Deletes an array of invoices - archive: - value: archive - summary: Archives an array of invoices - cancel: - value: cancel - summary: Cancels an array of invoices - email: - value: email - summary: Emails an array of invoices - send_email: - value: send_email - summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` + description: "The action to be performed ie 'bulk_download'" + required: true ids: + required: true type: array items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - + description: "Array of hashed IDs to be bulk 'actioned - [{invoice_id_1},{invoice_id_2},{invoice_id_3},{invoice_id_4}]" + type: string responses: 200: description: "The Bulk Action response" diff --git a/openapi/paths/invoices.yaml b/openapi/paths/invoices.yaml index 1e5ef306854c..9030d1e35535 100644 --- a/openapi/paths/invoices.yaml +++ b/openapi/paths/invoices.yaml @@ -354,7 +354,37 @@ tags: - invoices summary: "Bulk invoice actions" - description: "" + description: | + There are multiple actions that are available including: + - bulk_download + summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) + - download + summary: Download a single PDF. (Returns a single PDF object) + - bulk_print + summary: Merges an array of Invoice PDFs for easy one click printing. + - auto_bill + summary: Attempts to automatically bill the invoices with the payment method on file. + - clone_to_invoice + summary: Returns a clone of the invoice. + - clone_to_quote + summary: Returns a quote cloned using the properties of the given invoice. + - mark_paid + summary: Marks an array of invoices as paid. + - mark_sent + summary: Marks an array of invoices as sent. + - restore + summary: Restores an array of invoices + - delete + summary: Deletes an array of invoices + - archive + summary: Archives an array of invoices + - cancel + summary: Cancels an array of invoices + - email + summary: Emails an array of invoices + - send_email + summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` + operationId: bulkInvoices parameters: - $ref: "#/components/parameters/X-API-TOKEN" @@ -370,57 +400,14 @@ properties: action: type: string - description: "The action to be performed" - examples: - bulk_download: - value: bulk_download - summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) - download: - value: download - summary: Download a single PDF. (Returns a single PDF object) - bulk_print: - value: bulk_print - summary: Merges an array of Invoice PDFs for easy one click printing. - auto_bill: - value: auto_bill - summary: Attempts to automatically bill the invoices with the payment method on file. - clone_to_invoice: - value: clone_to_invoice - summary: Returns a clone of the invoice. - clone_to_quote: - value: clone_to_quote - summary: Returns a quote cloned using the properties of the given invoice. - mark_paid: - value: mark_paid - summary: Marks an array of invoices as paid. - mark_sent: - value: mark_sent - summary: Marks an array of invoices as sent. - restore: - value: restore - summary: Restores an array of invoices - delete: - value: delete - summary: Deletes an array of invoices - archive: - value: archive - summary: Archives an array of invoices - cancel: - value: cancel - summary: Cancels an array of invoices - email: - value: email - summary: Emails an array of invoices - send_email: - value: send_email - summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` + description: "The action to be performed ie 'bulk_download'" + required: true ids: + required: true type: array items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - + description: "Array of hashed IDs to be bulk 'actioned - [{invoice_id_1},{invoice_id_2},{invoice_id_3},{invoice_id_4}]" + type: string responses: 200: description: "The Bulk Action response" From dcf5a62396fcb5f9580c174d4d0fb15218fd0dc5 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sat, 18 Feb 2023 22:03:01 +1100 Subject: [PATCH 14/33] Invoice API Documentation --- openapi/api-docs.yaml | 65 ++++++++++++++++++++----------------- openapi/paths/invoices.yaml | 65 ++++++++++++++++++++----------------- 2 files changed, 70 insertions(+), 60 deletions(-) diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index a1a08663cbf6..5c206ec305b2 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -12496,34 +12496,6 @@ paths: summary: "Bulk invoice actions" description: | There are multiple actions that are available including: - - bulk_download - summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) - - download - summary: Download a single PDF. (Returns a single PDF object) - - bulk_print - summary: Merges an array of Invoice PDFs for easy one click printing. - - auto_bill - summary: Attempts to automatically bill the invoices with the payment method on file. - - clone_to_invoice - summary: Returns a clone of the invoice. - - clone_to_quote - summary: Returns a quote cloned using the properties of the given invoice. - - mark_paid - summary: Marks an array of invoices as paid. - - mark_sent - summary: Marks an array of invoices as sent. - - restore - summary: Restores an array of invoices - - delete - summary: Deletes an array of invoices - - archive - summary: Archives an array of invoices - - cancel - summary: Cancels an array of invoices - - email - summary: Emails an array of invoices - - send_email - summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` operationId: bulkInvoices parameters: @@ -12540,14 +12512,47 @@ paths: properties: action: type: string - description: "The action to be performed ie 'bulk_download'" + description: | + The action to be performed, options include: + - `bulk_download` + Bulk download an array of invoice PDFs (These are sent to the admin via email.) + - `download` + Download a single PDF. (Returns a single PDF object) + - `bulk_print` + Merges an array of Invoice PDFs for easy one click printing. + - `auto_bill` + Attempts to automatically bill the invoices with the payment method on file. + - `clone_to_invoice` + Returns a clone of the invoice. + - `clone_to_quote` + Returns a quote cloned using the properties of the given invoice. + - `mark_paid` + Marks an array of invoices as paid. + - `mark_sent` + Marks an array of invoices as sent. + - `restore` + Restores an array of invoices + - `delete` + Deletes an array of invoices + - `archive` + Archives an array of invoices + - `cancel` + Cancels an array of invoices + - `email` + Emails an array of invoices + - `send_email` + Emails an array of invoices. Requires additional properties to be sent. `email_type` required: true ids: required: true type: array items: - description: "Array of hashed IDs to be bulk 'actioned - [{invoice_id_1},{invoice_id_2},{invoice_id_3},{invoice_id_4}]" + description: "Array of hashed IDs to be bulk 'actioned - ['D2J234DFA','D2J234DFA','D2J234DFA']" type: string + example: + action: bulk_download + ids: "['D2J234DFA','D2J234DFA','D2J234DFA']" + responses: 200: description: "The Bulk Action response" diff --git a/openapi/paths/invoices.yaml b/openapi/paths/invoices.yaml index 9030d1e35535..e28a1af59321 100644 --- a/openapi/paths/invoices.yaml +++ b/openapi/paths/invoices.yaml @@ -356,34 +356,6 @@ summary: "Bulk invoice actions" description: | There are multiple actions that are available including: - - bulk_download - summary: Bulk download an array of invoice PDFs (These are sent to the admin via email.) - - download - summary: Download a single PDF. (Returns a single PDF object) - - bulk_print - summary: Merges an array of Invoice PDFs for easy one click printing. - - auto_bill - summary: Attempts to automatically bill the invoices with the payment method on file. - - clone_to_invoice - summary: Returns a clone of the invoice. - - clone_to_quote - summary: Returns a quote cloned using the properties of the given invoice. - - mark_paid - summary: Marks an array of invoices as paid. - - mark_sent - summary: Marks an array of invoices as sent. - - restore - summary: Restores an array of invoices - - delete - summary: Deletes an array of invoices - - archive - summary: Archives an array of invoices - - cancel - summary: Cancels an array of invoices - - email - summary: Emails an array of invoices - - send_email - summary: Emails an array of invoices. Requires additional properties to be sent. `email_type` operationId: bulkInvoices parameters: @@ -400,14 +372,47 @@ properties: action: type: string - description: "The action to be performed ie 'bulk_download'" + description: | + The action to be performed, options include: + - `bulk_download` + Bulk download an array of invoice PDFs (These are sent to the admin via email.) + - `download` + Download a single PDF. (Returns a single PDF object) + - `bulk_print` + Merges an array of Invoice PDFs for easy one click printing. + - `auto_bill` + Attempts to automatically bill the invoices with the payment method on file. + - `clone_to_invoice` + Returns a clone of the invoice. + - `clone_to_quote` + Returns a quote cloned using the properties of the given invoice. + - `mark_paid` + Marks an array of invoices as paid. + - `mark_sent` + Marks an array of invoices as sent. + - `restore` + Restores an array of invoices + - `delete` + Deletes an array of invoices + - `archive` + Archives an array of invoices + - `cancel` + Cancels an array of invoices + - `email` + Emails an array of invoices + - `send_email` + Emails an array of invoices. Requires additional properties to be sent. `email_type` required: true ids: required: true type: array items: - description: "Array of hashed IDs to be bulk 'actioned - [{invoice_id_1},{invoice_id_2},{invoice_id_3},{invoice_id_4}]" + description: "Array of hashed IDs to be bulk 'actioned - ['D2J234DFA','D2J234DFA','D2J234DFA']" type: string + example: + action: bulk_download + ids: "['D2J234DFA','D2J234DFA','D2J234DFA']" + responses: 200: description: "The Bulk Action response" From 4739bd3dc7389eda28109bdb4d6ec0002c8a78dd Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 10:45:49 +1100 Subject: [PATCH 15/33] Add back logging into Ninja Mailer --- app/Jobs/Mail/NinjaMailerJob.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/app/Jobs/Mail/NinjaMailerJob.php b/app/Jobs/Mail/NinjaMailerJob.php index 82a3ec5255ef..b6dc286b23df 100644 --- a/app/Jobs/Mail/NinjaMailerJob.php +++ b/app/Jobs/Mail/NinjaMailerJob.php @@ -611,6 +611,9 @@ class NinjaMailerJob implements ShouldQueue public function failed($exception = null) { + if($exception) + nlog($exception->getMessage()); + config(['queue.failed.driver' => null]); } } From 308e938ce093463cd6e168bd6f95591f134cac53 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 11:32:40 +1100 Subject: [PATCH 16/33] Import PM's that are us_bank_accounts --- .../Stripe/UpdatePaymentMethods.php | 55 +++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/app/PaymentDrivers/Stripe/UpdatePaymentMethods.php b/app/PaymentDrivers/Stripe/UpdatePaymentMethods.php index c52a43ea63bf..70f01f81cbba 100644 --- a/app/PaymentDrivers/Stripe/UpdatePaymentMethods.php +++ b/app/PaymentDrivers/Stripe/UpdatePaymentMethods.php @@ -74,6 +74,61 @@ class UpdatePaymentMethods } $this->importBankAccounts($customer, $client); + + $this->importPMBankAccounts($customer, $client); + + } + + /* ACH may also be nested inside Payment Methods.*/ + public function importPMBankAccounts($customer, $client) + { + $bank_methods = \Stripe\PaymentMethod::all( + [ + 'customer' => $customer->id, + 'type' => 'us_bank_account', + ], + $this->stripe->stripe_connect_auth + ); + + foreach($bank_methods->data as $method) + { + + $token_exists = ClientGatewayToken::where([ + 'gateway_customer_reference' => $customer->id, + 'token' => $method->id, + 'client_id' => $client->id, + 'company_id' => $client->company_id, + ])->exists(); + + /* Already exists return */ + if ($token_exists) { + continue; + } + + $bank_account = $method['us_bank_account']; + + $payment_meta = new \stdClass; + $payment_meta->brand = (string) \sprintf('%s (%s)', $bank_account->bank_name, ctrans('texts.ach')); + $payment_meta->last4 = (string) $bank_account->last4; + $payment_meta->type = GatewayType::BANK_TRANSFER; + $payment_meta->state = 'authorized'; + + $data = [ + 'payment_meta' => $payment_meta, + 'token' => $method->id, + 'payment_method_id' => GatewayType::BANK_TRANSFER, + ]; + + $additional_data = ['gateway_customer_reference' => $customer->id]; + + if ($customer->default_source === $method->id) { + $additional_data = ['gateway_customer_reference' => $customer->id, 'is_default' => 1]; + } + + $this->stripe->storeGatewayToken($data, $additional_data); + + } + } public function importBankAccounts($customer, $client) From 5d5e72eaed2fa1d02b7f6f2b2341f47d1ab98022 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 15:27:41 +1100 Subject: [PATCH 17/33] recurring invoices openapi --- openapi/misc/misc.yaml | 3 + openapi/paths/recurring_invoices.yaml | 466 ++++++++++++++++++++++++++ 2 files changed, 469 insertions(+) create mode 100644 openapi/paths/recurring_invoices.yaml diff --git a/openapi/misc/misc.yaml b/openapi/misc/misc.yaml index 4fef1ce7a532..767c9aab32ce 100644 --- a/openapi/misc/misc.yaml +++ b/openapi/misc/misc.yaml @@ -14,6 +14,9 @@ tags: - name: invoices description: | Endpoint definitions for interacting with invoices. + - name: recurring_invoices + description: | + Endpoint definitions for interacting with recurring_invoices. externalDocs: description: "https://invoiceninja.github.io" url: "https://invoiceninja.github.io" diff --git a/openapi/paths/recurring_invoices.yaml b/openapi/paths/recurring_invoices.yaml new file mode 100644 index 000000000000..32087113e63a --- /dev/null +++ b/openapi/paths/recurring_invoices.yaml @@ -0,0 +1,466 @@ + /api/v1/recurring_invoices: + get: + tags: + - recurring_invoices + summary: "List Recurring Invoices" + description: | + Lists invoices with the option to chain multiple query parameters allowing fine grained filtering of the list. + + operationId: getRecurringInvoices + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/client_id" + - $ref: "#/components/parameters/created_at" + - $ref: "#/components/parameters/updated_at" + - $ref: "#/components/parameters/is_deleted" + - $ref: "#/components/parameters/filter_deleted_clients" + - $ref: "#/components/parameters/vendor_id" + - name: filter + in: query + description: | + Searches across a range of columns including: + - custom_value1 + - custom_value2 + - custom_value3 + - custom_value4 + required: false + schema: + type: string + example: ?filter=bob + - name: client_status + in: query + description: | + A comma separated list of invoice status strings. Valid options include: + - all + - active + - paused + - completed + required: false + schema: + type: string + example: ?client_status=active,paused + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc number|desc balance|asc + responses: + 200: + description: "A list of recurring_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/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - recurring_invoices + summary: "Adds a RecurringInvoice" + description: "Adds an RecurringInvoice to the system" + operationId: storeRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/recurring_invoices/create: + get: + tags: + - recurring_invoices + summary: "Gets a new blank RecurringInvoice object" + description: "Returns a blank object with default values" + operationId: getRecurringInvoicesCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/recurring_invoices/{id}": + get: + tags: + - recurring_invoices + summary: "Shows an RecurringInvoice" + description: "Displays an RecurringInvoice by id" + operationId: showRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - recurring_invoices + summary: "Updates an RecurringInvoice" + description: "Handles the updating of an RecurringInvoice by id" + operationId: updateRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - recurring_invoices + summary: "Deletes a RecurringInvoice" + description: "Handles the deletion of an RecurringInvoice by id" + operationId: deleteRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice 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/recurring_invoices/{id}/edit": + get: + tags: + - recurring_invoices + summary: "Shows an RecurringInvoice for editting" + description: "Displays an RecurringInvoice by id" + operationId: editRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/recurring_invoice/{invitation_key}/download": + get: + tags: + - recurring_invoices + summary: "Download a specific invoice by invitation key" + description: "Downloads a specific invoice" + operationId: downloadRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key + in: path + description: "The Recurring Invoice Invitation Key" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the recurring invoice pdf" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/recurring_invoices/bulk: + post: + tags: + - recurring_invoices + summary: "Performs bulk actions on an array of recurring_invoices" + description: "" + operationId: bulkRecurringInvoices + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "Hashed IDs" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The RecurringInvoice response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/recurring_invoices/{id}/{action}": + get: + tags: + - recurring_invoices + summary: "Performs a custom action on an RecurringInvoice" + description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" + operationId: actionRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice 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 RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/recurring_invoices/{id}/upload": + put: + tags: + - recurring_invoices + summary: "Uploads a document to a recurring_invoice" + description: "Handles the uploading of a document to a recurring_invoice" + operationId: uploadRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" \ No newline at end of file From cb056a034eb1b54049df0dcd28b1dc61213ae08d Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 15:28:38 +1100 Subject: [PATCH 18/33] remove recurring invoics from path.yml --- openapi/paths.yaml | 428 +-------------------------------------------- 1 file changed, 1 insertion(+), 427 deletions(-) diff --git a/openapi/paths.yaml b/openapi/paths.yaml index 8fb171a2f31c..1e2e3ef52e15 100644 --- a/openapi/paths.yaml +++ b/openapi/paths.yaml @@ -6824,433 +6824,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/recurring_invoices: - get: - tags: - - recurring_invoices - summary: "Gets a list of recurring_invoices" - description: "Lists recurring_invoices, 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 recurring_invoices, these are handled by the RecurringInvoiceFilters class which defines the methods available" - operationId: getRecurringInvoices - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A list of recurring_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/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - recurring_invoices - summary: "Adds a RecurringInvoice" - description: "Adds an RecurringInvoice to the system" - operationId: storeRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/recurring_invoices/create: - get: - tags: - - recurring_invoices - summary: "Gets a new blank RecurringInvoice object" - description: "Returns a blank object with default values" - operationId: getRecurringInvoicesCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/recurring_invoices/{id}": - get: - tags: - - recurring_invoices - summary: "Shows an RecurringInvoice" - description: "Displays an RecurringInvoice by id" - operationId: showRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - recurring_invoices - summary: "Updates an RecurringInvoice" - description: "Handles the updating of an RecurringInvoice by id" - operationId: updateRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - recurring_invoices - summary: "Deletes a RecurringInvoice" - description: "Handles the deletion of an RecurringInvoice by id" - operationId: deleteRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice 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/recurring_invoices/{id}/edit": - get: - tags: - - recurring_invoices - summary: "Shows an RecurringInvoice for editting" - description: "Displays an RecurringInvoice by id" - operationId: editRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/recurring_invoice/{invitation_key}/download": - get: - tags: - - recurring_invoices - summary: "Download a specific invoice by invitation key" - description: "Downloads a specific invoice" - operationId: downloadRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: invitation_key - in: path - description: "The Recurring Invoice Invitation Key" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the recurring invoice pdf" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/recurring_invoices/bulk: - post: - tags: - - recurring_invoices - summary: "Performs bulk actions on an array of recurring_invoices" - description: "" - operationId: bulkRecurringInvoices - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "Hashed IDs" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The RecurringInvoice response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/recurring_invoices/{id}/{action}": - get: - tags: - - recurring_invoices - summary: "Performs a custom action on an RecurringInvoice" - description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" - operationId: actionRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice 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 RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/recurring_invoices/{id}/upload": - put: - tags: - - recurring_invoices - summary: "Uploads a document to a recurring_invoice" - description: "Handles the uploading of a document to a recurring_invoice" - operationId: uploadRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" + /api/v1/recurring_quotes: get: tags: From 8e59dfbfcba6888c3446d4ebe0b873c85191dd4d Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 16:16:55 +1100 Subject: [PATCH 19/33] Updates for API docs --- openapi/api-docs.yaml | 6483 +++++++++++++------------ openapi/misc/misc.yaml | 33 + openapi/paths.yaml | 2731 +---------- openapi/paths/credits.yaml | 384 ++ openapi/paths/payments.yaml | 476 ++ openapi/paths/projects.yaml | 342 ++ openapi/paths/purchase_orders.yaml | 427 ++ openapi/paths/quotes.yaml | 477 ++ openapi/paths/recurring_invoices.yaml | 115 +- openapi/paths/tasks.yaml | 371 ++ openapi/paths/vendors.yaml | 342 ++ 11 files changed, 6244 insertions(+), 5937 deletions(-) create mode 100644 openapi/paths/credits.yaml create mode 100644 openapi/paths/payments.yaml create mode 100644 openapi/paths/projects.yaml create mode 100644 openapi/paths/purchase_orders.yaml create mode 100644 openapi/paths/quotes.yaml create mode 100644 openapi/paths/tasks.yaml create mode 100644 openapi/paths/vendors.yaml diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 5c206ec305b2..87ac2c937441 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -2331,390 +2331,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/credits: - get: - tags: - - credits - summary: "Gets a list of 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: "Adds a 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/create: - get: - tags: - - credits - summary: "Gets a new blank credit object" - 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/{id}": - get: - tags: - - credits - summary: "Shows an 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: "Updates an 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: "Deletes a 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: "Shows an credit for editting" - 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/bulk: - post: - tags: - - credits - summary: "Performs bulk actions on an array of credits" - 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 a specific credit by invitation key" - 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: "Uploads a document to a credit" - 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" + /api/v1/designs: get: tags: @@ -4442,443 +4059,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/payments: - get: - tags: - - payments - summary: "Gets a list of payments" - description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" - operationId: getPayments - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A list of payments" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - payments - summary: "Adds a Payment" - description: "Adds an Payment to the system" - operationId: storePayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - requestBody: - description: "The payment request" - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - responses: - 200: - description: "Returns the saved Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/payments/create: - get: - tags: - - payments - summary: "Gets a new blank Payment object" - description: "Returns a blank object with default values" - operationId: getPaymentsCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/payments/{id}": - get: - tags: - - payments - summary: "Shows an Payment" - description: "Displays an Payment by id" - operationId: showPayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - payments - summary: "Updates an Payment" - description: "Handles the updating of an Payment by id" - operationId: updatePayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - payments - summary: "Deletes a Payment" - description: "Handles the deletion of an Payment by id" - operationId: deletePayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/payments/{id}/edit": - get: - tags: - - payments - summary: "Shows an Payment for editting" - description: "Displays an Payment by id" - operationId: editPayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/payments/bulk: - post: - tags: - - payments - summary: "Performs bulk actions on an array of payments" - description: "" - operationId: bulkPayments - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "User credentials" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Payment response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/payments/{id}/{action}": - get: - tags: - - payments - summary: "Performs a custom action on an Payment" - description: "Performs a custom action on an Payment.\n\n The current range of actions are as follows\n - clone_to_Payment\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" - operationId: actionPayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - - name: action - in: path - description: "The action string to be performed" - required: true - schema: - type: string - format: string - example: clone_to_quote - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/payments/refund: - post: - tags: - - payments - summary: "Adds a Refund" - description: "Adds an Refund to the system" - operationId: storeRefund - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - requestBody: - description: "The refund request" - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - responses: - 200: - description: "Returns the saved Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/payments/{id}/upload": - put: - tags: - - payments - summary: "Uploads a document to a payment" - description: "Handles the uploading of a document to a payment" - operationId: uploadPayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" + /api/v1/payment_terms: get: tags: @@ -5313,1199 +4494,6 @@ paths: default: $ref: "#/components/responses/default" - /api/v1/projects: - get: - tags: - - projects - summary: "Gets a list of projects" - description: "Lists projects" - operationId: getProjects - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - $ref: "#/components/parameters/index" - responses: - 200: - description: "A list of projects" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - projects - summary: "Adds a project" - description: "Adds an project to a company" - operationId: storeProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/projects/{id}": - get: - tags: - - projects - summary: "Shows a project" - description: "Displays a project by id" - operationId: showProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the expense object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - projects - summary: "Updates a project" - description: "Handles the updating of a project by id" - operationId: updateProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - projects - summary: "Deletes a project" - description: "Handles the deletion of a project by id" - operationId: deleteProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/projects/{id}/edit": - get: - tags: - - projects - summary: "Shows a project for editting" - description: "Displays a project by id" - operationId: editProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/projects/create: - get: - tags: - - projects - summary: "Gets a new blank project object" - description: "Returns a blank object with default values" - operationId: getProjectsCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/projects/bulk: - post: - tags: - - projects - summary: "Performs bulk actions on an array of projects" - description: "" - operationId: bulkProjects - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "User credentials" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Project User response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/projects/{id}/upload": - put: - tags: - - projects - summary: "Uploads a document to a project" - description: "Handles the uploading of a document to a project" - operationId: uploadProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/purchase_orders: - get: - tags: - - purchase_orders - summary: "Gets a list of purchase orders" - description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" - operationId: getPurchaseOrders - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A list of purchase orders" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - purhcase_orders - summary: "Adds a purchase order" - description: "Adds an purchase order to the system" - operationId: storePurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/purchase_orders/create: - get: - tags: - - purchase_orders - summary: "Gets a new blank purchase order object" - description: "Returns a blank object with default values" - operationId: getPurchaseOrderCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_orders/{id}": - get: - tags: - - purchase_orders - summary: "Shows an purcase orders" - description: "Displays an purchase order by id" - operationId: showPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Purchase order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - purchase_orders - summary: "Deletes a purchase order" - description: "Handles the deletion of an purchase orders by id" - operationId: deletePurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The purhcase order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_orders/{id}/edit": - get: - tags: - - purchase_orders - summary: "Shows an purchase order for editting" - description: "Displays an purchase order by id" - operationId: editPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The purchase order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Invoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_order/{id}": - put: - tags: - - purchase_orders - summary: "Updates an purchase order" - description: "Handles the updating of an purchase order by id" - operationId: updatePurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The purchase order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/purchase_orders/bulk: - post: - tags: - - purchase_orders - summary: "Performs bulk actions on an array of purchase_orders" - description: "" - operationId: bulkPurchaseOrderss - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "Purchase Order IDS" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Bulk Action response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_orders/{id}/{action}": - get: - tags: - - purchase_orders - summary: "Performs a custom action on an purchase order" - description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" - operationId: actionPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Purchase Order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - - name: action - in: path - description: "The action string to be performed" - required: true - schema: - type: string - format: string - example: clone_to_quote - responses: - 200: - description: "Returns the invoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Invoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_orders/{id}/upload": - put: - tags: - - purchase_orders - summary: "Uploads a document to a purchase_orders" - description: "Handles the uploading of a document to a purchase_order" - operationId: uploadPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Purchase Order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Purchase Order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_order/{invitation_key}/download": - get: - tags: - - purchase_orders - summary: "Download a specific purchase order by invitation key" - description: "Downloads a specific purchase order" - operationId: downloadPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: invitation_key - in: path - description: "The Purchase Order Invitation Key" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Purchase Order pdf" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/quotes: - get: - tags: - - quotes - summary: "Gets a list of quotes" - description: "Lists quotes, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the quotes, these are handled by the QuoteFilters class which defines the methods available" - operationId: getQuotes - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A list of quotes" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - quotes - summary: "Adds a Quote" - description: "Adds an Quote to the system" - operationId: storeQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/quotes/create: - get: - tags: - - quotes - summary: "Gets a new blank Quote object" - description: "Returns a blank object with default values" - operationId: getQuotesCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quotes/{id}": - get: - tags: - - quotes - summary: "Shows an Quote" - description: "Displays an Quote by id" - operationId: showQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - quotes - summary: "Updates an Quote" - description: "Handles the updating of an Quote by id" - operationId: updateQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - quotes - summary: "Deletes a Quote" - description: "Handles the deletion of an Quote by id" - operationId: deleteQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quotes/{id}/edit": - get: - tags: - - quotes - summary: "Shows an Quote for editting" - description: "Displays an Quote by id" - operationId: editQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/quotes/bulk: - post: - tags: - - quotes - summary: "Performs bulk actions on an array of quotes" - description: "" - operationId: bulkQuotes - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "Hashed ids" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Quote response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quotes/{id}/{action}": - get: - tags: - - quotes - summary: "Performs a custom action on an Quote" - description: "Performs a custom action on an Quote.\n\n The current range of actions are as follows\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - convert\n - convert_to_invoice\n - email" - operationId: actionQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - - name: action - in: path - description: "The action string to be performed" - required: true - schema: - type: string - format: string - example: clone_to_quote - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quote/{invitation_key}/download": - get: - tags: - - quotes - summary: "Download a specific quote by invitation key" - description: "Downloads a specific quote" - operationId: downloadQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: invitation_key - in: path - description: "The Quote Invitation Key" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the quote pdf" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quotes/{id}/upload": - put: - tags: - - quotes - summary: "Uploads a document to a quote" - description: "Handles the uploading of a document to a quote" - operationId: uploadQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" /api/v1/recurring_expenses: get: tags: @@ -6848,433 +4836,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/recurring_invoices: - get: - tags: - - recurring_invoices - summary: "Gets a list of recurring_invoices" - description: "Lists recurring_invoices, 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 recurring_invoices, these are handled by the RecurringInvoiceFilters class which defines the methods available" - operationId: getRecurringInvoices - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A list of recurring_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/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - recurring_invoices - summary: "Adds a RecurringInvoice" - description: "Adds an RecurringInvoice to the system" - operationId: storeRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/recurring_invoices/create: - get: - tags: - - recurring_invoices - summary: "Gets a new blank RecurringInvoice object" - description: "Returns a blank object with default values" - operationId: getRecurringInvoicesCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/recurring_invoices/{id}": - get: - tags: - - recurring_invoices - summary: "Shows an RecurringInvoice" - description: "Displays an RecurringInvoice by id" - operationId: showRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - recurring_invoices - summary: "Updates an RecurringInvoice" - description: "Handles the updating of an RecurringInvoice by id" - operationId: updateRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - recurring_invoices - summary: "Deletes a RecurringInvoice" - description: "Handles the deletion of an RecurringInvoice by id" - operationId: deleteRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice 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/recurring_invoices/{id}/edit": - get: - tags: - - recurring_invoices - summary: "Shows an RecurringInvoice for editting" - description: "Displays an RecurringInvoice by id" - operationId: editRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/recurring_invoice/{invitation_key}/download": - get: - tags: - - recurring_invoices - summary: "Download a specific invoice by invitation key" - description: "Downloads a specific invoice" - operationId: downloadRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: invitation_key - in: path - description: "The Recurring Invoice Invitation Key" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the recurring invoice pdf" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/recurring_invoices/bulk: - post: - tags: - - recurring_invoices - summary: "Performs bulk actions on an array of recurring_invoices" - description: "" - operationId: bulkRecurringInvoices - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "Hashed IDs" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The RecurringInvoice response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/recurring_invoices/{id}/{action}": - get: - tags: - - recurring_invoices - summary: "Performs a custom action on an RecurringInvoice" - description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" - operationId: actionRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice 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 RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/recurring_invoices/{id}/upload": - put: - tags: - - recurring_invoices - summary: "Uploads a document to a recurring_invoice" - description: "Handles the uploading of a document to a recurring_invoice" - operationId: uploadRecurringInvoice - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The RecurringInvoice Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" + /api/v1/recurring_quotes: get: tags: @@ -8586,377 +6148,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/tasks: - get: - tags: - - tasks - summary: "Gets a list of tasks" - description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" - operationId: getTasks - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - $ref: "#/components/parameters/index" - responses: - 200: - description: "A list of tasks" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - tasks - summary: "Adds a client" - description: "Adds an client to a company" - operationId: storeTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/tasks/{id}": - get: - tags: - - tasks - summary: "Shows a client" - description: "Displays a client by id" - operationId: showTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the task object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - tasks - summary: "Updates a client" - description: "Handles the updating of a client by id" - operationId: updateTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - tasks - summary: "Deletes a client" - description: "Handles the deletion of a client by id" - operationId: deleteTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/tasks/{id}/edit": - get: - tags: - - tasks - summary: "Shows a client for editting" - description: "Displays a client by id" - operationId: editTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/tasks/create: - get: - tags: - - tasks - summary: "Gets a new blank client object" - description: "Returns a blank object with default values" - operationId: getTasksCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/tasks/bulk: - post: - tags: - - tasks - summary: "Performs bulk actions on an array of tasks" - description: "" - operationId: bulkTasks - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "User credentials" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Task User response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/tasks/{id}/upload": - put: - tags: - - tasks - summary: "Uploads a document to a task" - description: "Handles the uploading of a document to a task" - operationId: uploadTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Task object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/tasks/stort: - post: - tags: - - tasks - summary: "Sort tasks on KanBan" - description: "Sorts tasks after drag and drop on the KanBan." - operationId: sortTasks - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns an Ok, 200 HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" + /api/v1/task_schedulers/: get: tags: @@ -10520,348 +7712,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/vendors: - get: - tags: - - vendors - summary: "Gets a list of vendors" - description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" - operationId: getVendors - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - $ref: "#/components/parameters/index" - responses: - 200: - description: "A list of vendors" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - vendors - summary: "Adds a client" - description: "Adds an client to a company" - operationId: storeVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/vendors/{id}": - get: - tags: - - vendors - summary: "Shows a client" - description: "Displays a client by id" - operationId: showVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the vendor object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - vendors - summary: "Updates a client" - description: "Handles the updating of a client by id" - operationId: updateVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - vendors - summary: "Deletes a client" - description: "Handles the deletion of a client by id" - operationId: deleteVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/vendors/{id}/edit": - get: - tags: - - vendors - summary: "Shows a client for editting" - description: "Displays a client by id" - operationId: editVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/vendors/create: - get: - tags: - - vendors - summary: "Gets a new blank client object" - description: "Returns a blank object with default values" - operationId: getVendorsCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/vendors/bulk: - post: - tags: - - vendors - summary: "Performs bulk actions on an array of vendors" - description: "" - operationId: bulkVendors - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "User credentials" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Vendor User response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/vendors/{id}/upload": - put: - tags: - - vendors - summary: "Uploads a document to a vendor" - description: "Handles the uploading of a document to a vendor" - operationId: uploadVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Vendor object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" + /api/v1/webcron: get: tags: @@ -11191,6 +8042,348 @@ paths: default: $ref: "#/components/responses/default" + /api/v1/projects: + get: + tags: + - projects + summary: "List projects" + description: "Lists projects" + operationId: getProjects + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + responses: + 200: + description: "A list of projects" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - projects + summary: "Create project" + description: "Adds an project to a company" + operationId: storeProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/projects/{id}": + get: + tags: + - projects + summary: "Show project" + description: "Displays a project by id" + operationId: showProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the expense object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - projects + summary: "Update project" + description: "Handles the updating of a project by id" + operationId: updateProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - projects + summary: "Delete project" + description: "Handles the deletion of a project by id" + operationId: deleteProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/projects/{id}/edit": + get: + tags: + - projects + summary: "Edit project" + description: "Displays a project by id" + operationId: editProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/projects/create: + get: + tags: + - projects + summary: "Blank project" + description: "Returns a blank object with default values" + operationId: getProjectsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/projects/bulk: + post: + tags: + - projects + summary: "Bulk project actions" + description: "" + operationId: bulkProjects + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "User credentials" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Project User response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/projects/{id}/upload": + put: + tags: + - projects + summary: "Uploads a project document" + description: "Handles the uploading of a document to a project" + operationId: uploadProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" /api/v1/clients: get: tags: @@ -11750,6 +8943,483 @@ paths: $ref: '#/components/responses/422' default: $ref: '#/components/responses/default' + /api/v1/quotes: + get: + tags: + - quotes + summary: "List quotes" + description: "Lists quotes, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the quotes, these are handled by the QuoteFilters class which defines the methods available" + operationId: getQuotes + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/status" + - $ref: "#/components/parameters/client_id" + - $ref: "#/components/parameters/created_at" + - $ref: "#/components/parameters/updated_at" + - $ref: "#/components/parameters/is_deleted" + - $ref: "#/components/parameters/filter_deleted_clients" + - $ref: "#/components/parameters/vendor_id" + - name: filter + in: query + description: | + Searches across a range of columns including: + - number + - custom_value1 + - custom_value2 + - custom_value3 + - custom_value4 + required: false + schema: + type: string + example: ?filter=bob + - name: client_status + in: query + description: | + A comma separated list of quote status strings. Valid options include: + - all + - draft + - sent + - approved + - expired + - upcoming + required: false + schema: + type: string + example: ?client_status=paid,unpaid + - name: number + in: query + description: | + Search quote by quote number + required: false + schema: + type: string + example: ?number=Q-001 + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc number|desc balance|asc + responses: + 200: + description: "A list of quotes" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - quotes + summary: "Create quote" + description: "Adds an Quote to the system" + operationId: storeQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quotes/{id}": + get: + tags: + - quotes + summary: "Show quote" + description: "Displays an Quote by id" + operationId: showQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - quotes + summary: "Update quote" + description: "Handles the updating of an Quote by id" + operationId: updateQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - quotes + summary: "Delete quote" + description: "Handles the deletion of an Quote by id" + operationId: deleteQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quotes/{id}/edit": + get: + tags: + - quotes + summary: "Edit quote" + description: "Displays an Quote by id" + operationId: editQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/quotes/create: + get: + tags: + - quotes + summary: "Blank quote" + description: "Returns a blank object with default values" + operationId: getQuotesCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/quotes/bulk: + post: + tags: + - quotes + summary: "Bulk quote actions" + description: "" + operationId: bulkQuotes + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "Hashed ids" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Quote response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quotes/{id}/{action}": + get: + deprecated: true + tags: + - quotes + summary: "Performs a custom action on an Quote" + description: "Performs a custom action on an Quote.\n\n The current range of actions are as follows\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - convert\n - convert_to_invoice\n - email" + operationId: actionQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + - name: action + in: path + description: "The action string to be performed" + required: true + schema: + type: string + format: string + example: clone_to_quote + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quote/{invitation_key}/download": + get: + tags: + - quotes + summary: "Download quote PDF" + description: "Downloads a specific quote" + operationId: downloadQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key + in: path + description: "The Quote Invitation Key" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the quote pdf" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quotes/{id}/upload": + put: + tags: + - quotes + summary: "Upload a quote document" + description: "Handles the uploading of a document to a quote" + operationId: uploadQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" /api/v1/products: get: tags: @@ -12138,6 +9808,1622 @@ paths: default: $ref: '#/components/responses/default' + /api/v1/tasks: + get: + tags: + - tasks + summary: "List tasks" + description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" + operationId: getTasks + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + responses: + 200: + description: "A list of tasks" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - tasks + summary: "Create task" + description: "Adds an task to a company" + operationId: storeTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/tasks/{id}": + get: + tags: + - tasks + summary: "Show task" + description: "Displays a task by id" + operationId: showTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - tasks + summary: "Update task" + description: "Handles the updating of a task by id" + operationId: updateTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - tasks + summary: "Delete task" + description: "Handles the deletion of a task by id" + operationId: deleteTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/tasks/{id}/edit": + get: + tags: + - tasks + summary: "Edit task" + description: "Displays a task by id" + operationId: editTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the client object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/tasks/create: + get: + tags: + - tasks + summary: "Blank task" + description: "Returns a blank task with default values" + operationId: getTasksCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/tasks/bulk: + post: + tags: + - tasks + summary: "Bulk task actions" + description: "" + operationId: bulkTasks + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "User credentials" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Task User response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/tasks/{id}/upload": + put: + tags: + - tasks + summary: "Uploads a task document" + description: "Handles the uploading of a document to a task" + operationId: uploadTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/tasks/sort: + post: + tags: + - tasks + summary: "Sort tasks on KanBan" + description: "Sorts tasks after drag and drop on the KanBan." + operationId: sortTasks + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns an Ok, 200 HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/purchase_orders: + get: + tags: + - purchase_orders + summary: "List purchase orders" + description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" + operationId: getPurchaseOrders + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A list of purchase orders" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - purhcase_orders + summary: "Create purchase order" + description: "Adds an purchase order to the system" + operationId: storePurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + "/api/v1/purchase_orders/{id}": + get: + tags: + - purchase_orders + summary: "Show purcase order" + description: "Displays an purchase order by id" + operationId: showPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Purchase order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_order/{id}": + put: + tags: + - purchase_orders + summary: "Update purchase order" + description: "Handles the updating of an purchase order by id" + operationId: updatePurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The purchase order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - purchase_orders + summary: "Delete purchase order" + description: "Handles the deletion of an purchase orders by id" + operationId: deletePurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The purhcase order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_orders/{id}/edit": + get: + tags: + - purchase_orders + summary: "Edit purchase order" + description: "Displays an purchase order by id" + operationId: editPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The purchase order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + /api/v1/purchase_orders/create: + get: + tags: + - purchase_orders + summary: "Blank purchase order" + description: "Returns a blank object with default values" + operationId: getPurchaseOrderCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/purchase_orders/bulk: + post: + tags: + - purchase_orders + summary: "Bulk purchase order action" + description: "" + operationId: bulkPurchaseOrderss + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "Purchase Order IDS" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Bulk Action response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_orders/{id}/{action}": + get: + deprecated: true + tags: + - purchase_orders + summary: "Custom purchase order actions" + description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" + operationId: actionPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Purchase Order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + - name: action + in: path + description: "The action string to be performed" + required: true + schema: + type: string + format: string + example: clone_to_quote + responses: + 200: + description: "Returns the invoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_orders/{id}/upload": + put: + tags: + - purchase_orders + summary: "Uploads a purchase order document" + description: "Handles the uploading of a document to a purchase_order" + operationId: uploadPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Purchase Order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Purchase Order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_order/{invitation_key}/download": + get: + tags: + - purchase_orders + summary: "Download a purchase order PDF" + description: "Downloads a specific purchase order" + operationId: downloadPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key + in: path + description: "The Purchase Order Invitation Key" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Purchase Order pdf" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/payments: + get: + tags: + - payments + summary: "List payments" + description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" + operationId: getPayments + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/status" + - $ref: "#/components/parameters/client_id" + - $ref: "#/components/parameters/created_at" + - $ref: "#/components/parameters/updated_at" + - $ref: "#/components/parameters/is_deleted" + - $ref: "#/components/parameters/filter_deleted_clients" + - $ref: "#/components/parameters/vendor_id" + - name: filter + in: query + description: | + Searches across a range of columns including: + - amount + - date + - custom_value1 + - custom_value2 + - custom_value3 + - custom_value4 + required: false + schema: + type: string + example: ?filter=10 + - name: number + in: query + description: | + Search payments by payment number + required: false + schema: + type: string + example: ?number=0001 + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc number|desc balance|asc + responses: + 200: + description: "A list of payments" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - payments + summary: "Create payment" + description: "Adds an Payment to the system" + operationId: storePayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + requestBody: + description: "The payment request" + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + responses: + 200: + description: "Returns the saved Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + "/api/v1/payments/{id}": + get: + tags: + - payments + summary: "Show payment" + description: "Displays an Payment by id" + operationId: showPayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - payments + summary: "Update payment" + description: "Handles the updating of an Payment by id" + operationId: updatePayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - payments + summary: "Delete payment" + description: "Handles the deletion of an Payment by id" + operationId: deletePayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/payments/{id}/edit": + get: + tags: + - payments + summary: "Edit payment" + description: "Displays an Payment by id" + operationId: editPayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/payments/create: + get: + tags: + - payments + summary: "Blank payment" + description: "Returns a blank object with default values" + operationId: getPaymentsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/payments/refund: + post: + tags: + - payments + summary: "Refund payment" + description: "Adds an Refund to the system" + operationId: storeRefund + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + requestBody: + description: "The refund request" + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + responses: + 200: + description: "Returns the saved Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/payments/bulk: + post: + tags: + - payments + summary: "Bulk payment actions" + description: "" + operationId: bulkPayments + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "User credentials" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Payment response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/payments/{id}/{action}": + get: + deprecated: true + tags: + - payments + summary: "Custom payment actions" + description: "Performs a custom action on an Payment.\n\n The current range of actions are as follows\n - clone_to_Payment\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" + operationId: actionPayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + - name: action + in: path + description: "The action string to be performed" + required: true + schema: + type: string + format: string + example: clone_to_quote + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + "/api/v1/payments/{id}/upload": + put: + tags: + - payments + summary: "Upload a payment document" + description: "Handles the uploading of a document to a payment" + operationId: uploadPayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/vendors: + get: + tags: + - vendors + summary: "List vendors" + description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" + operationId: getVendors + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + responses: + 200: + description: "A list of vendors" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - vendors + summary: "Create vendor" + description: "Adds a vendor to a company" + operationId: storeVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved clivendorent object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/vendors/{id}": + get: + tags: + - vendors + summary: "Show vendor" + description: "Displays a vendor by id" + operationId: showVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - vendors + summary: "Update vendor" + description: "Handles the updating of a vendor by id" + operationId: updateVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - vendors + summary: "Delete vendor" + description: "Handles the deletion of a vendor by id" + operationId: deleteVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/vendors/{id}/edit": + get: + tags: + - vendors + summary: "Edit vendor" + description: "Displays a vendor by id" + operationId: editVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/vendors/create: + get: + tags: + - vendors + summary: "Blank vendor" + description: "Returns a blank vendor with default values" + operationId: getVendorsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/vendors/bulk: + post: + tags: + - vendors + summary: "Bulk vendor actions" + description: "" + operationId: bulkVendors + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "User credentials" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Vendor User response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/vendors/{id}/upload": + put: + tags: + - vendors + summary: "Uploads a vendor document" + description: "Handles the uploading of a document to a vendor" + operationId: uploadVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" /api/v1/invoices: get: tags: @@ -12748,6 +12034,859 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" + /api/v1/recurring_invoices: + get: + tags: + - recurring_invoices + summary: "List recurring invoices" + description: | + Lists invoices with the option to chain multiple query parameters allowing fine grained filtering of the list. + + operationId: getRecurringInvoices + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/client_id" + - $ref: "#/components/parameters/created_at" + - $ref: "#/components/parameters/updated_at" + - $ref: "#/components/parameters/is_deleted" + - $ref: "#/components/parameters/filter_deleted_clients" + - $ref: "#/components/parameters/vendor_id" + - name: filter + in: query + description: | + Searches across a range of columns including: + - custom_value1 + - custom_value2 + - custom_value3 + - custom_value4 + required: false + schema: + type: string + example: ?filter=bob + - name: client_status + in: query + description: | + A comma separated list of invoice status strings. Valid options include: + - all + - active + - paused + - completed + required: false + schema: + type: string + example: ?client_status=active,paused + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc number|desc balance|asc + responses: + 200: + description: "A list of recurring_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/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - recurring_invoices + summary: "Create recurring invoice" + description: "Adds a Recurring Invoice to the system" + operationId: storeRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + "/api/v1/recurring_invoices/{id}": + get: + tags: + - recurring_invoices + summary: "Show recurring invoice" + description: "Displays an RecurringInvoice by id" + operationId: showRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - recurring_invoices + summary: "Update recurring invoice" + description: "Handles the updating of an RecurringInvoice by id" + operationId: updateRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - recurring_invoices + summary: "Delete recurring invoice" + description: "Handles the deletion of an RecurringInvoice by id" + operationId: deleteRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice 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/recurring_invoices/{id}/edit": + get: + tags: + - recurring_invoices + summary: "Edit recurring invoice" + description: "Displays an RecurringInvoice by id" + operationId: editRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + /api/v1/recurring_invoices/create: + get: + tags: + - recurring_invoices + summary: "Blank recurring invoice" + description: "Returns a blank object with default values" + operationId: getRecurringInvoicesCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/recurring_invoices/bulk: + post: + tags: + - recurring_invoices + summary: "Bulk recurring invoice actions" + description: "" + operationId: bulkRecurringInvoices + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "Hashed IDs" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The RecurringInvoice response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/recurring_invoices/{id}/{action}": + get: + deprecated: true + tags: + - recurring_invoices + summary: "Custom recurring invoice action" + description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" + operationId: actionRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice 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 RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/recurring_invoice/{invitation_key}/download": + get: + tags: + - recurring_invoices + summary: "Download recurring invoice PDF" + description: "Downloads a specific invoice" + operationId: downloadRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key + in: path + description: "The Recurring Invoice Invitation Key" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the recurring invoice pdf" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/recurring_invoices/{id}/upload": + put: + tags: + - recurring_invoices + summary: "Add recurring invoice document" + description: "Handles the uploading of a document to a recurring_invoice" + operationId: uploadRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The RecurringInvoice Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the RecurringInvoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/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" components: headers: X-MINIMUM-CLIENT-VERSION: @@ -17140,6 +17279,42 @@ tags: - name: invoices description: | Endpoint definitions for interacting with invoices. + - name: recurring_invoices + description: | + Endpoint definitions for interacting with recurring_invoices. + - name: payments + description: | + Endpoint definitions for interacting with payments. + - name: quotes + description: | + Endpoint definitions for interacting with quotes. + - name: credits + description: | + Endpoint definitions for interacting with credits. + - name: projects + description: | + Endpoint definitions for interacting with projects. + - name: tasks + description: | + Endpoint definitions for interacting with tasks. + - name: vendors + description: | + Endpoint definitions for interacting with vendors. + - name: purchase_orders + description: | + Endpoint definitions for interacting with purchase orders. + - name: expenses + description: | + Endpoint definitions for interacting with expenses. + - name: recurring_expenses + description: | + Endpoint definitions for interacting with recurring_expenses. + - name: bank_transactions + description: | + Endpoint definitions for interacting with bank transactions. + - name: reports + description: | + Endpoint definitions for interacting with reports. externalDocs: description: "https://invoiceninja.github.io" url: "https://invoiceninja.github.io" diff --git a/openapi/misc/misc.yaml b/openapi/misc/misc.yaml index 767c9aab32ce..9fdee4bf4f8d 100644 --- a/openapi/misc/misc.yaml +++ b/openapi/misc/misc.yaml @@ -17,6 +17,39 @@ tags: - name: recurring_invoices description: | Endpoint definitions for interacting with recurring_invoices. + - name: payments + description: | + Endpoint definitions for interacting with payments. + - name: quotes + description: | + Endpoint definitions for interacting with quotes. + - name: credits + description: | + Endpoint definitions for interacting with credits. + - name: projects + description: | + Endpoint definitions for interacting with projects. + - name: tasks + description: | + Endpoint definitions for interacting with tasks. + - name: vendors + description: | + Endpoint definitions for interacting with vendors. + - name: purchase_orders + description: | + Endpoint definitions for interacting with purchase orders. + - name: expenses + description: | + Endpoint definitions for interacting with expenses. + - name: recurring_expenses + description: | + Endpoint definitions for interacting with recurring_expenses. + - name: bank_transactions + description: | + Endpoint definitions for interacting with bank transactions. + - name: reports + description: | + Endpoint definitions for interacting with reports. externalDocs: description: "https://invoiceninja.github.io" url: "https://invoiceninja.github.io" diff --git a/openapi/paths.yaml b/openapi/paths.yaml index 1e2e3ef52e15..e4ec6e8af5e5 100644 --- a/openapi/paths.yaml +++ b/openapi/paths.yaml @@ -2307,390 +2307,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/credits: - get: - tags: - - credits - summary: "Gets a list of 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: "Adds a 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/create: - get: - tags: - - credits - summary: "Gets a new blank credit object" - 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/{id}": - get: - tags: - - credits - summary: "Shows an 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: "Updates an 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: "Deletes a 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: "Shows an credit for editting" - 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/bulk: - post: - tags: - - credits - summary: "Performs bulk actions on an array of credits" - 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 a specific credit by invitation key" - 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: "Uploads a document to a credit" - 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" + /api/v1/designs: get: tags: @@ -4418,443 +4035,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/payments: - get: - tags: - - payments - summary: "Gets a list of payments" - description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" - operationId: getPayments - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A list of payments" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - payments - summary: "Adds a Payment" - description: "Adds an Payment to the system" - operationId: storePayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - requestBody: - description: "The payment request" - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - responses: - 200: - description: "Returns the saved Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/payments/create: - get: - tags: - - payments - summary: "Gets a new blank Payment object" - description: "Returns a blank object with default values" - operationId: getPaymentsCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/payments/{id}": - get: - tags: - - payments - summary: "Shows an Payment" - description: "Displays an Payment by id" - operationId: showPayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - payments - summary: "Updates an Payment" - description: "Handles the updating of an Payment by id" - operationId: updatePayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - payments - summary: "Deletes a Payment" - description: "Handles the deletion of an Payment by id" - operationId: deletePayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/payments/{id}/edit": - get: - tags: - - payments - summary: "Shows an Payment for editting" - description: "Displays an Payment by id" - operationId: editPayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/payments/bulk: - post: - tags: - - payments - summary: "Performs bulk actions on an array of payments" - description: "" - operationId: bulkPayments - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "User credentials" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Payment response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/payments/{id}/{action}": - get: - tags: - - payments - summary: "Performs a custom action on an Payment" - description: "Performs a custom action on an Payment.\n\n The current range of actions are as follows\n - clone_to_Payment\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" - operationId: actionPayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - - name: action - in: path - description: "The action string to be performed" - required: true - schema: - type: string - format: string - example: clone_to_quote - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/payments/refund: - post: - tags: - - payments - summary: "Adds a Refund" - description: "Adds an Refund to the system" - operationId: storeRefund - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - requestBody: - description: "The refund request" - required: true - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - responses: - 200: - description: "Returns the saved Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/payments/{id}/upload": - put: - tags: - - payments - summary: "Uploads a document to a payment" - description: "Handles the uploading of a document to a payment" - operationId: uploadPayment - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Payment Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Payment object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Payment" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" + /api/v1/payment_terms: get: tags: @@ -5289,1199 +4470,6 @@ paths: default: $ref: "#/components/responses/default" - /api/v1/projects: - get: - tags: - - projects - summary: "Gets a list of projects" - description: "Lists projects" - operationId: getProjects - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - $ref: "#/components/parameters/index" - responses: - 200: - description: "A list of projects" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - projects - summary: "Adds a project" - description: "Adds an project to a company" - operationId: storeProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/projects/{id}": - get: - tags: - - projects - summary: "Shows a project" - description: "Displays a project by id" - operationId: showProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the expense object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - projects - summary: "Updates a project" - description: "Handles the updating of a project by id" - operationId: updateProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - projects - summary: "Deletes a project" - description: "Handles the deletion of a project by id" - operationId: deleteProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/projects/{id}/edit": - get: - tags: - - projects - summary: "Shows a project for editting" - description: "Displays a project by id" - operationId: editProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/projects/create: - get: - tags: - - projects - summary: "Gets a new blank project object" - description: "Returns a blank object with default values" - operationId: getProjectsCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/projects/bulk: - post: - tags: - - projects - summary: "Performs bulk actions on an array of projects" - description: "" - operationId: bulkProjects - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "User credentials" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Project User response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/projects/{id}/upload": - put: - tags: - - projects - summary: "Uploads a document to a project" - description: "Handles the uploading of a document to a project" - operationId: uploadProject - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Project Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Project object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Project" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/purchase_orders: - get: - tags: - - purchase_orders - summary: "Gets a list of purchase orders" - description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" - operationId: getPurchaseOrders - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A list of purchase orders" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - purhcase_orders - summary: "Adds a purchase order" - description: "Adds an purchase order to the system" - operationId: storePurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/purchase_orders/create: - get: - tags: - - purchase_orders - summary: "Gets a new blank purchase order object" - description: "Returns a blank object with default values" - operationId: getPurchaseOrderCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_orders/{id}": - get: - tags: - - purchase_orders - summary: "Shows an purcase orders" - description: "Displays an purchase order by id" - operationId: showPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Purchase order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - purchase_orders - summary: "Deletes a purchase order" - description: "Handles the deletion of an purchase orders by id" - operationId: deletePurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The purhcase order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_orders/{id}/edit": - get: - tags: - - purchase_orders - summary: "Shows an purchase order for editting" - description: "Displays an purchase order by id" - operationId: editPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The purchase order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Invoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_order/{id}": - put: - tags: - - purchase_orders - summary: "Updates an purchase order" - description: "Handles the updating of an purchase order by id" - operationId: updatePurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The purchase order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the purchase order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Credit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/purchase_orders/bulk: - post: - tags: - - purchase_orders - summary: "Performs bulk actions on an array of purchase_orders" - description: "" - operationId: bulkPurchaseOrderss - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "Purchase Order IDS" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Bulk Action response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_orders/{id}/{action}": - get: - tags: - - purchase_orders - summary: "Performs a custom action on an purchase order" - description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" - operationId: actionPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Purchase Order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - - name: action - in: path - description: "The action string to be performed" - required: true - schema: - type: string - format: string - example: clone_to_quote - responses: - 200: - description: "Returns the invoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Invoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_orders/{id}/upload": - put: - tags: - - purchase_orders - summary: "Uploads a document to a purchase_orders" - description: "Handles the uploading of a document to a purchase_order" - operationId: uploadPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Purchase Order Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Purchase Order object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/purchase_order/{invitation_key}/download": - get: - tags: - - purchase_orders - summary: "Download a specific purchase order by invitation key" - description: "Downloads a specific purchase order" - operationId: downloadPurchaseOrder - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: invitation_key - in: path - description: "The Purchase Order Invitation Key" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Purchase Order pdf" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/quotes: - get: - tags: - - quotes - summary: "Gets a list of quotes" - description: "Lists quotes, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the quotes, these are handled by the QuoteFilters class which defines the methods available" - operationId: getQuotes - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A list of quotes" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - quotes - summary: "Adds a Quote" - description: "Adds an Quote to the system" - operationId: storeQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/quotes/create: - get: - tags: - - quotes - summary: "Gets a new blank Quote object" - description: "Returns a blank object with default values" - operationId: getQuotesCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quotes/{id}": - get: - tags: - - quotes - summary: "Shows an Quote" - description: "Displays an Quote by id" - operationId: showQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - quotes - summary: "Updates an Quote" - description: "Handles the updating of an Quote by id" - operationId: updateQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - quotes - summary: "Deletes a Quote" - description: "Handles the deletion of an Quote by id" - operationId: deleteQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quotes/{id}/edit": - get: - tags: - - quotes - summary: "Shows an Quote for editting" - description: "Displays an Quote by id" - operationId: editQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/quotes/bulk: - post: - tags: - - quotes - summary: "Performs bulk actions on an array of quotes" - description: "" - operationId: bulkQuotes - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "Hashed ids" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Quote response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quotes/{id}/{action}": - get: - tags: - - quotes - summary: "Performs a custom action on an Quote" - description: "Performs a custom action on an Quote.\n\n The current range of actions are as follows\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - convert\n - convert_to_invoice\n - email" - operationId: actionQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - - name: action - in: path - description: "The action string to be performed" - required: true - schema: - type: string - format: string - example: clone_to_quote - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quote/{invitation_key}/download": - get: - tags: - - quotes - summary: "Download a specific quote by invitation key" - description: "Downloads a specific quote" - operationId: downloadQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: invitation_key - in: path - description: "The Quote Invitation Key" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the quote pdf" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/quotes/{id}/upload": - put: - tags: - - quotes - summary: "Uploads a document to a quote" - description: "Handles the uploading of a document to a quote" - operationId: uploadQuote - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Quote Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Quote object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Quote" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" /api/v1/recurring_expenses: get: tags: @@ -8136,377 +6124,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/tasks: - get: - tags: - - tasks - summary: "Gets a list of tasks" - description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" - operationId: getTasks - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - $ref: "#/components/parameters/index" - responses: - 200: - description: "A list of tasks" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - tasks - summary: "Adds a client" - description: "Adds an client to a company" - operationId: storeTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/tasks/{id}": - get: - tags: - - tasks - summary: "Shows a client" - description: "Displays a client by id" - operationId: showTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the task object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - tasks - summary: "Updates a client" - description: "Handles the updating of a client by id" - operationId: updateTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - tasks - summary: "Deletes a client" - description: "Handles the deletion of a client by id" - operationId: deleteTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/tasks/{id}/edit": - get: - tags: - - tasks - summary: "Shows a client for editting" - description: "Displays a client by id" - operationId: editTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/tasks/create: - get: - tags: - - tasks - summary: "Gets a new blank client object" - description: "Returns a blank object with default values" - operationId: getTasksCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/tasks/bulk: - post: - tags: - - tasks - summary: "Performs bulk actions on an array of tasks" - description: "" - operationId: bulkTasks - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "User credentials" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Task User response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/tasks/{id}/upload": - put: - tags: - - tasks - summary: "Uploads a document to a task" - description: "Handles the uploading of a document to a task" - operationId: uploadTask - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Task Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Task object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Task" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/tasks/stort: - post: - tags: - - tasks - summary: "Sort tasks on KanBan" - description: "Sorts tasks after drag and drop on the KanBan." - operationId: sortTasks - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns an Ok, 200 HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" + /api/v1/task_schedulers/: get: tags: @@ -10070,348 +7688,7 @@ paths: $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/vendors: - get: - tags: - - vendors - summary: "Gets a list of vendors" - description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" - operationId: getVendors - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - $ref: "#/components/parameters/index" - responses: - 200: - description: "A list of vendors" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - post: - tags: - - vendors - summary: "Adds a client" - description: "Adds an client to a company" - operationId: storeVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "Returns the saved client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/vendors/{id}": - get: - tags: - - vendors - summary: "Shows a client" - description: "Displays a client by id" - operationId: showVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the vendor object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - put: - tags: - - vendors - summary: "Updates a client" - description: "Handles the updating of a client by id" - operationId: updateVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - delete: - tags: - - vendors - summary: "Deletes a client" - description: "Handles the deletion of a client by id" - operationId: deleteVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns a HTTP status" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/vendors/{id}/edit": - get: - tags: - - vendors - summary: "Shows a client for editting" - description: "Displays a client by id" - operationId: editVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/vendors/create: - get: - tags: - - vendors - summary: "Gets a new blank client object" - description: "Returns a blank object with default values" - operationId: getVendorsCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank client object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - /api/v1/vendors/bulk: - post: - tags: - - vendors - summary: "Performs bulk actions on an array of vendors" - description: "" - operationId: bulkVendors - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/index" - requestBody: - description: "User credentials" - required: true - content: - application/json: - schema: - type: array - items: - description: "Array of hashed IDs to be bulk 'actioned" - type: integer - example: "[0,1,2,3]" - responses: - 200: - description: "The Vendor User response" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" - "/api/v1/vendors/{id}/upload": - put: - tags: - - vendors - summary: "Uploads a document to a vendor" - description: "Handles the uploading of a document to a vendor" - operationId: uploadVendor - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - - name: id - in: path - description: "The Vendor Hashed ID" - required: true - schema: - type: string - format: string - example: D2J234DFA - responses: - 200: - description: "Returns the Vendor object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/Vendor" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" + /api/v1/webcron: get: tags: diff --git a/openapi/paths/credits.yaml b/openapi/paths/credits.yaml new file mode 100644 index 000000000000..b95ae5e13523 --- /dev/null +++ b/openapi/paths/credits.yaml @@ -0,0 +1,384 @@ + /api/v1/credits: + get: + tags: + - credits + summary: "List credits" + description: "Lists credits, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the credits, these are handled by the CreditFilters class which defines the methods available" + operationId: getCredits + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A list of credits" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - credits + summary: "Create credit" + description: "Adds an credit to the system" + operationId: storeCredit + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved credit object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + "/api/v1/credits/{id}": + get: + tags: + - credits + summary: "Show credit" + description: "Displays an credit by id" + operationId: showCredit + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Credit Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the credit object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - Credits + summary: "Update credit" + description: "Handles the updating of an Credit by id" + operationId: updateCredit + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Credit Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Credit object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - credits + summary: "Delete credit" + description: "Handles the deletion of an credit by id" + operationId: deleteCredit + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Credit Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/credits/{id}/edit": + get: + tags: + - credits + summary: "Edit credit" + description: "Displays an credit by id" + operationId: editCredit + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Invoice Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the credit object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/credits/create: + get: + tags: + - credits + summary: "Blank credit" + description: "Returns a blank object with default values" + operationId: getCreditsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank credit object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/credits/bulk: + post: + tags: + - credits + summary: "Bulk credit actions" + description: "" + operationId: bulkCredits + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "User credentials" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Bulk Action response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/credit/{invitation_key}/download": + get: + tags: + - quotes + summary: "Download quote PDF" + description: "Downloads a specific quote" + operationId: downloadCredit + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key + in: path + description: "The Credit Invitation Key" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the credit pdf" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/credits/{id}/upload": + put: + tags: + - credits + summary: "Upload a credit document" + description: "Handles the uploading of a document to a credit" + operationId: uploadCredits + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Credit Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Credit object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" \ No newline at end of file diff --git a/openapi/paths/payments.yaml b/openapi/paths/payments.yaml new file mode 100644 index 000000000000..a72b9720ef94 --- /dev/null +++ b/openapi/paths/payments.yaml @@ -0,0 +1,476 @@ + /api/v1/payments: + get: + tags: + - payments + summary: "List payments" + description: "Lists payments, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the payments, these are handled by the PaymentFilters class which defines the methods available" + operationId: getPayments + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/status" + - $ref: "#/components/parameters/client_id" + - $ref: "#/components/parameters/created_at" + - $ref: "#/components/parameters/updated_at" + - $ref: "#/components/parameters/is_deleted" + - $ref: "#/components/parameters/filter_deleted_clients" + - $ref: "#/components/parameters/vendor_id" + - name: filter + in: query + description: | + Searches across a range of columns including: + - amount + - date + - custom_value1 + - custom_value2 + - custom_value3 + - custom_value4 + required: false + schema: + type: string + example: ?filter=10 + - name: number + in: query + description: | + Search payments by payment number + required: false + schema: + type: string + example: ?number=0001 + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc number|desc balance|asc + responses: + 200: + description: "A list of payments" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - payments + summary: "Create payment" + description: "Adds an Payment to the system" + operationId: storePayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + requestBody: + description: "The payment request" + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + responses: + 200: + description: "Returns the saved Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + "/api/v1/payments/{id}": + get: + tags: + - payments + summary: "Show payment" + description: "Displays an Payment by id" + operationId: showPayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - payments + summary: "Update payment" + description: "Handles the updating of an Payment by id" + operationId: updatePayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - payments + summary: "Delete payment" + description: "Handles the deletion of an Payment by id" + operationId: deletePayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/payments/{id}/edit": + get: + tags: + - payments + summary: "Edit payment" + description: "Displays an Payment by id" + operationId: editPayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/payments/create: + get: + tags: + - payments + summary: "Blank payment" + description: "Returns a blank object with default values" + operationId: getPaymentsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/payments/refund: + post: + tags: + - payments + summary: "Refund payment" + description: "Adds an Refund to the system" + operationId: storeRefund + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + requestBody: + description: "The refund request" + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + responses: + 200: + description: "Returns the saved Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/payments/bulk: + post: + tags: + - payments + summary: "Bulk payment actions" + description: "" + operationId: bulkPayments + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "User credentials" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Payment response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/payments/{id}/{action}": + get: + deprecated: true + tags: + - payments + summary: "Custom payment actions" + description: "Performs a custom action on an Payment.\n\n The current range of actions are as follows\n - clone_to_Payment\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" + operationId: actionPayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + - name: action + in: path + description: "The action string to be performed" + required: true + schema: + type: string + format: string + example: clone_to_quote + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + "/api/v1/payments/{id}/upload": + put: + tags: + - payments + summary: "Upload a payment document" + description: "Handles the uploading of a document to a payment" + operationId: uploadPayment + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Payment Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Payment object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Payment" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" \ No newline at end of file diff --git a/openapi/paths/projects.yaml b/openapi/paths/projects.yaml new file mode 100644 index 000000000000..011a16114fb7 --- /dev/null +++ b/openapi/paths/projects.yaml @@ -0,0 +1,342 @@ + /api/v1/projects: + get: + tags: + - projects + summary: "List projects" + description: "Lists projects" + operationId: getProjects + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + responses: + 200: + description: "A list of projects" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - projects + summary: "Create project" + description: "Adds an project to a company" + operationId: storeProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/projects/{id}": + get: + tags: + - projects + summary: "Show project" + description: "Displays a project by id" + operationId: showProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the expense object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - projects + summary: "Update project" + description: "Handles the updating of a project by id" + operationId: updateProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - projects + summary: "Delete project" + description: "Handles the deletion of a project by id" + operationId: deleteProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/projects/{id}/edit": + get: + tags: + - projects + summary: "Edit project" + description: "Displays a project by id" + operationId: editProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/projects/create: + get: + tags: + - projects + summary: "Blank project" + description: "Returns a blank object with default values" + operationId: getProjectsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/projects/bulk: + post: + tags: + - projects + summary: "Bulk project actions" + description: "" + operationId: bulkProjects + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "User credentials" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Project User response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/projects/{id}/upload": + put: + tags: + - projects + summary: "Uploads a project document" + description: "Handles the uploading of a document to a project" + operationId: uploadProject + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Project Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Project object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Project" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" \ No newline at end of file diff --git a/openapi/paths/purchase_orders.yaml b/openapi/paths/purchase_orders.yaml new file mode 100644 index 000000000000..78592680b0b0 --- /dev/null +++ b/openapi/paths/purchase_orders.yaml @@ -0,0 +1,427 @@ + /api/v1/purchase_orders: + get: + tags: + - purchase_orders + summary: "List purchase orders" + description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" + operationId: getPurchaseOrders + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A list of purchase orders" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - purhcase_orders + summary: "Create purchase order" + description: "Adds an purchase order to the system" + operationId: storePurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + "/api/v1/purchase_orders/{id}": + get: + tags: + - purchase_orders + summary: "Show purchase order" + description: "Displays an purchase order by id" + operationId: showPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Purchase order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_order/{id}": + put: + tags: + - purchase_orders + summary: "Update purchase order" + description: "Handles the updating of an purchase order by id" + operationId: updatePurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The purchase order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - purchase_orders + summary: "Delete purchase order" + description: "Handles the deletion of an purchase orders by id" + operationId: deletePurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The purhcase order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_orders/{id}/edit": + get: + tags: + - purchase_orders + summary: "Edit purchase order" + description: "Displays an purchase order by id" + operationId: editPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The purchase order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + + /api/v1/purchase_orders/create: + get: + tags: + - purchase_orders + summary: "Blank purchase order" + description: "Returns a blank object with default values" + operationId: getPurchaseOrderCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank purchase order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Credit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/purchase_orders/bulk: + post: + tags: + - purchase_orders + summary: "Bulk purchase order action" + description: "" + operationId: bulkPurchaseOrderss + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "Purchase Order IDS" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Bulk Action response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_orders/{id}/{action}": + get: + deprecated: true + tags: + - purchase_orders + summary: "Custom purchase order actions" + description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" + operationId: actionPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Purchase Order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + - name: action + in: path + description: "The action string to be performed" + required: true + schema: + type: string + format: string + example: clone_to_quote + responses: + 200: + description: "Returns the invoice object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Invoice" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_orders/{id}/upload": + put: + tags: + - purchase_orders + summary: "Uploads a purchase order document" + description: "Handles the uploading of a document to a purchase_order" + operationId: uploadPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Purchase Order Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Purchase Order object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/purchase_order/{invitation_key}/download": + get: + tags: + - purchase_orders + summary: "Download a purchase order PDF" + description: "Downloads a specific purchase order" + operationId: downloadPurchaseOrder + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key + in: path + description: "The Purchase Order Invitation Key" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Purchase Order pdf" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" \ No newline at end of file diff --git a/openapi/paths/quotes.yaml b/openapi/paths/quotes.yaml new file mode 100644 index 000000000000..15530d857a79 --- /dev/null +++ b/openapi/paths/quotes.yaml @@ -0,0 +1,477 @@ + /api/v1/quotes: + get: + tags: + - quotes + summary: "List quotes" + description: "Lists quotes, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the quotes, these are handled by the QuoteFilters class which defines the methods available" + operationId: getQuotes + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/status" + - $ref: "#/components/parameters/client_id" + - $ref: "#/components/parameters/created_at" + - $ref: "#/components/parameters/updated_at" + - $ref: "#/components/parameters/is_deleted" + - $ref: "#/components/parameters/filter_deleted_clients" + - $ref: "#/components/parameters/vendor_id" + - name: filter + in: query + description: | + Searches across a range of columns including: + - number + - custom_value1 + - custom_value2 + - custom_value3 + - custom_value4 + required: false + schema: + type: string + example: ?filter=bob + - name: client_status + in: query + description: | + A comma separated list of quote status strings. Valid options include: + - all + - draft + - sent + - approved + - expired + - upcoming + required: false + schema: + type: string + example: ?client_status=paid,unpaid + - name: number + in: query + description: | + Search quote by quote number + required: false + schema: + type: string + example: ?number=Q-001 + - name: sort + in: query + description: Returns the list sorted by column in ascending or descending order. + required: false + schema: + type: string + example: id|desc number|desc balance|asc + responses: + 200: + description: "A list of quotes" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - quotes + summary: "Create quote" + description: "Adds an Quote to the system" + operationId: storeQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quotes/{id}": + get: + tags: + - quotes + summary: "Show quote" + description: "Displays an Quote by id" + operationId: showQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - quotes + summary: "Update quote" + description: "Handles the updating of an Quote by id" + operationId: updateQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - quotes + summary: "Delete quote" + description: "Handles the deletion of an Quote by id" + operationId: deleteQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quotes/{id}/edit": + get: + tags: + - quotes + summary: "Edit quote" + description: "Displays an Quote by id" + operationId: editQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/quotes/create: + get: + tags: + - quotes + summary: "Blank quote" + description: "Returns a blank object with default values" + operationId: getQuotesCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/quotes/bulk: + post: + tags: + - quotes + summary: "Bulk quote actions" + description: "" + operationId: bulkQuotes + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "Hashed ids" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Quote response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quotes/{id}/{action}": + get: + deprecated: true + tags: + - quotes + summary: "Performs a custom action on an Quote" + description: "Performs a custom action on an Quote.\n\n The current range of actions are as follows\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - convert\n - convert_to_invoice\n - email" + operationId: actionQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + - name: action + in: path + description: "The action string to be performed" + required: true + schema: + type: string + format: string + example: clone_to_quote + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quote/{invitation_key}/download": + get: + tags: + - quotes + summary: "Download quote PDF" + description: "Downloads a specific quote" + operationId: downloadQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key + in: path + description: "The Quote Invitation Key" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the quote pdf" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/quotes/{id}/upload": + put: + tags: + - quotes + summary: "Upload a quote document" + description: "Handles the uploading of a document to a quote" + operationId: uploadQuote + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Quote Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Quote object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Quote" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" \ No newline at end of file diff --git a/openapi/paths/recurring_invoices.yaml b/openapi/paths/recurring_invoices.yaml index 32087113e63a..0ca64642c0e2 100644 --- a/openapi/paths/recurring_invoices.yaml +++ b/openapi/paths/recurring_invoices.yaml @@ -2,7 +2,7 @@ get: tags: - recurring_invoices - summary: "List Recurring Invoices" + summary: "List recurring invoices" description: | Lists invoices with the option to chain multiple query parameters allowing fine grained filtering of the list. @@ -73,8 +73,8 @@ post: tags: - recurring_invoices - summary: "Adds a RecurringInvoice" - description: "Adds an RecurringInvoice to the system" + summary: "Create recurring invoice" + description: "Adds a Recurring Invoice to the system" operationId: storeRecurringInvoice parameters: - $ref: "#/components/parameters/X-API-TOKEN" @@ -102,44 +102,12 @@ $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - /api/v1/recurring_invoices/create: - get: - tags: - - recurring_invoices - summary: "Gets a new blank RecurringInvoice object" - description: "Returns a blank object with default values" - operationId: getRecurringInvoicesCreate - parameters: - - $ref: "#/components/parameters/X-API-TOKEN" - - $ref: "#/components/parameters/X-Requested-With" - - $ref: "#/components/parameters/include" - responses: - 200: - description: "A blank RecurringInvoice object" - headers: - X-MINIMUM-CLIENT-VERSION: - $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" - X-RateLimit-Remaining: - $ref: "#/components/headers/X-RateLimit-Remaining" - X-RateLimit-Limit: - $ref: "#/components/headers/X-RateLimit-Limit" - content: - application/json: - schema: - $ref: "#/components/schemas/RecurringInvoice" - 401: - $ref: "#/components/responses/401" - 403: - $ref: "#/components/responses/403" - 422: - $ref: "#/components/responses/422" - default: - $ref: "#/components/responses/default" + "/api/v1/recurring_invoices/{id}": get: tags: - recurring_invoices - summary: "Shows an RecurringInvoice" + summary: "Show recurring invoice" description: "Displays an RecurringInvoice by id" operationId: showRecurringInvoice parameters: @@ -179,7 +147,7 @@ put: tags: - recurring_invoices - summary: "Updates an RecurringInvoice" + summary: "Update recurring invoice" description: "Handles the updating of an RecurringInvoice by id" operationId: updateRecurringInvoice parameters: @@ -219,7 +187,7 @@ delete: tags: - recurring_invoices - summary: "Deletes a RecurringInvoice" + summary: "Delete recurring invoice" description: "Handles the deletion of an RecurringInvoice by id" operationId: deleteRecurringInvoice parameters: @@ -256,7 +224,7 @@ get: tags: - recurring_invoices - summary: "Shows an RecurringInvoice for editting" + summary: "Edit recurring invoice" description: "Displays an RecurringInvoice by id" operationId: editRecurringInvoice parameters: @@ -293,28 +261,21 @@ $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" - "/api/v1/recurring_invoice/{invitation_key}/download": + + /api/v1/recurring_invoices/create: get: tags: - recurring_invoices - summary: "Download a specific invoice by invitation key" - description: "Downloads a specific invoice" - operationId: downloadRecurringInvoice + summary: "Blank recurring invoice" + description: "Returns a blank object with default values" + operationId: getRecurringInvoicesCreate parameters: - $ref: "#/components/parameters/X-API-TOKEN" - $ref: "#/components/parameters/X-Requested-With" - $ref: "#/components/parameters/include" - - name: invitation_key - in: path - description: "The Recurring Invoice Invitation Key" - required: true - schema: - type: string - format: string - example: D2J234DFA responses: 200: - description: "Returns the recurring invoice pdf" + description: "A blank RecurringInvoice object" headers: X-MINIMUM-CLIENT-VERSION: $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" @@ -322,6 +283,10 @@ $ref: "#/components/headers/X-RateLimit-Remaining" X-RateLimit-Limit: $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/RecurringInvoice" 401: $ref: "#/components/responses/401" 403: @@ -334,7 +299,7 @@ post: tags: - recurring_invoices - summary: "Performs bulk actions on an array of recurring_invoices" + summary: "Bulk recurring invoice actions" description: "" operationId: bulkRecurringInvoices parameters: @@ -376,9 +341,10 @@ $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}/{action}": get: + deprecated: true tags: - recurring_invoices - summary: "Performs a custom action on an RecurringInvoice" + summary: "Custom recurring invoice action" description: "Performs a custom action on an RecurringInvoice.\n\n The current range of actions are as follows\n - clone_to_RecurringInvoice\n - clone_to_quote\n - history\n - delivery_note\n - mark_paid\n - download\n - archive\n - delete\n - email" operationId: actionRecurringInvoice parameters: @@ -423,11 +389,48 @@ $ref: "#/components/responses/422" default: $ref: "#/components/responses/default" + "/api/v1/recurring_invoice/{invitation_key}/download": + get: + tags: + - recurring_invoices + summary: "Download recurring invoice PDF" + description: "Downloads a specific invoice" + operationId: downloadRecurringInvoice + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: invitation_key + in: path + description: "The Recurring Invoice Invitation Key" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the recurring invoice pdf" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" "/api/v1/recurring_invoices/{id}/upload": put: tags: - recurring_invoices - summary: "Uploads a document to a recurring_invoice" + summary: "Add recurring invoice document" description: "Handles the uploading of a document to a recurring_invoice" operationId: uploadRecurringInvoice parameters: diff --git a/openapi/paths/tasks.yaml b/openapi/paths/tasks.yaml new file mode 100644 index 000000000000..521a1b20fb55 --- /dev/null +++ b/openapi/paths/tasks.yaml @@ -0,0 +1,371 @@ + /api/v1/tasks: + get: + tags: + - tasks + summary: "List tasks" + description: "Lists tasks, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the tasks, these are handled by the TaskFilters class which defines the methods available" + operationId: getTasks + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + responses: + 200: + description: "A list of tasks" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - tasks + summary: "Create task" + description: "Adds an task to a company" + operationId: storeTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/tasks/{id}": + get: + tags: + - tasks + summary: "Show task" + description: "Displays a task by id" + operationId: showTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - tasks + summary: "Update task" + description: "Handles the updating of a task by id" + operationId: updateTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - tasks + summary: "Delete task" + description: "Handles the deletion of a task by id" + operationId: deleteTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/tasks/{id}/edit": + get: + tags: + - tasks + summary: "Edit task" + description: "Displays a task by id" + operationId: editTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the client object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/tasks/create: + get: + tags: + - tasks + summary: "Blank task" + description: "Returns a blank task with default values" + operationId: getTasksCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/tasks/bulk: + post: + tags: + - tasks + summary: "Bulk task actions" + description: "" + operationId: bulkTasks + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "User credentials" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Task User response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/tasks/{id}/upload": + put: + tags: + - tasks + summary: "Uploads a task document" + description: "Handles the uploading of a document to a task" + operationId: uploadTask + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Task Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Task object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Task" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/tasks/sort: + post: + tags: + - tasks + summary: "Sort tasks on KanBan" + description: "Sorts tasks after drag and drop on the KanBan." + operationId: sortTasks + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns an Ok, 200 HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" \ No newline at end of file diff --git a/openapi/paths/vendors.yaml b/openapi/paths/vendors.yaml new file mode 100644 index 000000000000..1f9de2ad5614 --- /dev/null +++ b/openapi/paths/vendors.yaml @@ -0,0 +1,342 @@ + /api/v1/vendors: + get: + tags: + - vendors + summary: "List vendors" + description: "Lists vendors, search and filters allow fine grained lists to be generated.\n\n Query parameters can be added to performed more fine grained filtering of the vendors, these are handled by the VendorFilters class which defines the methods available" + operationId: getVendors + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - $ref: "#/components/parameters/index" + responses: + 200: + description: "A list of vendors" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + post: + tags: + - vendors + summary: "Create vendor" + description: "Adds a vendor to a company" + operationId: storeVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "Returns the saved clivendorent object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/vendors/{id}": + get: + tags: + - vendors + summary: "Show vendor" + description: "Displays a vendor by id" + operationId: showVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + put: + tags: + - vendors + summary: "Update vendor" + description: "Handles the updating of a vendor by id" + operationId: updateVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + delete: + tags: + - vendors + summary: "Delete vendor" + description: "Handles the deletion of a vendor by id" + operationId: deleteVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns a HTTP status" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/vendors/{id}/edit": + get: + tags: + - vendors + summary: "Edit vendor" + description: "Displays a vendor by id" + operationId: editVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/vendors/create: + get: + tags: + - vendors + summary: "Blank vendor" + description: "Returns a blank vendor with default values" + operationId: getVendorsCreate + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + responses: + 200: + description: "A blank vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + /api/v1/vendors/bulk: + post: + tags: + - vendors + summary: "Bulk vendor actions" + description: "" + operationId: bulkVendors + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/index" + requestBody: + description: "User credentials" + required: true + content: + application/json: + schema: + type: array + items: + description: "Array of hashed IDs to be bulk 'actioned" + type: integer + example: "[0,1,2,3]" + responses: + 200: + description: "The Vendor User response" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" + "/api/v1/vendors/{id}/upload": + put: + tags: + - vendors + summary: "Uploads a vendor document" + description: "Handles the uploading of a document to a vendor" + operationId: uploadVendor + parameters: + - $ref: "#/components/parameters/X-API-TOKEN" + - $ref: "#/components/parameters/X-Requested-With" + - $ref: "#/components/parameters/include" + - name: id + in: path + description: "The Vendor Hashed ID" + required: true + schema: + type: string + format: string + example: D2J234DFA + responses: + 200: + description: "Returns the Vendor object" + headers: + X-MINIMUM-CLIENT-VERSION: + $ref: "#/components/headers/X-MINIMUM-CLIENT-VERSION" + X-RateLimit-Remaining: + $ref: "#/components/headers/X-RateLimit-Remaining" + X-RateLimit-Limit: + $ref: "#/components/headers/X-RateLimit-Limit" + content: + application/json: + schema: + $ref: "#/components/schemas/Vendor" + 401: + $ref: "#/components/responses/401" + 403: + $ref: "#/components/responses/403" + 422: + $ref: "#/components/responses/422" + default: + $ref: "#/components/responses/default" \ No newline at end of file From 49d08b279ee5b31ad8d9b0318c5f2cadb2ce7e3f Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 16:48:54 +1100 Subject: [PATCH 20/33] Better use of tags in openapi docs --- openapi/api-docs.yaml | 27 ++++++++++++++------------- openapi/misc/misc.yaml | 3 ++- openapi/paths/purchase_orders.yaml | 22 +++++++++++----------- 3 files changed, 27 insertions(+), 25 deletions(-) diff --git a/openapi/api-docs.yaml b/openapi/api-docs.yaml index 87ac2c937441..6b7bd39064b4 100644 --- a/openapi/api-docs.yaml +++ b/openapi/api-docs.yaml @@ -10182,7 +10182,7 @@ paths: /api/v1/purchase_orders: get: tags: - - purchase_orders + - Purchase Orders summary: "List purchase orders" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" operationId: getPurchaseOrders @@ -10214,7 +10214,7 @@ paths: $ref: "#/components/responses/default" post: tags: - - purhcase_orders + - Purchase Orders summary: "Create purchase order" description: "Adds an purchase order to the system" operationId: storePurchaseOrder @@ -10248,8 +10248,8 @@ paths: "/api/v1/purchase_orders/{id}": get: tags: - - purchase_orders - summary: "Show purcase order" + - Purchase Orders + summary: "Show purchase order" description: "Displays an purchase order by id" operationId: showPurchaseOrder parameters: @@ -10289,7 +10289,7 @@ paths: "/api/v1/purchase_order/{id}": put: tags: - - purchase_orders + - Purchase Orders summary: "Update purchase order" description: "Handles the updating of an purchase order by id" operationId: updatePurchaseOrder @@ -10329,7 +10329,7 @@ paths: $ref: "#/components/responses/default" delete: tags: - - purchase_orders + - Purchase Orders summary: "Delete purchase order" description: "Handles the deletion of an purchase orders by id" operationId: deletePurchaseOrder @@ -10366,7 +10366,7 @@ paths: "/api/v1/purchase_orders/{id}/edit": get: tags: - - purchase_orders + - Purchase Orders summary: "Edit purchase order" description: "Displays an purchase order by id" operationId: editPurchaseOrder @@ -10408,7 +10408,7 @@ paths: /api/v1/purchase_orders/create: get: tags: - - purchase_orders + - Purchase Orders summary: "Blank purchase order" description: "Returns a blank object with default values" operationId: getPurchaseOrderCreate @@ -10441,7 +10441,7 @@ paths: /api/v1/purchase_orders/bulk: post: tags: - - purchase_orders + - Purchase Orders summary: "Bulk purchase order action" description: "" operationId: bulkPurchaseOrderss @@ -10482,7 +10482,7 @@ paths: get: deprecated: true tags: - - purchase_orders + - Purchase Orders summary: "Custom purchase order actions" description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" operationId: actionPurchaseOrder @@ -10531,7 +10531,7 @@ paths: "/api/v1/purchase_orders/{id}/upload": put: tags: - - purchase_orders + - Purchase Orders summary: "Uploads a purchase order document" description: "Handles the uploading of a document to a purchase_order" operationId: uploadPurchaseOrder @@ -10572,7 +10572,7 @@ paths: "/api/v1/purchase_order/{invitation_key}/download": get: tags: - - purchase_orders + - Purchase Orders summary: "Download a purchase order PDF" description: "Downloads a specific purchase order" operationId: downloadPurchaseOrder @@ -17300,7 +17300,8 @@ tags: - name: vendors description: | Endpoint definitions for interacting with vendors. - - name: purchase_orders + - name: Purchase Orders + summary: Purchase Orders description: | Endpoint definitions for interacting with purchase orders. - name: expenses diff --git a/openapi/misc/misc.yaml b/openapi/misc/misc.yaml index 9fdee4bf4f8d..37ac872de72e 100644 --- a/openapi/misc/misc.yaml +++ b/openapi/misc/misc.yaml @@ -35,7 +35,8 @@ tags: - name: vendors description: | Endpoint definitions for interacting with vendors. - - name: purchase_orders + - name: Purchase Orders + summary: Purchase Orders description: | Endpoint definitions for interacting with purchase orders. - name: expenses diff --git a/openapi/paths/purchase_orders.yaml b/openapi/paths/purchase_orders.yaml index 78592680b0b0..dc428c115d94 100644 --- a/openapi/paths/purchase_orders.yaml +++ b/openapi/paths/purchase_orders.yaml @@ -1,7 +1,7 @@ /api/v1/purchase_orders: get: tags: - - purchase_orders + - Purchase Orders summary: "List purchase orders" description: "Lists purchase orders, search and filters allow fine grained lists to be generated.\n *\n * Query parameters can be added to performed more fine grained filtering of the purchase orders, these are handled by the PurchaseOrderFilters class which defines the methods available" operationId: getPurchaseOrders @@ -33,7 +33,7 @@ $ref: "#/components/responses/default" post: tags: - - purhcase_orders + - Purchase Orders summary: "Create purchase order" description: "Adds an purchase order to the system" operationId: storePurchaseOrder @@ -67,7 +67,7 @@ "/api/v1/purchase_orders/{id}": get: tags: - - purchase_orders + - Purchase Orders summary: "Show purchase order" description: "Displays an purchase order by id" operationId: showPurchaseOrder @@ -108,7 +108,7 @@ "/api/v1/purchase_order/{id}": put: tags: - - purchase_orders + - Purchase Orders summary: "Update purchase order" description: "Handles the updating of an purchase order by id" operationId: updatePurchaseOrder @@ -148,7 +148,7 @@ $ref: "#/components/responses/default" delete: tags: - - purchase_orders + - Purchase Orders summary: "Delete purchase order" description: "Handles the deletion of an purchase orders by id" operationId: deletePurchaseOrder @@ -185,7 +185,7 @@ "/api/v1/purchase_orders/{id}/edit": get: tags: - - purchase_orders + - Purchase Orders summary: "Edit purchase order" description: "Displays an purchase order by id" operationId: editPurchaseOrder @@ -227,7 +227,7 @@ /api/v1/purchase_orders/create: get: tags: - - purchase_orders + - Purchase Orders summary: "Blank purchase order" description: "Returns a blank object with default values" operationId: getPurchaseOrderCreate @@ -260,7 +260,7 @@ /api/v1/purchase_orders/bulk: post: tags: - - purchase_orders + - Purchase Orders summary: "Bulk purchase order action" description: "" operationId: bulkPurchaseOrderss @@ -301,7 +301,7 @@ get: deprecated: true tags: - - purchase_orders + - Purchase Orders summary: "Custom purchase order actions" description: "Performs a custom action on an purchase order.\n *\n * The current range of actions are as follows\n * - mark_paid\n * - download\n * - archive\n * - delete\n * - email" operationId: actionPurchaseOrder @@ -350,7 +350,7 @@ "/api/v1/purchase_orders/{id}/upload": put: tags: - - purchase_orders + - Purchase Orders summary: "Uploads a purchase order document" description: "Handles the uploading of a document to a purchase_order" operationId: uploadPurchaseOrder @@ -391,7 +391,7 @@ "/api/v1/purchase_order/{invitation_key}/download": get: tags: - - purchase_orders + - Purchase Orders summary: "Download a purchase order PDF" description: "Downloads a specific purchase order" operationId: downloadPurchaseOrder From 15d5511649f20e9cffcd3305d8af33885a38cbda Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 17:30:46 +1100 Subject: [PATCH 21/33] Add conditional in blade for hiding logo block if no logo is present --- resources/views/email/template/client.blade.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/resources/views/email/template/client.blade.php b/resources/views/email/template/client.blade.php index f67b976b5b58..23bd185250e9 100644 --- a/resources/views/email/template/client.blade.php +++ b/resources/views/email/template/client.blade.php @@ -147,9 +147,9 @@
- + @if($logo) alt_text - + @endif
From 420bc600513cde39325cf093493905aa2d6b15ed Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 18:15:54 +1100 Subject: [PATCH 22/33] Use a blank PNG for the company logo, when none others are present --- app/Models/Presenters/CompanyPresenter.php | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/app/Models/Presenters/CompanyPresenter.php b/app/Models/Presenters/CompanyPresenter.php index 092bf2a5a9e4..395adfc4a5da 100644 --- a/app/Models/Presenters/CompanyPresenter.php +++ b/app/Models/Presenters/CompanyPresenter.php @@ -42,8 +42,7 @@ class CompanyPresenter extends EntityPresenter } elseif (strlen($settings->company_logo) >= 1) { return url('') . $settings->company_logo; } else { - return "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNkYAAAAAYAAjCB0C8AAAAASUVORK5CYII="; - //return asset('images/new_logo.png'); + return asset('images/blank.png'); } } From 1e232c4f96ddcf939c1500d9da43b9ff251517ba Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 18:50:40 +1100 Subject: [PATCH 23/33] Minor fixes for email templates --- resources/views/email/template/client.blade.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/resources/views/email/template/client.blade.php b/resources/views/email/template/client.blade.php index 23bd185250e9..4baec086dc01 100644 --- a/resources/views/email/template/client.blade.php +++ b/resources/views/email/template/client.blade.php @@ -147,8 +147,8 @@
- @if($logo) - alt_text + @if($logo && strpos($logo, 'blank.png') === false) + alt_text @endif
From 0baa2c09e06ad43cfd3a6174705547d33465fe42 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Sun, 19 Feb 2023 19:08:58 +1100 Subject: [PATCH 24/33] Use a blank PNG for the company logo, when none others are present --- public/images/blank.png | Bin 0 -> 555 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 public/images/blank.png diff --git a/public/images/blank.png b/public/images/blank.png new file mode 100644 index 0000000000000000000000000000000000000000..c93775c41031893d19e0a152d39da7b88f14789b GIT binary patch literal 555 zcmV+`0@VG9P)EX>4Tx04R}tkv&MmKpe$iQ>7}E4(%Y~kfAzR5EXIMDionYs1;guFuC*#ni!H4 z7e~Rh;NZt%)xpJCR|i)?5c~jfb#YR3krMxx6k5c1aNLh~_a1le0HIN3n$;;BvB z;Ji;9V`W(-J|`YE>4LKlt6PRh$_2lEO)#`^9lShJny7(5ySo_p#$NPk`VvaHY5X8x3Iklk|F9 ziyr}zZQ$a%ttorJh;#z$LRx*rLNL9z`-Ff zQljiNpLh3k_V(|YR)0V9xpH*lJ5V+N000SaNLh0L04^f{04^f|c%?sf00007bV*G` z2j>D42MII^z;p5d000?uMObu0Z*6U5Zgc=ca%Ew3Wn>_CX>@2HM@dakSAh-}0000M tNkl Date: Sun, 19 Feb 2023 20:35:54 +1100 Subject: [PATCH 25/33] Update exclusion exception array --- app/Exceptions/Handler.php | 1 + 1 file changed, 1 insertion(+) diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.php index 9e258dbb19f2..f3a086967f7c 100644 --- a/app/Exceptions/Handler.php +++ b/app/Exceptions/Handler.php @@ -63,6 +63,7 @@ class Handler extends ExceptionHandler Symfony\Component\Process\Exception\RuntimeException::class, InvalidArgumentException::class, RuntimeException::class, + Aws\Exception\CredentialsException::class, ]; protected $hostedDontReport = [ From 0b6c74ce2f5a764204e9792ea8070387ca832ba8 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Mon, 20 Feb 2023 09:21:21 +1100 Subject: [PATCH 26/33] Refactor for how we sent admin notifications --- .../Credit/CreditCreatedNotification.php | 11 +- .../Credit/CreditEmailedNotification.php | 11 +- .../Invoice/InvoiceCreatedNotification.php | 11 +- .../Invoice/InvoiceEmailedNotification.php | 11 +- .../InvoiceFailedEmailNotification.php | 14 +- .../Misc/InvitationViewedListener.php | 13 +- app/Listeners/Payment/PaymentNotification.php | 12 +- .../PurchaseOrderAcceptedListener.php | 12 +- .../PurchaseOrderCreatedListener.php | 12 +- .../PurchaseOrderEmailedNotification.php | 11 +- .../Quote/QuoteApprovedNotification.php | 13 +- .../Quote/QuoteCreatedNotification.php | 13 +- .../Quote/QuoteEmailedNotification.php | 11 +- app/Mail/Admin/EntityCreatedObject.php | 4 +- app/Mail/Admin/EntityNotificationMailer.php | 5 +- app/Mail/User/UserNotificationMailer.php | 5 +- app/Notifications/BaseNotification.php | 153 ------------------ 17 files changed, 92 insertions(+), 230 deletions(-) delete mode 100644 app/Notifications/BaseNotification.php diff --git a/app/Listeners/Credit/CreditCreatedNotification.php b/app/Listeners/Credit/CreditCreatedNotification.php index 5c7b0350412b..6a982dfe46ae 100644 --- a/app/Listeners/Credit/CreditCreatedNotification.php +++ b/app/Listeners/Credit/CreditCreatedNotification.php @@ -44,11 +44,6 @@ class CreditCreatedNotification implements ShouldQueue $credit = $event->credit; - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntityCreatedObject($credit, 'credit'))->build()); - $nmo->company = $credit->company; - $nmo->settings = $credit->company->settings; - /* We loop through each user and determine whether they need to be notified */ foreach ($event->company->company_users as $company_user) { /* The User */ @@ -64,9 +59,15 @@ class CreditCreatedNotification implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntityCreatedObject($credit, 'credit'))->build()); + $nmo->company = $credit->company; + $nmo->settings = $credit->company->settings; $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + + $nmo = null; } /* Override the methods in the Notification Class */ diff --git a/app/Listeners/Credit/CreditEmailedNotification.php b/app/Listeners/Credit/CreditEmailedNotification.php index 1d04798b81c6..5b6aafe2e6e7 100644 --- a/app/Listeners/Credit/CreditEmailedNotification.php +++ b/app/Listeners/Credit/CreditEmailedNotification.php @@ -44,11 +44,6 @@ class CreditEmailedNotification implements ShouldQueue $credit->last_sent_date = now(); $credit->saveQuietly(); - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntitySentObject($event->invitation, 'credit', $event->template))->build()); - $nmo->company = $credit->company; - $nmo->settings = $credit->company->settings; - foreach ($event->invitation->company->company_users as $company_user) { $user = $company_user->user; @@ -60,9 +55,15 @@ class CreditEmailedNotification implements ShouldQueue // if (($key = array_search('mail', $methods))) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntitySentObject($event->invitation, 'credit', $event->template))->build()); + $nmo->company = $credit->company; + $nmo->settings = $credit->company->settings; $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + + $nmo = null; } } } diff --git a/app/Listeners/Invoice/InvoiceCreatedNotification.php b/app/Listeners/Invoice/InvoiceCreatedNotification.php index 1022a2f50713..749cdc101b1c 100644 --- a/app/Listeners/Invoice/InvoiceCreatedNotification.php +++ b/app/Listeners/Invoice/InvoiceCreatedNotification.php @@ -44,11 +44,6 @@ class InvoiceCreatedNotification implements ShouldQueue $invoice = $event->invoice; - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntityCreatedObject($invoice, 'invoice'))->build()); - $nmo->company = $invoice->company; - $nmo->settings = $invoice->company->settings; - /* We loop through each user and determine whether they need to be notified */ foreach ($event->company->company_users as $company_user) { /* The User */ @@ -68,10 +63,16 @@ class InvoiceCreatedNotification implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntityCreatedObject($invoice, 'invoice'))->build()); + $nmo->company = $invoice->company; + $nmo->settings = $invoice->company->settings; $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + $nmo = null; + /* This prevents more than one notification being sent */ $first_notification_sent = false; } diff --git a/app/Listeners/Invoice/InvoiceEmailedNotification.php b/app/Listeners/Invoice/InvoiceEmailedNotification.php index e9012e0a8f31..f2b4c77fc80a 100644 --- a/app/Listeners/Invoice/InvoiceEmailedNotification.php +++ b/app/Listeners/Invoice/InvoiceEmailedNotification.php @@ -46,10 +46,6 @@ class InvoiceEmailedNotification implements ShouldQueue $invoice->last_sent_date = now(); $invoice->saveQuietly(); - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntitySentObject($event->invitation, 'invoice', $event->template))->build()); - $nmo->company = $invoice->company; - $nmo->settings = $invoice->company->settings; /* We loop through each user and determine whether they need to be notified */ foreach ($event->invitation->company->company_users as $company_user) { @@ -66,10 +62,15 @@ class InvoiceEmailedNotification implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntitySentObject($event->invitation, 'invoice', $event->template))->build()); + $nmo->company = $invoice->company; + $nmo->settings = $invoice->company->settings; $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); - + + $nmo = null; /* This prevents more than one notification being sent */ $first_notification_sent = false; } diff --git a/app/Listeners/Invoice/InvoiceFailedEmailNotification.php b/app/Listeners/Invoice/InvoiceFailedEmailNotification.php index 85005e4503e0..670139ef6b91 100644 --- a/app/Listeners/Invoice/InvoiceFailedEmailNotification.php +++ b/app/Listeners/Invoice/InvoiceFailedEmailNotification.php @@ -45,13 +45,7 @@ class InvoiceFailedEmailNotification $first_notification_sent = true; $invoice = $event->invitation->invoice; - // $invoice->update(['last_sent_date' => now()]); - - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntityFailedSendObject($event->invitation, 'invoice', $event->template, $event->message))->build()); - $nmo->company = $invoice->company; - $nmo->settings = $invoice->company->settings; - + foreach ($event->invitation->company->company_users as $company_user) { $user = $company_user->user; @@ -60,10 +54,16 @@ class InvoiceFailedEmailNotification if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntityFailedSendObject($event->invitation, 'invoice', $event->template, $event->message))->build()); + $nmo->company = $invoice->company; + $nmo->settings = $invoice->company->settings; $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + $nmo = null; + $first_notification_sent = false; } } diff --git a/app/Listeners/Misc/InvitationViewedListener.php b/app/Listeners/Misc/InvitationViewedListener.php index 885b4c9c7b2b..c27ae85ca103 100644 --- a/app/Listeners/Misc/InvitationViewedListener.php +++ b/app/Listeners/Misc/InvitationViewedListener.php @@ -58,11 +58,6 @@ class InvitationViewedListener implements ShouldQueue $entity_name = 'purchase_order'; } - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntityViewedObject($invitation, $entity_name))->build()); - $nmo->company = $invitation->company; - $nmo->settings = $invitation->company->settings; - foreach ($invitation->company->company_users as $company_user) { $entity_viewed = "{$entity_name}_viewed"; $entity_viewed_all = "{$entity_name}_viewed_all"; @@ -73,8 +68,16 @@ class InvitationViewedListener implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntityViewedObject($invitation, $entity_name))->build()); + $nmo->company = $invitation->company; + $nmo->settings = $invitation->company->settings; + $nmo->to_user = $company_user->user; (new NinjaMailerJob($nmo))->handle(); + + $nmo = null; } } } diff --git a/app/Listeners/Payment/PaymentNotification.php b/app/Listeners/Payment/PaymentNotification.php index 5dbe0374e519..9db966cffc5d 100644 --- a/app/Listeners/Payment/PaymentNotification.php +++ b/app/Listeners/Payment/PaymentNotification.php @@ -51,11 +51,6 @@ class PaymentNotification implements ShouldQueue $payment = $event->payment; - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntityPaidObject($payment))->build()); - $nmo->company = $event->company; - $nmo->settings = $event->company->settings; - /*User notifications*/ foreach ($payment->company->company_users as $company_user) { $user = $company_user->user; @@ -73,9 +68,16 @@ class PaymentNotification implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntityPaidObject($payment))->build()); + $nmo->company = $event->company; + $nmo->settings = $event->company->settings; $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + + $nmo = null; + } } diff --git a/app/Listeners/PurchaseOrder/PurchaseOrderAcceptedListener.php b/app/Listeners/PurchaseOrder/PurchaseOrderAcceptedListener.php index 2803f82379a6..e4cd1c170757 100644 --- a/app/Listeners/PurchaseOrder/PurchaseOrderAcceptedListener.php +++ b/app/Listeners/PurchaseOrder/PurchaseOrderAcceptedListener.php @@ -41,11 +41,7 @@ class PurchaseOrderAcceptedListener implements ShouldQueue $purchase_order = $event->purchase_order; - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new PurchaseOrderAcceptedObject($purchase_order, $event->company))->build()); - $nmo->company = $event->company; - $nmo->settings = $event->company->settings; - + /* We loop through each user and determine whether they need to be notified */ foreach ($event->company->company_users as $company_user) { /* The User */ @@ -62,10 +58,16 @@ class PurchaseOrderAcceptedListener implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new PurchaseOrderAcceptedObject($purchase_order, $event->company))->build()); + $nmo->company = $event->company; + $nmo->settings = $event->company->settings; + $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + $nmo = null; /* This prevents more than one notification being sent */ $first_notification_sent = false; } diff --git a/app/Listeners/PurchaseOrder/PurchaseOrderCreatedListener.php b/app/Listeners/PurchaseOrder/PurchaseOrderCreatedListener.php index 61178815573f..057743942d93 100644 --- a/app/Listeners/PurchaseOrder/PurchaseOrderCreatedListener.php +++ b/app/Listeners/PurchaseOrder/PurchaseOrderCreatedListener.php @@ -45,11 +45,7 @@ class PurchaseOrderCreatedListener implements ShouldQueue $purchase_order = $event->purchase_order; - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntityCreatedObject($purchase_order, 'purchase_order'))->build()); - $nmo->company = $purchase_order->company; - $nmo->settings = $purchase_order->company->settings; - + /* We loop through each user and determine whether they need to be notified */ foreach ($event->company->company_users as $company_user) { /* The User */ @@ -69,10 +65,16 @@ class PurchaseOrderCreatedListener implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntityCreatedObject($purchase_order, 'purchase_order'))->build()); + $nmo->company = $purchase_order->company; + $nmo->settings = $purchase_order->company->settings; + $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + $nmo = null; /* This prevents more than one notification being sent */ $first_notification_sent = false; } diff --git a/app/Listeners/PurchaseOrder/PurchaseOrderEmailedNotification.php b/app/Listeners/PurchaseOrder/PurchaseOrderEmailedNotification.php index 82c3b3b0cf18..61aa8787c917 100644 --- a/app/Listeners/PurchaseOrder/PurchaseOrderEmailedNotification.php +++ b/app/Listeners/PurchaseOrder/PurchaseOrderEmailedNotification.php @@ -46,11 +46,6 @@ class PurchaseOrderEmailedNotification implements ShouldQueue $purchase_order->last_sent_date = now(); $purchase_order->saveQuietly(); - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntitySentObject($event->invitation, 'purchase_order', 'purchase_order'))->build()); - $nmo->company = $purchase_order->company; - $nmo->settings = $purchase_order->company->settings; - /* We loop through each user and determine whether they need to be notified */ foreach ($event->invitation->company->company_users as $company_user) { /* The User */ @@ -66,10 +61,16 @@ class PurchaseOrderEmailedNotification implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntitySentObject($event->invitation, 'purchase_order', 'purchase_order'))->build()); + $nmo->company = $purchase_order->company; + $nmo->settings = $purchase_order->company->settings; $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + $nmo = null; + /* This prevents more than one notification being sent */ $first_notification_sent = false; } diff --git a/app/Listeners/Quote/QuoteApprovedNotification.php b/app/Listeners/Quote/QuoteApprovedNotification.php index adedab41f90c..c6c0c61c8aa5 100644 --- a/app/Listeners/Quote/QuoteApprovedNotification.php +++ b/app/Listeners/Quote/QuoteApprovedNotification.php @@ -43,11 +43,7 @@ class QuoteApprovedNotification implements ShouldQueue $quote = $event->quote; - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new QuoteApprovedObject($quote, $event->company))->build()); - $nmo->company = $quote->company; - $nmo->settings = $quote->company->settings; - + /* We loop through each user and determine whether they need to be notified */ foreach ($event->company->company_users as $company_user) { /* The User */ @@ -64,10 +60,17 @@ class QuoteApprovedNotification implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new QuoteApprovedObject($quote, $event->company))->build()); + $nmo->company = $quote->company; + $nmo->settings = $quote->company->settings; + $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + $nmo = null; + /* This prevents more than one notification being sent */ $first_notification_sent = false; } diff --git a/app/Listeners/Quote/QuoteCreatedNotification.php b/app/Listeners/Quote/QuoteCreatedNotification.php index 5af1a1943e69..06b697e95930 100644 --- a/app/Listeners/Quote/QuoteCreatedNotification.php +++ b/app/Listeners/Quote/QuoteCreatedNotification.php @@ -44,11 +44,7 @@ class QuoteCreatedNotification implements ShouldQueue $quote = $event->quote; - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntityCreatedObject($quote, 'quote'))->build()); - $nmo->company = $quote->company; - $nmo->settings = $quote->company->settings; - + /* We loop through each user and determine whether they need to be notified */ foreach ($event->company->company_users as $company_user) { /* The User */ @@ -68,10 +64,17 @@ class QuoteCreatedNotification implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntityCreatedObject($quote, 'quote'))->build()); + $nmo->company = $quote->company; + $nmo->settings = $quote->company->settings; + $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + $nmo = null; + /* This prevents more than one notification being sent */ $first_notification_sent = false; } diff --git a/app/Listeners/Quote/QuoteEmailedNotification.php b/app/Listeners/Quote/QuoteEmailedNotification.php index 828941ced506..2a1c3788feb0 100644 --- a/app/Listeners/Quote/QuoteEmailedNotification.php +++ b/app/Listeners/Quote/QuoteEmailedNotification.php @@ -45,11 +45,6 @@ class QuoteEmailedNotification implements ShouldQueue $quote->last_sent_date = now(); $quote->saveQuietly(); - $nmo = new NinjaMailerObject; - $nmo->mailable = new NinjaMailer((new EntitySentObject($event->invitation, 'quote', $event->template))->build()); - $nmo->company = $quote->company; - $nmo->settings = $quote->company->settings; - foreach ($event->invitation->company->company_users as $company_user) { $user = $company_user->user; @@ -58,9 +53,15 @@ class QuoteEmailedNotification implements ShouldQueue if (($key = array_search('mail', $methods)) !== false) { unset($methods[$key]); + $nmo = new NinjaMailerObject; + $nmo->mailable = new NinjaMailer((new EntitySentObject($event->invitation, 'quote', $event->template))->build()); + $nmo->company = $quote->company; + $nmo->settings = $quote->company->settings; $nmo->to_user = $user; (new NinjaMailerJob($nmo))->handle(); + + $nmo = null; } } } diff --git a/app/Mail/Admin/EntityCreatedObject.php b/app/Mail/Admin/EntityCreatedObject.php index c75c3ec73316..df2463154ce5 100644 --- a/app/Mail/Admin/EntityCreatedObject.php +++ b/app/Mail/Admin/EntityCreatedObject.php @@ -70,7 +70,7 @@ class EntityCreatedObject ); $mail_obj->markdown = 'email.admin.generic'; - $mail_obj->tag = $this->company->company_key; + // $mail_obj->tag = $this->company->company_key; $mail_obj->data = [ 'title' => $mail_obj->subject, 'message' => ctrans( @@ -97,7 +97,7 @@ class EntityCreatedObject $mail_obj->subject = $this->getSubject(); $mail_obj->data = $this->getData(); $mail_obj->markdown = 'email.admin.generic'; - $mail_obj->tag = $this->entity->company->company_key; + // $mail_obj->tag = $this->entity->company->company_key; } return $mail_obj; diff --git a/app/Mail/Admin/EntityNotificationMailer.php b/app/Mail/Admin/EntityNotificationMailer.php index 7735e2ad5e4b..29b175426ba5 100644 --- a/app/Mail/Admin/EntityNotificationMailer.php +++ b/app/Mail/Admin/EntityNotificationMailer.php @@ -36,9 +36,6 @@ class EntityNotificationMailer extends Mailable { return $this->from(config('mail.from.address'), config('mail.from.name')) ->subject($this->mail_obj->subject) - ->markdown($this->mail_obj->markdown, $this->mail_obj->data) - ->withSymfonyMessage(function ($message) { - $message->getHeaders()->addTextHeader('Tag', $this->mail_obj->tag); - }); + ->markdown($this->mail_obj->markdown, $this->mail_obj->data); } } diff --git a/app/Mail/User/UserNotificationMailer.php b/app/Mail/User/UserNotificationMailer.php index 276a64191c94..0e5c13156daa 100644 --- a/app/Mail/User/UserNotificationMailer.php +++ b/app/Mail/User/UserNotificationMailer.php @@ -41,9 +41,6 @@ class UserNotificationMailer extends Mailable 'title' => $this->mail_obj->data['title'], 'body' => $this->mail_obj->data['message'], ]) - ->view($this->mail_obj->markdown, $this->mail_obj->data) - ->withSymfonyMessage(function ($message) { - $message->getHeaders()->addTextHeader('Tag', $this->mail_obj->tag); - }); + ->view($this->mail_obj->markdown, $this->mail_obj->data); } } diff --git a/app/Notifications/BaseNotification.php b/app/Notifications/BaseNotification.php deleted file mode 100644 index 6985f8c731ce..000000000000 --- a/app/Notifications/BaseNotification.php +++ /dev/null @@ -1,153 +0,0 @@ -line('The introduction to the notification.') - ->action('Notification Action', url('/')) - ->line('Thank you for using our application!'); - } - - /** - * Get the array representation of the notification. - * - * @param mixed $notifiable - * @return array - */ - public function toArray($notifiable) - { - return [ - // - ]; - } - - public function buildMailMessageSettings(MailMessage $mail_message) :MailMessage - { - $mail_message->subject($this->generateEmailEntityHtml($this->entity, $this->subject, $this->contact)); - - if (strlen($this->settings->reply_to_email) > 1) { - $mail_message->replyTo($this->settings->reply_to_email); - } - - if (strlen($this->settings->bcc_email) > 1) { - $mail_message->bcc($this->settings->bcc_email); - } - - if ($this->settings->pdf_email_attachment) { - $mail_message->attach(TempFile::path($this->invitation->pdf_file_path()), ['as' => basename($this->invitation->pdf_file_path())]); - } - - foreach ($this->entity->documents as $document) { - $mail_message->attach(TempFile::path($document->generateUrl()), ['as' => $document->name]); - } - - if ($this->entity instanceof Invoice && $this->settings->ubl_email_attachment) { - $ubl_string = (new Createubl($this->entity))->handle(); - $mail_message->attachData($ubl_string, $this->entity->getFileName('xml')); - } - - return $mail_message->withSymfonyMessage(function ($message) { - $message->getHeaders()->addTextHeader('Tag', $this->invitation->company->company_key); - }); - } - - public function buildMailMessageData() :array - { - $body = $this->generateEmailEntityHtml($this->entity, $this->body, $this->contact); - - $design_style = $this->settings->email_style; - - if ($design_style == 'custom') { - $email_style_custom = $this->settings->email_style_custom; - $body = strtr($email_style_custom, "$body", $body); - } - - $data = [ - 'body' => $body, - 'design' => $design_style, - 'footer' => '', - 'title' => '', - 'company' => '', - 'view_link' => $this->invitation->getLink(), - 'view_text' => ctrans('texts.view_'.$this->entity_string), - 'logo' => $this->entity->company->present()->logo(), - 'signature' => $this->settings->email_signature, - 'settings' => $this->settings, - 'whitelabel' => $this->entity->company->account->isPaid() ? true : false, - ]; - - return $data; - } - - public function getTemplateView() - { - switch ($this->settings->email_style) { - case 'plain': - return 'email.template.plain'; - break; - case 'custom': - return 'email.template.custom'; - break; - case 'light': - return 'email.template.light'; - break; - case 'dark': - return 'email.template.dark'; - break; - default: - return 'email.admin.generic_email'; - break; - } - } -} From 351b787220d72d64ef86ca3e3ac2d6de05943ccc Mon Sep 17 00:00:00 2001 From: David Bomba Date: Mon, 20 Feb 2023 09:25:03 +1100 Subject: [PATCH 27/33] Do not show paid to date on quotes --- app/Services/PdfMaker/Design.php | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/app/Services/PdfMaker/Design.php b/app/Services/PdfMaker/Design.php index b72841433f8c..667b22737788 100644 --- a/app/Services/PdfMaker/Design.php +++ b/app/Services/PdfMaker/Design.php @@ -766,6 +766,10 @@ class Design extends BaseDesign if ($this->entity->partial > 0) { $variables[] = '$partial_due'; } + + if (in_array('$paid_to_date', $variables)) { + $variables = \array_diff($variables, ['$paid_to_date']); + } } if ($this->entity instanceof Credit) { From 4a462177eff5ddf2199fea4efee78dee1279ee8c Mon Sep 17 00:00:00 2001 From: David Bomba Date: Mon, 20 Feb 2023 12:58:20 +1100 Subject: [PATCH 28/33] Stub options to redis sentinel and load balancing --- config/database.php | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/config/database.php b/config/database.php index 68d2b6a06926..ec0694c4110c 100644 --- a/config/database.php +++ b/config/database.php @@ -200,6 +200,7 @@ return [ 'replication' => 'sentinel', 'service' => env('REDIS_SENTINEL_SERVICE', 'mymaster'), 'sentinel_timeout' => 3.0, + // 'load_balancing' => false, 'parameters' => [ 'password' => env('REDIS_PASSWORD', null), 'database' => env('REDIS_DB', 0), @@ -229,3 +230,11 @@ return [ ], ]; + +/** +*'replication' => function () { +* $strategy = new Predis\Replication\ReplicationStrategy(); +* $strategy->disableLoadBalancing(); +* return new Predis\Connection\Replication\SentinelReplication($strategy); +*}]; + */ \ No newline at end of file From 70248be9adfe029a7faeee9afafeb48abb9064f1 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Mon, 20 Feb 2023 15:09:20 +1100 Subject: [PATCH 29/33] Validate custom date ranges --- .../TaskScheduler/StoreSchedulerRequest.php | 2 + tests/Feature/Scheduler/SchedulerTest.php | 102 ++++++++++++++++++ 2 files changed, 104 insertions(+) diff --git a/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php b/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php index fcc52ae8c302..e98b94283114 100644 --- a/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php +++ b/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php @@ -40,6 +40,8 @@ class StoreSchedulerRequest extends Request 'template' => 'bail|required|string', 'parameters' => 'bail|array', 'parameters.clients' => ['bail','sometimes', 'array', new ValidClientIds()], + 'parameters.start_date' => ['bail', 'sometimes', 'date'], + 'parameters.end_date' => ['bail', 'sometimes', 'date', 'after_or_equal:parameters.start_date'], ]; return $rules; diff --git a/tests/Feature/Scheduler/SchedulerTest.php b/tests/Feature/Scheduler/SchedulerTest.php index a080ced33659..ba6440cce136 100644 --- a/tests/Feature/Scheduler/SchedulerTest.php +++ b/tests/Feature/Scheduler/SchedulerTest.php @@ -54,6 +54,108 @@ class SchedulerTest extends TestCase ); } + public function testCustomDateRanges() + { + $data = [ + 'name' => 'A test statement scheduler', + 'frequency_id' => RecurringInvoice::FREQUENCY_MONTHLY, + 'next_run' => now()->format('Y-m-d'), + 'template' => 'client_statement', + 'parameters' => [ + 'date_range' => EmailStatement::CUSTOM_RANGE, + 'show_payments_table' => true, + 'show_aging_table' => true, + 'status' => 'paid', + 'clients' => [], + 'start_date' => now()->format('Y-m-d'), + 'end_date' => now()->addDays(4)->format('Y-m-d') + ], + ]; + + $response = $this->withHeaders([ + 'X-API-SECRET' => config('ninja.api_secret'), + 'X-API-TOKEN' => $this->token, + ])->postJson('/api/v1/task_schedulers', $data); + + $response->assertStatus(200); + } + + public function testCustomDateRangesFails() + { + $data = [ + 'name' => 'A test statement scheduler', + 'frequency_id' => RecurringInvoice::FREQUENCY_MONTHLY, + 'next_run' => now()->format('Y-m-d'), + 'template' => 'client_statement', + 'parameters' => [ + 'date_range' => EmailStatement::CUSTOM_RANGE, + 'show_payments_table' => true, + 'show_aging_table' => true, + 'status' => 'paid', + 'clients' => [], + 'start_date' => now()->format('Y-m-d'), + 'end_date' => now()->subDays(4)->format('Y-m-d') + ], + ]; + + $response = $this->withHeaders([ + 'X-API-SECRET' => config('ninja.api_secret'), + 'X-API-TOKEN' => $this->token, + ])->postJson('/api/v1/task_schedulers', $data); + + $response->assertStatus(422); + + + $data = [ + 'name' => 'A test statement scheduler', + 'frequency_id' => RecurringInvoice::FREQUENCY_MONTHLY, + 'next_run' => now()->format('Y-m-d'), + 'template' => 'client_statement', + 'parameters' => [ + 'date_range' => EmailStatement::CUSTOM_RANGE, + 'show_payments_table' => true, + 'show_aging_table' => true, + 'status' => 'paid', + 'clients' => [], + 'start_date' => now()->format('Y-m-d'), + 'end_date' => null + ], + ]; + + $response = $this->withHeaders([ + 'X-API-SECRET' => config('ninja.api_secret'), + 'X-API-TOKEN' => $this->token, + ])->postJson('/api/v1/task_schedulers', $data); + + $response->assertStatus(422); + + + + $data = [ + 'name' => 'A test statement scheduler', + 'frequency_id' => RecurringInvoice::FREQUENCY_MONTHLY, + 'next_run' => now()->format('Y-m-d'), + 'template' => 'client_statement', + 'parameters' => [ + 'date_range' => EmailStatement::CUSTOM_RANGE, + 'show_payments_table' => true, + 'show_aging_table' => true, + 'status' => 'paid', + 'clients' => [], + 'start_date' => null, + 'end_date' => now()->format('Y-m-d') + ], + ]; + + $response = $this->withHeaders([ + 'X-API-SECRET' => config('ninja.api_secret'), + 'X-API-TOKEN' => $this->token, + ])->postJson('/api/v1/task_schedulers', $data); + + $response->assertStatus(422); + + } + public function testClientCountResolution() { $c = Client::factory()->create([ From c8a6cee0268594f14899deea1b5ea673fb85fb18 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Mon, 20 Feb 2023 15:30:09 +1100 Subject: [PATCH 30/33] Validation for custom date ranges --- .../TaskScheduler/StoreSchedulerRequest.php | 5 ++-- tests/Feature/Scheduler/SchedulerTest.php | 27 +++++++++++++++++-- 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php b/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php index e98b94283114..e319c7825d41 100644 --- a/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php +++ b/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php @@ -40,8 +40,9 @@ class StoreSchedulerRequest extends Request 'template' => 'bail|required|string', 'parameters' => 'bail|array', 'parameters.clients' => ['bail','sometimes', 'array', new ValidClientIds()], - 'parameters.start_date' => ['bail', 'sometimes', 'date'], - 'parameters.end_date' => ['bail', 'sometimes', 'date', 'after_or_equal:parameters.start_date'], + 'parameters.date_date' => 'bail, sometimes, string, in:last7_days,last30_days,last365_days,this_month,last_month,this_quarter,last_quarter,this_year,last_year,custom', + 'parameters.start_date' => ['bail', 'sometimes', 'date', 'required_if:parameters.date_rate,custom'], + 'parameters.end_date' => ['bail', 'sometimes', 'date', 'required_if:parameters.date_rate,custom', 'after_or_equal:parameters.start_date'], ]; return $rules; diff --git a/tests/Feature/Scheduler/SchedulerTest.php b/tests/Feature/Scheduler/SchedulerTest.php index ba6440cce136..055206f4c027 100644 --- a/tests/Feature/Scheduler/SchedulerTest.php +++ b/tests/Feature/Scheduler/SchedulerTest.php @@ -129,8 +129,6 @@ class SchedulerTest extends TestCase $response->assertStatus(422); - - $data = [ 'name' => 'A test statement scheduler', 'frequency_id' => RecurringInvoice::FREQUENCY_MONTHLY, @@ -154,6 +152,31 @@ class SchedulerTest extends TestCase $response->assertStatus(422); + + + $data = [ + 'name' => 'A test statement scheduler', + 'frequency_id' => RecurringInvoice::FREQUENCY_MONTHLY, + 'next_run' => now()->format('Y-m-d'), + 'template' => 'client_statement', + 'parameters' => [ + 'date_range' => EmailStatement::CUSTOM_RANGE, + 'show_payments_table' => true, + 'show_aging_table' => true, + 'status' => 'paid', + 'clients' => [], + 'start_date' => '', + 'end_date' => '' + ], + ]; + + $response = $this->withHeaders([ + 'X-API-SECRET' => config('ninja.api_secret'), + 'X-API-TOKEN' => $this->token, + ])->postJson('/api/v1/task_schedulers', $data); + + $response->assertStatus(422); + } public function testClientCountResolution() From e3dfcb06b462a941c099939dfc07b67e288d49ec Mon Sep 17 00:00:00 2001 From: David Bomba Date: Mon, 20 Feb 2023 16:44:41 +1100 Subject: [PATCH 31/33] Fixes for validation --- app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php b/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php index e319c7825d41..72fad96c490f 100644 --- a/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php +++ b/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php @@ -40,7 +40,7 @@ class StoreSchedulerRequest extends Request 'template' => 'bail|required|string', 'parameters' => 'bail|array', 'parameters.clients' => ['bail','sometimes', 'array', new ValidClientIds()], - 'parameters.date_date' => 'bail, sometimes, string, in:last7_days,last30_days,last365_days,this_month,last_month,this_quarter,last_quarter,this_year,last_year,custom', + 'parameters.date_range' => 'bail|sometimes|string|in:last7_days,last30_days,last365_days,this_month,last_month,this_quarter,last_quarter,this_year,last_year,custom', 'parameters.start_date' => ['bail', 'sometimes', 'date', 'required_if:parameters.date_rate,custom'], 'parameters.end_date' => ['bail', 'sometimes', 'date', 'required_if:parameters.date_rate,custom', 'after_or_equal:parameters.start_date'], ]; From 60868003c7738becd972a917e7db8523a06b2f71 Mon Sep 17 00:00:00 2001 From: David Bomba Date: Mon, 20 Feb 2023 16:47:30 +1100 Subject: [PATCH 32/33] Fixes for validation --- app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php | 4 ++-- app/Http/Requests/TaskScheduler/UpdateSchedulerRequest.php | 5 +++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php b/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php index 72fad96c490f..aea0fee893a4 100644 --- a/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php +++ b/app/Http/Requests/TaskScheduler/StoreSchedulerRequest.php @@ -41,8 +41,8 @@ class StoreSchedulerRequest extends Request 'parameters' => 'bail|array', 'parameters.clients' => ['bail','sometimes', 'array', new ValidClientIds()], 'parameters.date_range' => 'bail|sometimes|string|in:last7_days,last30_days,last365_days,this_month,last_month,this_quarter,last_quarter,this_year,last_year,custom', - 'parameters.start_date' => ['bail', 'sometimes', 'date', 'required_if:parameters.date_rate,custom'], - 'parameters.end_date' => ['bail', 'sometimes', 'date', 'required_if:parameters.date_rate,custom', 'after_or_equal:parameters.start_date'], + 'parameters.start_date' => ['bail', 'sometimes', 'date:Y-m-d', 'required_if:parameters.date_rate,custom'], + 'parameters.end_date' => ['bail', 'sometimes', 'date:Y-m-d', 'required_if:parameters.date_rate,custom', 'after_or_equal:parameters.start_date'], ]; return $rules; diff --git a/app/Http/Requests/TaskScheduler/UpdateSchedulerRequest.php b/app/Http/Requests/TaskScheduler/UpdateSchedulerRequest.php index fab559b55bc4..a573177b7b5a 100644 --- a/app/Http/Requests/TaskScheduler/UpdateSchedulerRequest.php +++ b/app/Http/Requests/TaskScheduler/UpdateSchedulerRequest.php @@ -12,6 +12,7 @@ namespace App\Http\Requests\TaskScheduler; use App\Http\Requests\Request; use Illuminate\Validation\Rule; +use App\Http\ValidationRules\Scheduler\ValidClientIds; class UpdateSchedulerRequest extends Request { @@ -35,6 +36,10 @@ class UpdateSchedulerRequest extends Request 'next_run_client' => 'bail|sometimes|date:Y-m-d', 'template' => 'bail|required|string', 'parameters' => 'bail|array', + 'parameters.clients' => ['bail','sometimes', 'array', new ValidClientIds()], + 'parameters.date_range' => 'bail|sometimes|string|in:last7_days,last30_days,last365_days,this_month,last_month,this_quarter,last_quarter,this_year,last_year,custom', + 'parameters.start_date' => ['bail', 'sometimes', 'date:Y-m-d', 'required_if:parameters.date_rate,custom'], + 'parameters.end_date' => ['bail', 'sometimes', 'date:Y-m-d', 'required_if:parameters.date_rate,custom', 'after_or_equal:parameters.start_date'], ]; return $rules; From ed20376bf5eab47fe030babc27ea8e10e0e85d5e Mon Sep 17 00:00:00 2001 From: David Bomba Date: Mon, 20 Feb 2023 17:09:48 +1100 Subject: [PATCH 33/33] Fixes for client portal error page logo --- .../ClientPortal/ContactHashLoginController.php | 2 +- .../views/portal/ninja2020/generic/error.blade.php | 14 +++++++++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/app/Http/Controllers/ClientPortal/ContactHashLoginController.php b/app/Http/Controllers/ClientPortal/ContactHashLoginController.php index da95bd7393f3..fd790fd43731 100644 --- a/app/Http/Controllers/ClientPortal/ContactHashLoginController.php +++ b/app/Http/Controllers/ClientPortal/ContactHashLoginController.php @@ -44,7 +44,7 @@ class ContactHashLoginController extends Controller public function errorPage() { - return render('generic.error', ['title' => session()->get('title'), 'notification' => session()->get('notification')]); + return render('generic.error', ['title' => session()->get('title'), 'notification' => session()->get('notification'), 'account' => auth()->guard('contact')?->user()?->user?->account, 'company' => auth()->guard('contact')?->user()?->user?->company]); } private function setRedirectPath() diff --git a/resources/views/portal/ninja2020/generic/error.blade.php b/resources/views/portal/ninja2020/generic/error.blade.php index 40059f037399..422bd36e682d 100644 --- a/resources/views/portal/ninja2020/generic/error.blade.php +++ b/resources/views/portal/ninja2020/generic/error.blade.php @@ -6,7 +6,19 @@
- Invoice Ninja logo + + @if($account && !$account->isPaid()) +
+ Invoice Ninja logo +
+ @else +
+ {{ $company->present()->name() }} logo +
+ @endif +

{{ $title }}

{{ $notification }}