26732 lines
1.0 MiB
26732 lines
1.0 MiB
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
|
|
<title>welcome-pospro API Documentation</title>
|
|
|
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans&display=swap" rel="stylesheet">
|
|
|
|
<link rel="stylesheet" href="{{ asset("/vendor/scribe/css/theme-default.style.css") }}" media="screen">
|
|
<link rel="stylesheet" href="{{ asset("/vendor/scribe/css/theme-default.print.css") }}" media="print">
|
|
|
|
<script src="https://cdn.jsdelivr.net/npm/lodash@4.17.10/lodash.min.js"></script>
|
|
|
|
<link rel="stylesheet"
|
|
href="https://unpkg.com/@highlightjs/cdn-assets@11.6.0/styles/obsidian.min.css">
|
|
<script src="https://unpkg.com/@highlightjs/cdn-assets@11.6.0/highlight.min.js"></script>
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jets/0.14.1/jets.min.js"></script>
|
|
|
|
<style id="language-style">
|
|
/* starts out as display none and is replaced with js later */
|
|
body .content .bash-example code { display: none; }
|
|
body .content .javascript-example code { display: none; }
|
|
</style>
|
|
|
|
<script>
|
|
var tryItOutBaseUrl = "http://localhost:8080";
|
|
var useCsrf = Boolean();
|
|
var csrfUrl = "/sanctum/csrf-cookie";
|
|
</script>
|
|
<script src="{{ asset("/vendor/scribe/js/tryitout-5.9.0.js") }}"></script>
|
|
|
|
<script src="{{ asset("/vendor/scribe/js/theme-default-5.9.0.js") }}"></script>
|
|
|
|
</head>
|
|
|
|
<body data-languages="["bash","javascript"]">
|
|
|
|
<a href="#" id="nav-button">
|
|
<span>
|
|
MENU
|
|
<img src="{{ asset("/vendor/scribe/images/navbar.png") }}" alt="navbar-image"/>
|
|
</span>
|
|
</a>
|
|
<div class="tocify-wrapper">
|
|
|
|
<div class="lang-selector">
|
|
<button type="button" class="lang-button" data-language-name="bash">bash</button>
|
|
<button type="button" class="lang-button" data-language-name="javascript">javascript</button>
|
|
</div>
|
|
|
|
<div class="search">
|
|
<input type="text" class="search" id="input-search" placeholder="Search">
|
|
</div>
|
|
|
|
<div id="toc">
|
|
<ul id="tocify-header-introduction" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="introduction">
|
|
<a href="#introduction">Introduction</a>
|
|
</li>
|
|
</ul>
|
|
<ul id="tocify-header-authenticating-requests" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="authenticating-requests">
|
|
<a href="#authenticating-requests">Authenticating requests</a>
|
|
</li>
|
|
</ul>
|
|
<ul id="tocify-header-endpoints" class="tocify-header">
|
|
<li class="tocify-item level-1" data-unique="endpoints">
|
|
<a href="#endpoints">Endpoints</a>
|
|
</li>
|
|
<ul id="tocify-subheader-endpoints" class="tocify-subheader">
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-module-check">
|
|
<a href="#endpoints-GETapi-v1-module-check">GET api/v1/module-check</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-sign-in">
|
|
<a href="#endpoints-POSTapi-v1-sign-in">POST api/v1/sign-in</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-submit-otp">
|
|
<a href="#endpoints-POSTapi-v1-submit-otp">POST api/v1/submit-otp</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-sign-up">
|
|
<a href="#endpoints-POSTapi-v1-sign-up">POST api/v1/sign-up</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-resend-otp">
|
|
<a href="#endpoints-POSTapi-v1-resend-otp">POST api/v1/resend-otp</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-otp-settings">
|
|
<a href="#endpoints-GETapi-v1-otp-settings">GET api/v1/otp-settings</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-send-reset-code">
|
|
<a href="#endpoints-POSTapi-v1-send-reset-code">POST api/v1/send-reset-code</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-verify-reset-code">
|
|
<a href="#endpoints-POSTapi-v1-verify-reset-code">POST api/v1/verify-reset-code</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-password-reset">
|
|
<a href="#endpoints-POSTapi-v1-password-reset">POST api/v1/password-reset</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-default-lang">
|
|
<a href="#endpoints-GETapi-v1-default-lang">GET api/v1/default-lang</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-update-expire-date">
|
|
<a href="#endpoints-GETapi-v1-update-expire-date">GET api/v1/update-expire-date</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-summary">
|
|
<a href="#endpoints-GETapi-v1-summary">GET api/v1/summary</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-dashboard">
|
|
<a href="#endpoints-GETapi-v1-dashboard">GET api/v1/dashboard</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-parties">
|
|
<a href="#endpoints-GETapi-v1-parties">GET api/v1/parties</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-parties">
|
|
<a href="#endpoints-POSTapi-v1-parties">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-parties--id-">
|
|
<a href="#endpoints-GETapi-v1-parties--id-">GET api/v1/parties/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-parties--id-">
|
|
<a href="#endpoints-PUTapi-v1-parties--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-parties--id-">
|
|
<a href="#endpoints-DELETEapi-v1-parties--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-users">
|
|
<a href="#endpoints-GETapi-v1-users">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-users">
|
|
<a href="#endpoints-POSTapi-v1-users">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-users--id-">
|
|
<a href="#endpoints-PUTapi-v1-users--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-users--id-">
|
|
<a href="#endpoints-DELETEapi-v1-users--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-units">
|
|
<a href="#endpoints-GETapi-v1-units">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-units">
|
|
<a href="#endpoints-POSTapi-v1-units">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-units--id-">
|
|
<a href="#endpoints-PUTapi-v1-units--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-units--id-">
|
|
<a href="#endpoints-DELETEapi-v1-units--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-brands">
|
|
<a href="#endpoints-GETapi-v1-brands">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-brands">
|
|
<a href="#endpoints-POSTapi-v1-brands">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-brands--id-">
|
|
<a href="#endpoints-PUTapi-v1-brands--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-brands--id-">
|
|
<a href="#endpoints-DELETEapi-v1-brands--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-categories">
|
|
<a href="#endpoints-GETapi-v1-categories">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-categories">
|
|
<a href="#endpoints-POSTapi-v1-categories">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-categories--id-">
|
|
<a href="#endpoints-PUTapi-v1-categories--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-categories--id-">
|
|
<a href="#endpoints-DELETEapi-v1-categories--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-products">
|
|
<a href="#endpoints-GETapi-v1-products">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-products">
|
|
<a href="#endpoints-POSTapi-v1-products">POST api/v1/products</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-products--id-">
|
|
<a href="#endpoints-GETapi-v1-products--id-">GET api/v1/products/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-products--id-">
|
|
<a href="#endpoints-PUTapi-v1-products--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-products--id-">
|
|
<a href="#endpoints-DELETEapi-v1-products--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-stocks">
|
|
<a href="#endpoints-POSTapi-v1-stocks">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-stocks--id-">
|
|
<a href="#endpoints-PUTapi-v1-stocks--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-stocks--id-">
|
|
<a href="#endpoints-DELETEapi-v1-stocks--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-business">
|
|
<a href="#endpoints-GETapi-v1-business">GET api/v1/business</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-business">
|
|
<a href="#endpoints-POSTapi-v1-business">POST api/v1/business</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-business--id-">
|
|
<a href="#endpoints-PUTapi-v1-business--id-">PUT api/v1/business/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-business-categories">
|
|
<a href="#endpoints-GETapi-v1-business-categories">GET api/v1/business-categories</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-purchase">
|
|
<a href="#endpoints-GETapi-v1-purchase">GET api/v1/purchase</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-purchase">
|
|
<a href="#endpoints-POSTapi-v1-purchase">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-purchase--id-">
|
|
<a href="#endpoints-GETapi-v1-purchase--id-">GET api/v1/purchase/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-purchase--id-">
|
|
<a href="#endpoints-PUTapi-v1-purchase--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-purchase--id-">
|
|
<a href="#endpoints-DELETEapi-v1-purchase--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-sales">
|
|
<a href="#endpoints-GETapi-v1-sales">GET api/v1/sales</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-sales">
|
|
<a href="#endpoints-POSTapi-v1-sales">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-sales--id-">
|
|
<a href="#endpoints-GETapi-v1-sales--id-">GET api/v1/sales/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-sales--id-">
|
|
<a href="#endpoints-PUTapi-v1-sales--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-sales--id-">
|
|
<a href="#endpoints-DELETEapi-v1-sales--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-loss-profit">
|
|
<a href="#endpoints-GETapi-v1-reports-loss-profit">GET api/v1/reports/loss-profit</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-cashflow">
|
|
<a href="#endpoints-GETapi-v1-reports-cashflow">GET api/v1/reports/cashflow</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-balance-sheet">
|
|
<a href="#endpoints-GETapi-v1-reports-balance-sheet">GET api/v1/reports/balance-sheet</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-subscription">
|
|
<a href="#endpoints-GETapi-v1-reports-subscription">GET api/v1/reports/subscription</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-tax">
|
|
<a href="#endpoints-GETapi-v1-reports-tax">GET api/v1/reports/tax</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-bill-wise-profit">
|
|
<a href="#endpoints-GETapi-v1-reports-bill-wise-profit">GET api/v1/reports/bill-wise-profit</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-product-sale-history">
|
|
<a href="#endpoints-GETapi-v1-reports-product-sale-history">GET api/v1/reports/product-sale-history</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-product-sale-history--id-">
|
|
<a href="#endpoints-GETapi-v1-reports-product-sale-history--id-">GET api/v1/reports/product-sale-history/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-product-purchase-history">
|
|
<a href="#endpoints-GETapi-v1-reports-product-purchase-history">GET api/v1/reports/product-purchase-history</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-reports-product-purchase-history--id-">
|
|
<a href="#endpoints-GETapi-v1-reports-product-purchase-history--id-">GET api/v1/reports/product-purchase-history/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-sales-return">
|
|
<a href="#endpoints-GETapi-v1-sales-return">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-sales-return">
|
|
<a href="#endpoints-POSTapi-v1-sales-return">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-sales-return--id-">
|
|
<a href="#endpoints-GETapi-v1-sales-return--id-">GET api/v1/sales-return/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-purchases-return">
|
|
<a href="#endpoints-GETapi-v1-purchases-return">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-purchases-return">
|
|
<a href="#endpoints-POSTapi-v1-purchases-return">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-purchases-return--id-">
|
|
<a href="#endpoints-GETapi-v1-purchases-return--id-">GET api/v1/purchases-return/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-invoices">
|
|
<a href="#endpoints-GETapi-v1-invoices">GET api/v1/invoices</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-dues">
|
|
<a href="#endpoints-GETapi-v1-dues">GET api/v1/dues</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-dues">
|
|
<a href="#endpoints-POSTapi-v1-dues">POST api/v1/dues</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-invoice-wise-dues">
|
|
<a href="#endpoints-GETapi-v1-invoice-wise-dues">GET api/v1/invoice-wise-dues</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-collect-invoice-due">
|
|
<a href="#endpoints-POSTapi-v1-collect-invoice-due">POST api/v1/collect-invoice-due</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-expense-categories">
|
|
<a href="#endpoints-GETapi-v1-expense-categories">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-expense-categories">
|
|
<a href="#endpoints-POSTapi-v1-expense-categories">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-expense-categories--id-">
|
|
<a href="#endpoints-PUTapi-v1-expense-categories--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-expense-categories--id-">
|
|
<a href="#endpoints-DELETEapi-v1-expense-categories--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-expenses">
|
|
<a href="#endpoints-GETapi-v1-expenses">GET api/v1/expenses</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-expenses">
|
|
<a href="#endpoints-POSTapi-v1-expenses">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-income-categories">
|
|
<a href="#endpoints-GETapi-v1-income-categories">GET api/v1/income-categories</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-income-categories">
|
|
<a href="#endpoints-POSTapi-v1-income-categories">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-income-categories--id-">
|
|
<a href="#endpoints-PUTapi-v1-income-categories--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-income-categories--id-">
|
|
<a href="#endpoints-DELETEapi-v1-income-categories--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-incomes">
|
|
<a href="#endpoints-GETapi-v1-incomes">GET api/v1/incomes</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-incomes">
|
|
<a href="#endpoints-POSTapi-v1-incomes">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-banners">
|
|
<a href="#endpoints-GETapi-v1-banners">GET api/v1/banners</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-lang">
|
|
<a href="#endpoints-GETapi-v1-lang">GET api/v1/lang</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-lang">
|
|
<a href="#endpoints-POSTapi-v1-lang">POST api/v1/lang</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-profile">
|
|
<a href="#endpoints-GETapi-v1-profile">GET api/v1/profile</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-profile">
|
|
<a href="#endpoints-POSTapi-v1-profile">POST api/v1/profile</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-plans">
|
|
<a href="#endpoints-GETapi-v1-plans">GET api/v1/plans</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-subscribes">
|
|
<a href="#endpoints-GETapi-v1-subscribes">GET api/v1/subscribes</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-currencies">
|
|
<a href="#endpoints-GETapi-v1-currencies">GET api/v1/currencies</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-currencies--id-">
|
|
<a href="#endpoints-GETapi-v1-currencies--id-">GET api/v1/currencies/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-vats">
|
|
<a href="#endpoints-GETapi-v1-vats">GET api/v1/vats</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-vats">
|
|
<a href="#endpoints-POSTapi-v1-vats">POST api/v1/vats</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-vats--id-">
|
|
<a href="#endpoints-PUTapi-v1-vats--id-">PUT api/v1/vats/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-vats--id-">
|
|
<a href="#endpoints-DELETEapi-v1-vats--id-">DELETE api/v1/vats/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-payment-types">
|
|
<a href="#endpoints-GETapi-v1-payment-types">GET api/v1/payment-types</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-payment-types">
|
|
<a href="#endpoints-POSTapi-v1-payment-types">POST api/v1/payment-types</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-payment-types--id-">
|
|
<a href="#endpoints-PUTapi-v1-payment-types--id-">PUT api/v1/payment-types/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-payment-types--id-">
|
|
<a href="#endpoints-DELETEapi-v1-payment-types--id-">DELETE api/v1/payment-types/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-product-models">
|
|
<a href="#endpoints-GETapi-v1-product-models">GET api/v1/product-models</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-product-models">
|
|
<a href="#endpoints-POSTapi-v1-product-models">POST api/v1/product-models</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-product-models--id-">
|
|
<a href="#endpoints-PUTapi-v1-product-models--id-">PUT api/v1/product-models/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-product-models--id-">
|
|
<a href="#endpoints-DELETEapi-v1-product-models--id-">DELETE api/v1/product-models/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-variations">
|
|
<a href="#endpoints-GETapi-v1-variations">GET api/v1/variations</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-variations">
|
|
<a href="#endpoints-POSTapi-v1-variations">POST api/v1/variations</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-variations--id-">
|
|
<a href="#endpoints-PUTapi-v1-variations--id-">PUT api/v1/variations/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-variations--id-">
|
|
<a href="#endpoints-DELETEapi-v1-variations--id-">DELETE api/v1/variations/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-racks">
|
|
<a href="#endpoints-GETapi-v1-racks">GET api/v1/racks</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-racks">
|
|
<a href="#endpoints-POSTapi-v1-racks">POST api/v1/racks</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-racks--id-">
|
|
<a href="#endpoints-PUTapi-v1-racks--id-">PUT api/v1/racks/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-racks--id-">
|
|
<a href="#endpoints-DELETEapi-v1-racks--id-">DELETE api/v1/racks/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-shelfs">
|
|
<a href="#endpoints-GETapi-v1-shelfs">GET api/v1/shelfs</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-shelfs">
|
|
<a href="#endpoints-POSTapi-v1-shelfs">POST api/v1/shelfs</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-shelfs--id-">
|
|
<a href="#endpoints-PUTapi-v1-shelfs--id-">PUT api/v1/shelfs/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-shelfs--id-">
|
|
<a href="#endpoints-DELETEapi-v1-shelfs--id-">DELETE api/v1/shelfs/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-banks">
|
|
<a href="#endpoints-GETapi-v1-banks">GET api/v1/banks</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-banks">
|
|
<a href="#endpoints-POSTapi-v1-banks">POST api/v1/banks</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-banks--id-">
|
|
<a href="#endpoints-GETapi-v1-banks--id-">GET api/v1/banks/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-banks--id-">
|
|
<a href="#endpoints-PUTapi-v1-banks--id-">PUT api/v1/banks/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-banks--id-">
|
|
<a href="#endpoints-DELETEapi-v1-banks--id-">DELETE api/v1/banks/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-bank-transactions">
|
|
<a href="#endpoints-GETapi-v1-bank-transactions">GET api/v1/bank-transactions</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-bank-transactions">
|
|
<a href="#endpoints-POSTapi-v1-bank-transactions">POST api/v1/bank-transactions</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-bank-transactions--id-">
|
|
<a href="#endpoints-GETapi-v1-bank-transactions--id-">GET api/v1/bank-transactions/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-bank-transactions--id-">
|
|
<a href="#endpoints-PUTapi-v1-bank-transactions--id-">PUT api/v1/bank-transactions/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-bank-transactions--id-">
|
|
<a href="#endpoints-DELETEapi-v1-bank-transactions--id-">DELETE api/v1/bank-transactions/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-cashes">
|
|
<a href="#endpoints-GETapi-v1-cashes">GET api/v1/cashes</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-cashes">
|
|
<a href="#endpoints-POSTapi-v1-cashes">POST api/v1/cashes</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-cashes--id-">
|
|
<a href="#endpoints-GETapi-v1-cashes--id-">GET api/v1/cashes/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-cashes--id-">
|
|
<a href="#endpoints-PUTapi-v1-cashes--id-">PUT api/v1/cashes/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-cashes--id-">
|
|
<a href="#endpoints-DELETEapi-v1-cashes--id-">DELETE api/v1/cashes/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-cheques">
|
|
<a href="#endpoints-GETapi-v1-cheques">GET api/v1/cheques</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-cheques">
|
|
<a href="#endpoints-POSTapi-v1-cheques">POST api/v1/cheques</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-cheques--id-">
|
|
<a href="#endpoints-GETapi-v1-cheques--id-">GET api/v1/cheques/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-cheque-reopen--id-">
|
|
<a href="#endpoints-POSTapi-v1-cheque-reopen--id-">POST api/v1/cheque-reopen/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-product-settings">
|
|
<a href="#endpoints-GETapi-v1-product-settings">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-product-settings">
|
|
<a href="#endpoints-POSTapi-v1-product-settings">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-product-generate-code">
|
|
<a href="#endpoints-GETapi-v1-product-generate-code">GET api/v1/product/generate-code</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-bulk-uploads">
|
|
<a href="#endpoints-POSTapi-v1-bulk-uploads">POST api/v1/bulk-uploads</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-change-password">
|
|
<a href="#endpoints-POSTapi-v1-change-password">POST api/v1/change-password</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-new-invoice">
|
|
<a href="#endpoints-GETapi-v1-new-invoice">GET api/v1/new-invoice</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-invoice-settings">
|
|
<a href="#endpoints-GETapi-v1-invoice-settings">GET api/v1/invoice-settings</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-invoice-settings-update">
|
|
<a href="#endpoints-POSTapi-v1-invoice-settings-update">POST api/v1/invoice-settings/update</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-business-delete">
|
|
<a href="#endpoints-POSTapi-v1-business-delete">POST api/v1/business-delete</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-party-ledger--party_id-">
|
|
<a href="#endpoints-GETapi-v1-party-ledger--party_id-">GET api/v1/party-ledger/{party_id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-money-receipt--id-">
|
|
<a href="#endpoints-GETapi-v1-money-receipt--id-">GET api/v1/money-receipt/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-currency-settings">
|
|
<a href="#endpoints-GETapi-v1-currency-settings">GET api/v1/currency-settings</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-currency-settings">
|
|
<a href="#endpoints-POSTapi-v1-currency-settings">POST api/v1/currency-settings</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-transactions">
|
|
<a href="#endpoints-GETapi-v1-transactions">GET api/v1/transactions</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-sign-out">
|
|
<a href="#endpoints-GETapi-v1-sign-out">GET api/v1/sign-out</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-refresh-token">
|
|
<a href="#endpoints-GETapi-v1-refresh-token">GET api/v1/refresh-token</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-branches">
|
|
<a href="#endpoints-GETapi-v1-branches">Display a listing of the resource.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-branches">
|
|
<a href="#endpoints-POSTapi-v1-branches">Store a newly created resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-branches--id-">
|
|
<a href="#endpoints-PUTapi-v1-branches--id-">Update the specified resource in storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-branches--id-">
|
|
<a href="#endpoints-DELETEapi-v1-branches--id-">Remove the specified resource from storage.</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-switch-branch--id-">
|
|
<a href="#endpoints-GETapi-v1-switch-branch--id-">GET api/v1/switch-branch/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-exit-branch--id-">
|
|
<a href="#endpoints-GETapi-v1-exit-branch--id-">GET api/v1/exit-branch/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-GETapi-v1-warehouses">
|
|
<a href="#endpoints-GETapi-v1-warehouses">GET api/v1/warehouses</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-POSTapi-v1-warehouses">
|
|
<a href="#endpoints-POSTapi-v1-warehouses">POST api/v1/warehouses</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-PUTapi-v1-warehouses--id-">
|
|
<a href="#endpoints-PUTapi-v1-warehouses--id-">PUT api/v1/warehouses/{id}</a>
|
|
</li>
|
|
<li class="tocify-item level-2" data-unique="endpoints-DELETEapi-v1-warehouses--id-">
|
|
<a href="#endpoints-DELETEapi-v1-warehouses--id-">DELETE api/v1/warehouses/{id}</a>
|
|
</li>
|
|
</ul>
|
|
</ul>
|
|
</div>
|
|
|
|
<ul class="toc-footer" id="toc-footer">
|
|
<li style="padding-bottom: 5px;"><a href="{{ route("scribe.postman") }}">View Postman collection</a></li>
|
|
<li style="padding-bottom: 5px;"><a href="{{ route("scribe.openapi") }}">View OpenAPI spec</a></li>
|
|
<li><a href="http://github.com/knuckleswtf/scribe">Documentation powered by Scribe ✍</a></li>
|
|
</ul>
|
|
|
|
<ul class="toc-footer" id="last-updated">
|
|
<li>Last updated: April 25, 2026</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="page-wrapper">
|
|
<div class="dark-box"></div>
|
|
<div class="content">
|
|
<h1 id="introduction">Introduction</h1>
|
|
<aside>
|
|
<strong>Base URL</strong>: <code>http://localhost:8080</code>
|
|
</aside>
|
|
<pre><code>This documentation aims to provide all the information you need to work with our API.
|
|
|
|
<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
|
|
You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside></code></pre>
|
|
|
|
<h1 id="authenticating-requests">Authenticating requests</h1>
|
|
<p>This API is not authenticated.</p>
|
|
|
|
<h1 id="endpoints">Endpoints</h1>
|
|
|
|
|
|
|
|
<h2 id="endpoints-GETapi-v1-module-check">GET api/v1/module-check</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-module-check">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/module-check" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/module-check"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-module-check">
|
|
<blockquote>
|
|
<p>Example response (500):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
x-ratelimit-limit: 100
|
|
x-ratelimit-remaining: 99
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Server Error"
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-module-check" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-module-check"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-module-check"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-module-check" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-module-check">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-module-check" data-method="GET"
|
|
data-path="api/v1/module-check"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-module-check', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-module-check"
|
|
onclick="tryItOut('GETapi-v1-module-check');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-module-check"
|
|
onclick="cancelTryOut('GETapi-v1-module-check');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-module-check"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/module-check</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-module-check"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-module-check"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-sign-in">POST api/v1/sign-in</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-sign-in">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/sign-in" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"password\": \"consequatur\",
|
|
\"email\": \"carolyne.luettgen@example.org\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sign-in"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"password": "consequatur",
|
|
"email": "carolyne.luettgen@example.org"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-sign-in">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-sign-in" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-sign-in"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-sign-in"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-sign-in" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-sign-in">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-sign-in" data-method="POST"
|
|
data-path="api/v1/sign-in"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-sign-in', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-sign-in"
|
|
onclick="tryItOut('POSTapi-v1-sign-in');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-sign-in"
|
|
onclick="cancelTryOut('POSTapi-v1-sign-in');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-sign-in"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/sign-in</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-sign-in"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-sign-in"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>password</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="password" data-endpoint="POSTapi-v1-sign-in"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-sign-in"
|
|
value="carolyne.luettgen@example.org"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Example: <code>carolyne.luettgen@example.org</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-submit-otp">POST api/v1/submit-otp</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-submit-otp">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/submit-otp" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"email\": \"qkunze@example.com\",
|
|
\"otp\": \"opfuudtdsufvy\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/submit-otp"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"email": "qkunze@example.com",
|
|
"otp": "opfuudtdsufvy"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-submit-otp">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-submit-otp" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-submit-otp"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-submit-otp"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-submit-otp" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-submit-otp">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-submit-otp" data-method="POST"
|
|
data-path="api/v1/submit-otp"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-submit-otp', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-submit-otp"
|
|
onclick="tryItOut('POSTapi-v1-submit-otp');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-submit-otp"
|
|
onclick="cancelTryOut('POSTapi-v1-submit-otp');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-submit-otp"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/submit-otp</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-submit-otp"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-submit-otp"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-submit-otp"
|
|
value="qkunze@example.com"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Example: <code>qkunze@example.com</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>otp</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="otp" data-endpoint="POSTapi-v1-submit-otp"
|
|
value="opfuudtdsufvy"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 4 characters. Must not be greater than 15 characters. Example: <code>opfuudtdsufvy</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-sign-up">POST api/v1/sign-up</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-sign-up">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/sign-up" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"password\": \"OP>@;4\",
|
|
\"email\": \"kacey94@example.org\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sign-up"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"password": "OP>@;4",
|
|
"email": "kacey94@example.org"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-sign-up">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-sign-up" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-sign-up"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-sign-up"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-sign-up" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-sign-up">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-sign-up" data-method="POST"
|
|
data-path="api/v1/sign-up"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-sign-up', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-sign-up"
|
|
onclick="tryItOut('POSTapi-v1-sign-up');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-sign-up"
|
|
onclick="cancelTryOut('POSTapi-v1-sign-up');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-sign-up"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/sign-up</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-sign-up"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-sign-up"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-sign-up"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>password</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="password" data-endpoint="POSTapi-v1-sign-up"
|
|
value="OP>@;4"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 6 characters. Must not be greater than 100 characters. Example: <code>OP>@;4</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-sign-up"
|
|
value="kacey94@example.org"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Example: <code>kacey94@example.org</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-resend-otp">POST api/v1/resend-otp</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-resend-otp">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/resend-otp" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"email\": \"qkunze@example.com\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/resend-otp"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"email": "qkunze@example.com"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-resend-otp">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-resend-otp" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-resend-otp"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-resend-otp"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-resend-otp" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-resend-otp">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-resend-otp" data-method="POST"
|
|
data-path="api/v1/resend-otp"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-resend-otp', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-resend-otp"
|
|
onclick="tryItOut('POSTapi-v1-resend-otp');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-resend-otp"
|
|
onclick="cancelTryOut('POSTapi-v1-resend-otp');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-resend-otp"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/resend-otp</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-resend-otp"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-resend-otp"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-resend-otp"
|
|
value="qkunze@example.com"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. The <code>email</code> of an existing record in the users table. Example: <code>qkunze@example.com</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-otp-settings">GET api/v1/otp-settings</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-otp-settings">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/otp-settings" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/otp-settings"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-otp-settings">
|
|
<blockquote>
|
|
<p>Example response (200):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
x-ratelimit-limit: 100
|
|
x-ratelimit-remaining: 98
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Data fetched successfully.",
|
|
"data": []
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-otp-settings" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-otp-settings"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-otp-settings"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-otp-settings" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-otp-settings">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-otp-settings" data-method="GET"
|
|
data-path="api/v1/otp-settings"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-otp-settings', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-otp-settings"
|
|
onclick="tryItOut('GETapi-v1-otp-settings');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-otp-settings"
|
|
onclick="cancelTryOut('GETapi-v1-otp-settings');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-otp-settings"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/otp-settings</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-otp-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-otp-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-send-reset-code">POST api/v1/send-reset-code</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-send-reset-code">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/send-reset-code" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"email\": \"qkunze@example.com\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/send-reset-code"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"email": "qkunze@example.com"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-send-reset-code">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-send-reset-code" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-send-reset-code"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-send-reset-code"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-send-reset-code" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-send-reset-code">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-send-reset-code" data-method="POST"
|
|
data-path="api/v1/send-reset-code"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-send-reset-code', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-send-reset-code"
|
|
onclick="tryItOut('POSTapi-v1-send-reset-code');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-send-reset-code"
|
|
onclick="cancelTryOut('POSTapi-v1-send-reset-code');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-send-reset-code"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/send-reset-code</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-send-reset-code"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-send-reset-code"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-send-reset-code"
|
|
value="qkunze@example.com"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. The <code>email</code> of an existing record in the users table. Example: <code>qkunze@example.com</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-verify-reset-code">POST api/v1/verify-reset-code</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-verify-reset-code">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/verify-reset-code" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"code\": 17,
|
|
\"email\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/verify-reset-code"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"code": 17,
|
|
"email": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-verify-reset-code">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-verify-reset-code" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-verify-reset-code"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-verify-reset-code"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-verify-reset-code" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-verify-reset-code">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-verify-reset-code" data-method="POST"
|
|
data-path="api/v1/verify-reset-code"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-verify-reset-code', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-verify-reset-code"
|
|
onclick="tryItOut('POSTapi-v1-verify-reset-code');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-verify-reset-code"
|
|
onclick="cancelTryOut('POSTapi-v1-verify-reset-code');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-verify-reset-code"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/verify-reset-code</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-verify-reset-code"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-verify-reset-code"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>code</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="code" data-endpoint="POSTapi-v1-verify-reset-code"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-verify-reset-code"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>email</code> of an existing record in the users table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-password-reset">POST api/v1/password-reset</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-password-reset">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/password-reset" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"email\": \"consequatur\",
|
|
\"password\": \"[2UZ5ij-e\\/dl4\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/password-reset"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"email": "consequatur",
|
|
"password": "[2UZ5ij-e\/dl4"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-password-reset">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-password-reset" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-password-reset"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-password-reset"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-password-reset" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-password-reset">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-password-reset" data-method="POST"
|
|
data-path="api/v1/password-reset"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-password-reset', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-password-reset"
|
|
onclick="tryItOut('POSTapi-v1-password-reset');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-password-reset"
|
|
onclick="cancelTryOut('POSTapi-v1-password-reset');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-password-reset"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/password-reset</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-password-reset"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-password-reset"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-password-reset"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>email</code> of an existing record in the users table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>password</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="password" data-endpoint="POSTapi-v1-password-reset"
|
|
value="[2UZ5ij-e/dl4"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 4 characters. Example: <code>[2UZ5ij-e/dl4</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-default-lang">GET api/v1/default-lang</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-default-lang">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/default-lang" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/default-lang"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-default-lang">
|
|
<blockquote>
|
|
<p>Example response (200):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
x-ratelimit-limit: 100
|
|
x-ratelimit-remaining: 97
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Data fetched successfully.",
|
|
"data": ""
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-default-lang" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-default-lang"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-default-lang"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-default-lang" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-default-lang">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-default-lang" data-method="GET"
|
|
data-path="api/v1/default-lang"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-default-lang', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-default-lang"
|
|
onclick="tryItOut('GETapi-v1-default-lang');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-default-lang"
|
|
onclick="cancelTryOut('GETapi-v1-default-lang');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-default-lang"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/default-lang</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-default-lang"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-default-lang"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-update-expire-date">GET api/v1/update-expire-date</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-update-expire-date">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/update-expire-date" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/update-expire-date"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-update-expire-date">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-update-expire-date" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-update-expire-date"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-update-expire-date"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-update-expire-date" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-update-expire-date">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-update-expire-date" data-method="GET"
|
|
data-path="api/v1/update-expire-date"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-update-expire-date', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-update-expire-date"
|
|
onclick="tryItOut('GETapi-v1-update-expire-date');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-update-expire-date"
|
|
onclick="cancelTryOut('GETapi-v1-update-expire-date');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-update-expire-date"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/update-expire-date</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-update-expire-date"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-update-expire-date"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-summary">GET api/v1/summary</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-summary">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/summary" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/summary"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-summary">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-summary" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-summary"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-summary"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-summary" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-summary">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-summary" data-method="GET"
|
|
data-path="api/v1/summary"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-summary', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-summary"
|
|
onclick="tryItOut('GETapi-v1-summary');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-summary"
|
|
onclick="cancelTryOut('GETapi-v1-summary');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-summary"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/summary</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-summary"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-summary"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-dashboard">GET api/v1/dashboard</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-dashboard">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/dashboard" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/dashboard"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-dashboard">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-dashboard" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-dashboard"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-dashboard"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-dashboard" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-dashboard">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-dashboard" data-method="GET"
|
|
data-path="api/v1/dashboard"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-dashboard', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-dashboard"
|
|
onclick="tryItOut('GETapi-v1-dashboard');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-dashboard"
|
|
onclick="cancelTryOut('GETapi-v1-dashboard');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-dashboard"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/dashboard</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-dashboard"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-dashboard"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-parties">GET api/v1/parties</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-parties">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/parties" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/parties"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-parties">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-parties" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-parties"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-parties"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-parties" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-parties">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-parties" data-method="GET"
|
|
data-path="api/v1/parties"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-parties', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-parties"
|
|
onclick="tryItOut('GETapi-v1-parties');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-parties"
|
|
onclick="cancelTryOut('GETapi-v1-parties');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-parties"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/parties</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-parties"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-parties"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-parties">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-parties">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/parties" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "name=vmqeopfuudtdsufvyvddq"\
|
|
--form "type=Retailer"\
|
|
--form "address=vmqeopfuudtdsufvyvddq"\
|
|
--form "credit_limit=1"\
|
|
--form "opening_balance=13"\
|
|
--form "opening_balance_type=due"\
|
|
--form "image=@/tmp/phpidPlHn" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/parties"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('name', 'vmqeopfuudtdsufvyvddq');
|
|
body.append('type', 'Retailer');
|
|
body.append('address', 'vmqeopfuudtdsufvyvddq');
|
|
body.append('credit_limit', '1');
|
|
body.append('opening_balance', '13');
|
|
body.append('opening_balance_type', 'due');
|
|
body.append('image', document.querySelector('input[name="image"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-parties">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-parties" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-parties"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-parties"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-parties" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-parties">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-parties" data-method="POST"
|
|
data-path="api/v1/parties"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-parties', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-parties"
|
|
onclick="tryItOut('POSTapi-v1-parties');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-parties"
|
|
onclick="cancelTryOut('POSTapi-v1-parties');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-parties"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/parties</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-parties"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-parties"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-parties"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="type" data-endpoint="POSTapi-v1-parties"
|
|
value="Retailer"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>Retailer</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>Retailer</code></li> <li><code>Dealer</code></li> <li><code>Wholesaler</code></li> <li><code>Supplier</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>phone</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="phone" data-endpoint="POSTapi-v1-parties"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>image</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="image" data-endpoint="POSTapi-v1-parties"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phpidPlHn</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>address</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="address" data-endpoint="POSTapi-v1-parties"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>credit_limit</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="credit_limit" data-endpoint="POSTapi-v1-parties"
|
|
value="1"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 999999999999.99. Example: <code>1</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>opening_balance</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="opening_balance" data-endpoint="POSTapi-v1-parties"
|
|
value="13"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least -999999999999.99. Must not be greater than 999999999999.99. Example: <code>13</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>opening_balance_type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="opening_balance_type" data-endpoint="POSTapi-v1-parties"
|
|
value="due"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>due</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>due</code></li> <li><code>advance</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-parties--id-">GET api/v1/parties/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-parties--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/parties/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/parties/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-parties--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-parties--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-parties--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-parties--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-parties--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-parties--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-parties--id-" data-method="GET"
|
|
data-path="api/v1/parties/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-parties--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-parties--id-"
|
|
onclick="tryItOut('GETapi-v1-parties--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-parties--id-"
|
|
onclick="cancelTryOut('GETapi-v1-parties--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-parties--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/parties/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-parties--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-parties--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="GETapi-v1-parties--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the party. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-parties--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-parties--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/parties/17" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "name=vmqeopfuudtdsufvyvddq"\
|
|
--form "type=Retailer"\
|
|
--form "address=vmqeopfuudtdsufvyvddq"\
|
|
--form "credit_limit=1"\
|
|
--form "opening_balance=13"\
|
|
--form "opening_balance_type=due"\
|
|
--form "image=@/tmp/phpNhnJln" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/parties/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('name', 'vmqeopfuudtdsufvyvddq');
|
|
body.append('type', 'Retailer');
|
|
body.append('address', 'vmqeopfuudtdsufvyvddq');
|
|
body.append('credit_limit', '1');
|
|
body.append('opening_balance', '13');
|
|
body.append('opening_balance_type', 'due');
|
|
body.append('image', document.querySelector('input[name="image"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-parties--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-parties--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-parties--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-parties--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-parties--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-parties--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-parties--id-" data-method="PUT"
|
|
data-path="api/v1/parties/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-parties--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-parties--id-"
|
|
onclick="tryItOut('PUTapi-v1-parties--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-parties--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-parties--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-parties--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/parties/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/parties/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-parties--id-"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-parties--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-parties--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the party. Example: <code>17</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-parties--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="type" data-endpoint="PUTapi-v1-parties--id-"
|
|
value="Retailer"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>Retailer</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>Retailer</code></li> <li><code>Dealer</code></li> <li><code>Wholesaler</code></li> <li><code>Supplier</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>phone</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="phone" data-endpoint="PUTapi-v1-parties--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>image</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="image" data-endpoint="PUTapi-v1-parties--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phpNhnJln</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>address</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="address" data-endpoint="PUTapi-v1-parties--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>credit_limit</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="credit_limit" data-endpoint="PUTapi-v1-parties--id-"
|
|
value="1"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 999999999999.99. Example: <code>1</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>opening_balance</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="opening_balance" data-endpoint="PUTapi-v1-parties--id-"
|
|
value="13"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least -999999999999.99. Must not be greater than 999999999999.99. Example: <code>13</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>opening_balance_type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="opening_balance_type" data-endpoint="PUTapi-v1-parties--id-"
|
|
value="due"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>due</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>due</code></li> <li><code>advance</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-parties--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-parties--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/parties/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/parties/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-parties--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-parties--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-parties--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-parties--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-parties--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-parties--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-parties--id-" data-method="DELETE"
|
|
data-path="api/v1/parties/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-parties--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-parties--id-"
|
|
onclick="tryItOut('DELETEapi-v1-parties--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-parties--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-parties--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-parties--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/parties/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-parties--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-parties--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-parties--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the party. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-users">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-users">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/users" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/users"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-users">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-users" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-users"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-users"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-users" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-users">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-users" data-method="GET"
|
|
data-path="api/v1/users"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-users', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-users"
|
|
onclick="tryItOut('GETapi-v1-users');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-users"
|
|
onclick="cancelTryOut('GETapi-v1-users');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-users"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/users</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-users"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-users"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-users">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-users">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/users" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"password\": \"OP>@;4\",
|
|
\"email\": \"kacey94@example.org\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/users"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"password": "OP>@;4",
|
|
"email": "kacey94@example.org"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-users">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-users" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-users"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-users"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-users" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-users">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-users" data-method="POST"
|
|
data-path="api/v1/users"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-users', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-users"
|
|
onclick="tryItOut('POSTapi-v1-users');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-users"
|
|
onclick="cancelTryOut('POSTapi-v1-users');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-users"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/users</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-users"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-users"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-users"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 30 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>password</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="password" data-endpoint="POSTapi-v1-users"
|
|
value="OP>@;4"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 4 characters. Must not be greater than 15 characters. Example: <code>OP>@;4</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-users"
|
|
value="kacey94@example.org"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Example: <code>kacey94@example.org</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>branch_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="branch_id" data-endpoint="POSTapi-v1-users"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the branches table.</p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-users--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-users--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/users/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"password\": \"OP>@;4\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/users/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"password": "OP>@;4"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-users--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-users--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-users--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-users--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-users--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-users--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-users--id-" data-method="PUT"
|
|
data-path="api/v1/users/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-users--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-users--id-"
|
|
onclick="tryItOut('PUTapi-v1-users--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-users--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-users--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-users--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/users/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/users/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-users--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-users--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-users--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the user. Example: <code>17</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-users--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 30 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>password</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="password" data-endpoint="PUTapi-v1-users--id-"
|
|
value="OP>@;4"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 4 characters. Must not be greater than 15 characters. Example: <code>OP>@;4</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>branch_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="branch_id" data-endpoint="PUTapi-v1-users--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the branches table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="PUTapi-v1-users--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-users--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-users--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/users/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/users/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-users--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-users--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-users--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-users--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-users--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-users--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-users--id-" data-method="DELETE"
|
|
data-path="api/v1/users/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-users--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-users--id-"
|
|
onclick="tryItOut('DELETEapi-v1-users--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-users--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-users--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-users--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/users/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-users--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-users--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-users--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the user. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-units">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-units">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/units" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/units"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-units">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-units" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-units"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-units"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-units" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-units">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-units" data-method="GET"
|
|
data-path="api/v1/units"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-units', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-units"
|
|
onclick="tryItOut('GETapi-v1-units');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-units"
|
|
onclick="cancelTryOut('GETapi-v1-units');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-units"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/units</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-units"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-units"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-units">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-units">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/units" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/units"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-units">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-units" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-units"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-units"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-units" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-units">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-units" data-method="POST"
|
|
data-path="api/v1/units"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-units', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-units"
|
|
onclick="tryItOut('POSTapi-v1-units');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-units"
|
|
onclick="cancelTryOut('POSTapi-v1-units');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-units"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/units</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-units"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-units"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>unitName</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="unitName" data-endpoint="POSTapi-v1-units"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-units--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-units--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/units/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"unitName\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/units/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"unitName": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-units--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-units--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-units--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-units--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-units--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-units--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-units--id-" data-method="PUT"
|
|
data-path="api/v1/units/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-units--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-units--id-"
|
|
onclick="tryItOut('PUTapi-v1-units--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-units--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-units--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-units--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/units/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/units/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-units--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-units--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-units--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the unit. Example: <code>17</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>unitName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="unitName" data-endpoint="PUTapi-v1-units--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-units--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-units--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/units/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/units/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-units--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-units--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-units--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-units--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-units--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-units--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-units--id-" data-method="DELETE"
|
|
data-path="api/v1/units/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-units--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-units--id-"
|
|
onclick="tryItOut('DELETEapi-v1-units--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-units--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-units--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-units--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/units/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-units--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-units--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-units--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the unit. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-brands">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-brands">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/brands" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/brands"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-brands">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-brands" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-brands"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-brands"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-brands" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-brands">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-brands" data-method="GET"
|
|
data-path="api/v1/brands"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-brands', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-brands"
|
|
onclick="tryItOut('GETapi-v1-brands');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-brands"
|
|
onclick="cancelTryOut('GETapi-v1-brands');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-brands"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/brands</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-brands"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-brands"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-brands">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-brands">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/brands" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/brands"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-brands">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-brands" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-brands"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-brands"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-brands" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-brands">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-brands" data-method="POST"
|
|
data-path="api/v1/brands"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-brands', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-brands"
|
|
onclick="tryItOut('POSTapi-v1-brands');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-brands"
|
|
onclick="cancelTryOut('POSTapi-v1-brands');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-brands"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/brands</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-brands"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-brands"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>brandName</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="brandName" data-endpoint="POSTapi-v1-brands"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-brands--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-brands--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/brands/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"brandName\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/brands/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"brandName": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-brands--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-brands--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-brands--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-brands--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-brands--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-brands--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-brands--id-" data-method="PUT"
|
|
data-path="api/v1/brands/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-brands--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-brands--id-"
|
|
onclick="tryItOut('PUTapi-v1-brands--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-brands--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-brands--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-brands--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/brands/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/brands/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-brands--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-brands--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-brands--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the brand. Example: <code>17</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>brandName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="brandName" data-endpoint="PUTapi-v1-brands--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-brands--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-brands--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/brands/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/brands/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-brands--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-brands--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-brands--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-brands--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-brands--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-brands--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-brands--id-" data-method="DELETE"
|
|
data-path="api/v1/brands/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-brands--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-brands--id-"
|
|
onclick="tryItOut('DELETEapi-v1-brands--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-brands--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-brands--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-brands--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/brands/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-brands--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-brands--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-brands--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the brand. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-categories">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-categories">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/categories" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/categories"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-categories">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-categories" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-categories"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-categories"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-categories" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-categories">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-categories" data-method="GET"
|
|
data-path="api/v1/categories"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-categories', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-categories"
|
|
onclick="tryItOut('GETapi-v1-categories');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-categories"
|
|
onclick="cancelTryOut('GETapi-v1-categories');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-categories"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/categories</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-categories">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-categories">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/categories" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/categories"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-categories">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-categories" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-categories"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-categories"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-categories" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-categories">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-categories" data-method="POST"
|
|
data-path="api/v1/categories"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-categories', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-categories"
|
|
onclick="tryItOut('POSTapi-v1-categories');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-categories"
|
|
onclick="cancelTryOut('POSTapi-v1-categories');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-categories"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/categories</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>categoryName</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="categoryName" data-endpoint="POSTapi-v1-categories"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-categories--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-categories--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/categories/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"categoryName\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/categories/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"categoryName": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-categories--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-categories--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-categories--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-categories--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-categories--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-categories--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-categories--id-" data-method="PUT"
|
|
data-path="api/v1/categories/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-categories--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-categories--id-"
|
|
onclick="tryItOut('PUTapi-v1-categories--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-categories--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-categories--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-categories--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/categories/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/categories/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-categories--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the category. Example: <code>17</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>categoryName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="categoryName" data-endpoint="PUTapi-v1-categories--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-categories--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-categories--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/categories/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/categories/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-categories--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-categories--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-categories--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-categories--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-categories--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-categories--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-categories--id-" data-method="DELETE"
|
|
data-path="api/v1/categories/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-categories--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-categories--id-"
|
|
onclick="tryItOut('DELETEapi-v1-categories--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-categories--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-categories--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-categories--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/categories/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-categories--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the category. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-products">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-products">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/products" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/products"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-products">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-products" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-products"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-products"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-products" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-products">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-products" data-method="GET"
|
|
data-path="api/v1/products"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-products', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-products"
|
|
onclick="tryItOut('GETapi-v1-products');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-products"
|
|
onclick="cancelTryOut('GETapi-v1-products');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-products"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/products</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-products"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-products"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-products">POST api/v1/products</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-products">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/products" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "vat_type=exclusive"\
|
|
--form "productName=mqeopfuudtdsufvyvddqa"\
|
|
--form "alert_qty=73"\
|
|
--form "size=mqeopfuudtdsufvyvddqa"\
|
|
--form "type=mniihfqcoynlazghdtqtq"\
|
|
--form "color=xbajwbpilpmufinllwloa"\
|
|
--form "weight=uydlsmsjuryvojcybzvrb"\
|
|
--form "capacity=yickznkygloigmkwxphlv"\
|
|
--form "productManufacturer=azjrcnfbaqywuxhgjjmzu"\
|
|
--form "product_type=variant"\
|
|
--form "stocks[][productStock]=10"\
|
|
--form "stocks[][exclusive_price]=20"\
|
|
--form "stocks[][inclusive_price]=2"\
|
|
--form "stocks[][profit_percent]=16"\
|
|
--form "stocks[][productSalePrice]=14"\
|
|
--form "stocks[][productWholeSalePrice]=20"\
|
|
--form "stocks[][productDealerPrice]=25"\
|
|
--form "stocks[][mfg_date]=2026-04-25T14:39:34"\
|
|
--form "stocks[][expire_date]=2107-05-25"\
|
|
--form "combo_products[][quantity]=45"\
|
|
--form "productPicture=@/tmp/phpIlpNJB" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/products"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('vat_type', 'exclusive');
|
|
body.append('productName', 'mqeopfuudtdsufvyvddqa');
|
|
body.append('alert_qty', '73');
|
|
body.append('size', 'mqeopfuudtdsufvyvddqa');
|
|
body.append('type', 'mniihfqcoynlazghdtqtq');
|
|
body.append('color', 'xbajwbpilpmufinllwloa');
|
|
body.append('weight', 'uydlsmsjuryvojcybzvrb');
|
|
body.append('capacity', 'yickznkygloigmkwxphlv');
|
|
body.append('productManufacturer', 'azjrcnfbaqywuxhgjjmzu');
|
|
body.append('product_type', 'variant');
|
|
body.append('stocks[][productStock]', '10');
|
|
body.append('stocks[][exclusive_price]', '20');
|
|
body.append('stocks[][inclusive_price]', '2');
|
|
body.append('stocks[][profit_percent]', '16');
|
|
body.append('stocks[][productSalePrice]', '14');
|
|
body.append('stocks[][productWholeSalePrice]', '20');
|
|
body.append('stocks[][productDealerPrice]', '25');
|
|
body.append('stocks[][mfg_date]', '2026-04-25T14:39:34');
|
|
body.append('stocks[][expire_date]', '2107-05-25');
|
|
body.append('combo_products[][quantity]', '45');
|
|
body.append('productPicture', document.querySelector('input[name="productPicture"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-products">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-products" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-products"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-products"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-products" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-products">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-products" data-method="POST"
|
|
data-path="api/v1/products"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-products', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-products"
|
|
onclick="tryItOut('POSTapi-v1-products');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-products"
|
|
onclick="cancelTryOut('POSTapi-v1-products');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-products"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/products</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-products"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-products"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>vat_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="vat_id" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the vats table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>unit_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="unit_id" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the units table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>brand_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="brand_id" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the brands table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>category_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="category_id" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the categories table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>model_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="model_id" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the product_models table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>vat_type</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="vat_type" data-endpoint="POSTapi-v1-products"
|
|
value="exclusive"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>exclusive</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>inclusive</code></li> <li><code>exclusive</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="productName" data-endpoint="POSTapi-v1-products"
|
|
value="mqeopfuudtdsufvyvddqa"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>mqeopfuudtdsufvyvddqa</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productPicture</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="productPicture" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phpIlpNJB</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productCode</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="productCode" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>alert_qty</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="alert_qty" data-endpoint="POSTapi-v1-products"
|
|
value="73"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Example: <code>73</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>size</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="size" data-endpoint="POSTapi-v1-products"
|
|
value="mqeopfuudtdsufvyvddqa"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>mqeopfuudtdsufvyvddqa</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="type" data-endpoint="POSTapi-v1-products"
|
|
value="mniihfqcoynlazghdtqtq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>mniihfqcoynlazghdtqtq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>color</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="color" data-endpoint="POSTapi-v1-products"
|
|
value="xbajwbpilpmufinllwloa"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>xbajwbpilpmufinllwloa</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>weight</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="weight" data-endpoint="POSTapi-v1-products"
|
|
value="uydlsmsjuryvojcybzvrb"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>uydlsmsjuryvojcybzvrb</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>capacity</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="capacity" data-endpoint="POSTapi-v1-products"
|
|
value="yickznkygloigmkwxphlv"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>yickznkygloigmkwxphlv</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productManufacturer</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="productManufacturer" data-endpoint="POSTapi-v1-products"
|
|
value="azjrcnfbaqywuxhgjjmzu"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>azjrcnfbaqywuxhgjjmzu</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>product_type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="product_type" data-endpoint="POSTapi-v1-products"
|
|
value="variant"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>variant</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>single</code></li> <li><code>variant</code></li> <li><code>combo</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>variation_ids</code></b>
|
|
<small>string[]</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="variation_ids[0]" data-endpoint="POSTapi-v1-products"
|
|
data-component="body">
|
|
<input type="text" style="display: none"
|
|
name="variation_ids[1]" data-endpoint="POSTapi-v1-products"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the variations table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>stocks</code></b>
|
|
<small>object[]</small>
|
|
<i>optional</i>
|
|
|
|
<br>
|
|
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>warehouse_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="stocks.0.warehouse_id" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the warehouses table.</p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productStock</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.productStock" data-endpoint="POSTapi-v1-products"
|
|
value="10"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>10</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>exclusive_price</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.exclusive_price" data-endpoint="POSTapi-v1-products"
|
|
value="20"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>20</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>inclusive_price</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.inclusive_price" data-endpoint="POSTapi-v1-products"
|
|
value="2"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>2</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>profit_percent</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.profit_percent" data-endpoint="POSTapi-v1-products"
|
|
value="16"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 99999999.99. Example: <code>16</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productSalePrice</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.productSalePrice" data-endpoint="POSTapi-v1-products"
|
|
value="14"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>14</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productWholeSalePrice</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.productWholeSalePrice" data-endpoint="POSTapi-v1-products"
|
|
value="20"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>20</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productDealerPrice</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.productDealerPrice" data-endpoint="POSTapi-v1-products"
|
|
value="25"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>25</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>mfg_date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="stocks.0.mfg_date" data-endpoint="POSTapi-v1-products"
|
|
value="2026-04-25T14:39:34"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:34</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>expire_date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="stocks.0.expire_date" data-endpoint="POSTapi-v1-products"
|
|
value="2107-05-25"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Must be a date after or equal to <code>stocks.*.mfg_date</code>. Example: <code>2107-05-25</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>batch_no</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="stocks.0.batch_no" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</details>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>combo_products</code></b>
|
|
<small>object[]</small>
|
|
<i>optional</i>
|
|
|
|
<br>
|
|
<p>Combo validation.</p>
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>stock_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="combo_products.0.stock_id" data-endpoint="POSTapi-v1-products"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>product_type</code> is <code>combo</code>.</p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>quantity</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="combo_products.0.quantity" data-endpoint="POSTapi-v1-products"
|
|
value="45"
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>product_type</code> is <code>combo</code>. Must be at least 1. Example: <code>45</code></p>
|
|
</div>
|
|
</details>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-products--id-">GET api/v1/products/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-products--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/products/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/products/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-products--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-products--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-products--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-products--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-products--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-products--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-products--id-" data-method="GET"
|
|
data-path="api/v1/products/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-products--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-products--id-"
|
|
onclick="tryItOut('GETapi-v1-products--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-products--id-"
|
|
onclick="cancelTryOut('GETapi-v1-products--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-products--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/products/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-products--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-products--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-products--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the product. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-products--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-products--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/products/17" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "vat_type=exclusive"\
|
|
--form "productName=mqeopfuudtdsufvyvddqa"\
|
|
--form "alert_qty=73"\
|
|
--form "size=mqeopfuudtdsufvyvddqa"\
|
|
--form "type=mniihfqcoynlazghdtqtq"\
|
|
--form "color=xbajwbpilpmufinllwloa"\
|
|
--form "weight=uydlsmsjuryvojcybzvrb"\
|
|
--form "capacity=yickznkygloigmkwxphlv"\
|
|
--form "productManufacturer=azjrcnfbaqywuxhgjjmzu"\
|
|
--form "product_type=variant"\
|
|
--form "stocks[][productStock]=10"\
|
|
--form "stocks[][exclusive_price]=20"\
|
|
--form "stocks[][inclusive_price]=2"\
|
|
--form "stocks[][profit_percent]=16"\
|
|
--form "stocks[][productSalePrice]=14"\
|
|
--form "stocks[][productWholeSalePrice]=20"\
|
|
--form "stocks[][productDealerPrice]=25"\
|
|
--form "stocks[][mfg_date]=2026-04-25T14:39:34"\
|
|
--form "stocks[][expire_date]=2107-05-25"\
|
|
--form "combo_products[][quantity]=45"\
|
|
--form "productPicture=@/tmp/phphmopkB" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/products/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('vat_type', 'exclusive');
|
|
body.append('productName', 'mqeopfuudtdsufvyvddqa');
|
|
body.append('alert_qty', '73');
|
|
body.append('size', 'mqeopfuudtdsufvyvddqa');
|
|
body.append('type', 'mniihfqcoynlazghdtqtq');
|
|
body.append('color', 'xbajwbpilpmufinllwloa');
|
|
body.append('weight', 'uydlsmsjuryvojcybzvrb');
|
|
body.append('capacity', 'yickznkygloigmkwxphlv');
|
|
body.append('productManufacturer', 'azjrcnfbaqywuxhgjjmzu');
|
|
body.append('product_type', 'variant');
|
|
body.append('stocks[][productStock]', '10');
|
|
body.append('stocks[][exclusive_price]', '20');
|
|
body.append('stocks[][inclusive_price]', '2');
|
|
body.append('stocks[][profit_percent]', '16');
|
|
body.append('stocks[][productSalePrice]', '14');
|
|
body.append('stocks[][productWholeSalePrice]', '20');
|
|
body.append('stocks[][productDealerPrice]', '25');
|
|
body.append('stocks[][mfg_date]', '2026-04-25T14:39:34');
|
|
body.append('stocks[][expire_date]', '2107-05-25');
|
|
body.append('combo_products[][quantity]', '45');
|
|
body.append('productPicture', document.querySelector('input[name="productPicture"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-products--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-products--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-products--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-products--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-products--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-products--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-products--id-" data-method="PUT"
|
|
data-path="api/v1/products/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-products--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-products--id-"
|
|
onclick="tryItOut('PUTapi-v1-products--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-products--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-products--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-products--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/products/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/products/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-products--id-"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-products--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-products--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the product. Example: <code>17</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>vat_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="vat_id" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the vats table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>unit_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="unit_id" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the units table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>brand_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="brand_id" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the brands table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>category_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="category_id" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the categories table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>model_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="model_id" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the product_models table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>vat_type</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="vat_type" data-endpoint="PUTapi-v1-products--id-"
|
|
value="exclusive"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>exclusive</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>inclusive</code></li> <li><code>exclusive</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="productName" data-endpoint="PUTapi-v1-products--id-"
|
|
value="mqeopfuudtdsufvyvddqa"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>mqeopfuudtdsufvyvddqa</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productPicture</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="productPicture" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phphmopkB</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productCode</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="productCode" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>alert_qty</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="alert_qty" data-endpoint="PUTapi-v1-products--id-"
|
|
value="73"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Example: <code>73</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>size</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="size" data-endpoint="PUTapi-v1-products--id-"
|
|
value="mqeopfuudtdsufvyvddqa"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>mqeopfuudtdsufvyvddqa</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="type" data-endpoint="PUTapi-v1-products--id-"
|
|
value="mniihfqcoynlazghdtqtq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>mniihfqcoynlazghdtqtq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>color</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="color" data-endpoint="PUTapi-v1-products--id-"
|
|
value="xbajwbpilpmufinllwloa"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>xbajwbpilpmufinllwloa</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>weight</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="weight" data-endpoint="PUTapi-v1-products--id-"
|
|
value="uydlsmsjuryvojcybzvrb"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>uydlsmsjuryvojcybzvrb</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>capacity</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="capacity" data-endpoint="PUTapi-v1-products--id-"
|
|
value="yickznkygloigmkwxphlv"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>yickznkygloigmkwxphlv</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productManufacturer</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="productManufacturer" data-endpoint="PUTapi-v1-products--id-"
|
|
value="azjrcnfbaqywuxhgjjmzu"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>azjrcnfbaqywuxhgjjmzu</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>product_type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="product_type" data-endpoint="PUTapi-v1-products--id-"
|
|
value="variant"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>variant</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>single</code></li> <li><code>variant</code></li> <li><code>combo</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>variation_ids</code></b>
|
|
<small>string[]</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="variation_ids[0]" data-endpoint="PUTapi-v1-products--id-"
|
|
data-component="body">
|
|
<input type="text" style="display: none"
|
|
name="variation_ids[1]" data-endpoint="PUTapi-v1-products--id-"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the variations table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>stocks</code></b>
|
|
<small>object[]</small>
|
|
<i>optional</i>
|
|
|
|
<br>
|
|
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>warehouse_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="stocks.0.warehouse_id" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the warehouses table.</p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productStock</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.productStock" data-endpoint="PUTapi-v1-products--id-"
|
|
value="10"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>10</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>exclusive_price</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.exclusive_price" data-endpoint="PUTapi-v1-products--id-"
|
|
value="20"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>20</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>inclusive_price</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.inclusive_price" data-endpoint="PUTapi-v1-products--id-"
|
|
value="2"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>2</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>profit_percent</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.profit_percent" data-endpoint="PUTapi-v1-products--id-"
|
|
value="16"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 99999999.99. Example: <code>16</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productSalePrice</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.productSalePrice" data-endpoint="PUTapi-v1-products--id-"
|
|
value="14"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>14</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productWholeSalePrice</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.productWholeSalePrice" data-endpoint="PUTapi-v1-products--id-"
|
|
value="20"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>20</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productDealerPrice</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="stocks.0.productDealerPrice" data-endpoint="PUTapi-v1-products--id-"
|
|
value="25"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Must not be greater than 99999999.99. Example: <code>25</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>mfg_date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="stocks.0.mfg_date" data-endpoint="PUTapi-v1-products--id-"
|
|
value="2026-04-25T14:39:34"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:34</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>expire_date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="stocks.0.expire_date" data-endpoint="PUTapi-v1-products--id-"
|
|
value="2107-05-25"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Must be a date after or equal to <code>stocks.*.mfg_date</code>. Example: <code>2107-05-25</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>batch_no</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="stocks.0.batch_no" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</details>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>combo_products</code></b>
|
|
<small>object[]</small>
|
|
<i>optional</i>
|
|
|
|
<br>
|
|
<p>Combo validation.</p>
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>stock_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="combo_products.0.stock_id" data-endpoint="PUTapi-v1-products--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>product_type</code> is <code>combo</code>.</p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>quantity</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="combo_products.0.quantity" data-endpoint="PUTapi-v1-products--id-"
|
|
value="45"
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>product_type</code> is <code>combo</code>. Must be at least 1. Example: <code>45</code></p>
|
|
</div>
|
|
</details>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-products--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-products--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/products/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/products/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-products--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-products--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-products--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-products--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-products--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-products--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-products--id-" data-method="DELETE"
|
|
data-path="api/v1/products/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-products--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-products--id-"
|
|
onclick="tryItOut('DELETEapi-v1-products--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-products--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-products--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-products--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/products/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-products--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-products--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-products--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the product. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-stocks">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-stocks">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/stocks" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"productStock\": 17,
|
|
\"stock_id\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/stocks"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"productStock": 17,
|
|
"stock_id": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-stocks">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-stocks" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-stocks"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-stocks"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-stocks" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-stocks">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-stocks" data-method="POST"
|
|
data-path="api/v1/stocks"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-stocks', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-stocks"
|
|
onclick="tryItOut('POSTapi-v1-stocks');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-stocks"
|
|
onclick="cancelTryOut('POSTapi-v1-stocks');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-stocks"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/stocks</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-stocks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-stocks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>productStock</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="productStock" data-endpoint="POSTapi-v1-stocks"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>stock_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="stock_id" data-endpoint="POSTapi-v1-stocks"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the stocks table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-stocks--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-stocks--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/stocks/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/stocks/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-stocks--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-stocks--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-stocks--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-stocks--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-stocks--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-stocks--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-stocks--id-" data-method="PUT"
|
|
data-path="api/v1/stocks/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-stocks--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-stocks--id-"
|
|
onclick="tryItOut('PUTapi-v1-stocks--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-stocks--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-stocks--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-stocks--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/stocks/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/stocks/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-stocks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-stocks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-stocks--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the stock. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-stocks--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-stocks--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/stocks/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/stocks/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-stocks--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-stocks--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-stocks--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-stocks--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-stocks--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-stocks--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-stocks--id-" data-method="DELETE"
|
|
data-path="api/v1/stocks/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-stocks--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-stocks--id-"
|
|
onclick="tryItOut('DELETEapi-v1-stocks--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-stocks--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-stocks--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-stocks--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/stocks/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-stocks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-stocks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-stocks--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the stock. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-business">GET api/v1/business</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-business">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/business" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/business"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-business">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-business" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-business"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-business"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-business" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-business">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-business" data-method="GET"
|
|
data-path="api/v1/business"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-business', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-business"
|
|
onclick="tryItOut('GETapi-v1-business');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-business"
|
|
onclick="cancelTryOut('GETapi-v1-business');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-business"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/business</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-business"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-business"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-business">POST api/v1/business</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-business">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/business" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "address=vmqeopfuudtdsufvyvddq"\
|
|
--form "companyName=amniihfqcoynlazghdtqt"\
|
|
--form "shopOpeningBalance=11613.31890586"\
|
|
--form "business_category_id=consequatur"\
|
|
--form "pictureUrl=@/tmp/phpIMNggC" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/business"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('address', 'vmqeopfuudtdsufvyvddq');
|
|
body.append('companyName', 'amniihfqcoynlazghdtqt');
|
|
body.append('shopOpeningBalance', '11613.31890586');
|
|
body.append('business_category_id', 'consequatur');
|
|
body.append('pictureUrl', document.querySelector('input[name="pictureUrl"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-business">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-business" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-business"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-business"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-business" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-business">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-business" data-method="POST"
|
|
data-path="api/v1/business"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-business', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-business"
|
|
onclick="tryItOut('POSTapi-v1-business');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-business"
|
|
onclick="cancelTryOut('POSTapi-v1-business');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-business"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/business</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-business"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-business"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>address</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="address" data-endpoint="POSTapi-v1-business"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 250 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>companyName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="companyName" data-endpoint="POSTapi-v1-business"
|
|
value="amniihfqcoynlazghdtqt"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 250 characters. Example: <code>amniihfqcoynlazghdtqt</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>pictureUrl</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="pictureUrl" data-endpoint="POSTapi-v1-business"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Must not be greater than 5120 kilobytes. Example: <code>/tmp/phpIMNggC</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>shopOpeningBalance</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="shopOpeningBalance" data-endpoint="POSTapi-v1-business"
|
|
value="11613.31890586"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>11613.31890586</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>phoneNumber</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="phoneNumber" data-endpoint="POSTapi-v1-business"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>business_category_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="business_category_id" data-endpoint="POSTapi-v1-business"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the business_categories table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-business--id-">PUT api/v1/business/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-business--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/business/17" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "address=vmqeopfuudtdsufvyvddq"\
|
|
--form "companyName=amniihfqcoynlazghdtqt"\
|
|
--form "show_company_name=1"\
|
|
--form "show_phone_number="\
|
|
--form "show_address="\
|
|
--form "show_email=1"\
|
|
--form "show_vat="\
|
|
--form "sale_rounding_option=nearest_whole_number"\
|
|
--form "invoice_size=bpilpmufinllwloauydls"\
|
|
--form "invoice_language=msjuryvojcybzvrbyickz"\
|
|
--form "gratitude_message=nkygloigmkwxphlvazjrc"\
|
|
--form "warranty_void_label=consequatur"\
|
|
--form "warranty_void=consequatur"\
|
|
--form "show_note="\
|
|
--form "show_gratitude_msg=1"\
|
|
--form "show_invoice_scanner_logo="\
|
|
--form "show_a4_invoice_logo=1"\
|
|
--form "show_thermal_invoice_logo=1"\
|
|
--form "show_warranty=1"\
|
|
--form "pictureUrl=@/tmp/phpDfKmPD" \
|
|
--form "invoice_logo=@/tmp/phpniADaD" \
|
|
--form "a4_invoice_logo=@/tmp/phpaHhaaD" \
|
|
--form "thermal_invoice_logo=@/tmp/phpihnkaD" \
|
|
--form "invoice_scanner_logo=@/tmp/phphfCIbD" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/business/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('address', 'vmqeopfuudtdsufvyvddq');
|
|
body.append('companyName', 'amniihfqcoynlazghdtqt');
|
|
body.append('show_company_name', '1');
|
|
body.append('show_phone_number', '');
|
|
body.append('show_address', '');
|
|
body.append('show_email', '1');
|
|
body.append('show_vat', '');
|
|
body.append('sale_rounding_option', 'nearest_whole_number');
|
|
body.append('invoice_size', 'bpilpmufinllwloauydls');
|
|
body.append('invoice_language', 'msjuryvojcybzvrbyickz');
|
|
body.append('gratitude_message', 'nkygloigmkwxphlvazjrc');
|
|
body.append('warranty_void_label', 'consequatur');
|
|
body.append('warranty_void', 'consequatur');
|
|
body.append('show_note', '');
|
|
body.append('show_gratitude_msg', '1');
|
|
body.append('show_invoice_scanner_logo', '');
|
|
body.append('show_a4_invoice_logo', '1');
|
|
body.append('show_thermal_invoice_logo', '1');
|
|
body.append('show_warranty', '1');
|
|
body.append('pictureUrl', document.querySelector('input[name="pictureUrl"]').files[0]);
|
|
body.append('invoice_logo', document.querySelector('input[name="invoice_logo"]').files[0]);
|
|
body.append('a4_invoice_logo', document.querySelector('input[name="a4_invoice_logo"]').files[0]);
|
|
body.append('thermal_invoice_logo', document.querySelector('input[name="thermal_invoice_logo"]').files[0]);
|
|
body.append('invoice_scanner_logo', document.querySelector('input[name="invoice_scanner_logo"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-business--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-business--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-business--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-business--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-business--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-business--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-business--id-" data-method="PUT"
|
|
data-path="api/v1/business/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-business--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-business--id-"
|
|
onclick="tryItOut('PUTapi-v1-business--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-business--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-business--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-business--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/business/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/business/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-business--id-"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-business--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-business--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the business. Example: <code>17</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>address</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="address" data-endpoint="PUTapi-v1-business--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 250 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>companyName</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="companyName" data-endpoint="PUTapi-v1-business--id-"
|
|
value="amniihfqcoynlazghdtqt"
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>sale_rounding_option</code> is <code>!=</code> or <code>null</code>. Must not be greater than 250 characters. Example: <code>amniihfqcoynlazghdtqt</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>business_category_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="business_category_id" data-endpoint="PUTapi-v1-business--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>sale_rounding_option</code> is <code>!=</code> or <code>null</code>. The <code>id</code> of an existing record in the business_categories table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>pictureUrl</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="pictureUrl" data-endpoint="PUTapi-v1-business--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Must not be greater than 5120 kilobytes. Example: <code>/tmp/phpDfKmPD</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_company_name</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_company_name"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_company_name"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>true</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_phone_number</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_phone_number"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_phone_number"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>false</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_address</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_address"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_address"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>false</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_email</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_email"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_email"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>true</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_vat</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_vat"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_vat"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>false</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>invoice_logo</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="invoice_logo" data-endpoint="PUTapi-v1-business--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Must not be greater than 5120 kilobytes. Example: <code>/tmp/phpniADaD</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>a4_invoice_logo</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="a4_invoice_logo" data-endpoint="PUTapi-v1-business--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Must not be greater than 5120 kilobytes. Example: <code>/tmp/phpaHhaaD</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>thermal_invoice_logo</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="thermal_invoice_logo" data-endpoint="PUTapi-v1-business--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Must not be greater than 5120 kilobytes. Example: <code>/tmp/phpihnkaD</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>invoice_scanner_logo</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="invoice_scanner_logo" data-endpoint="PUTapi-v1-business--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Must not be greater than 5120 kilobytes. Example: <code>/tmp/phphfCIbD</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>sale_rounding_option</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="sale_rounding_option" data-endpoint="PUTapi-v1-business--id-"
|
|
value="nearest_whole_number"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>nearest_whole_number</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>none</code></li> <li><code>round_up</code></li> <li><code>nearest_whole_number</code></li> <li><code>nearest_0.05</code></li> <li><code>nearest_0.1</code></li> <li><code>nearest_0.5</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>phoneNumber</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="phoneNumber" data-endpoint="PUTapi-v1-business--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>invoice_size</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="invoice_size" data-endpoint="PUTapi-v1-business--id-"
|
|
value="bpilpmufinllwloauydls"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 100 characters. Example: <code>bpilpmufinllwloauydls</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>invoice_language</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="invoice_language" data-endpoint="PUTapi-v1-business--id-"
|
|
value="msjuryvojcybzvrbyickz"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 100 characters. Example: <code>msjuryvojcybzvrbyickz</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>gratitude_message</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="gratitude_message" data-endpoint="PUTapi-v1-business--id-"
|
|
value="nkygloigmkwxphlvazjrc"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 100 characters. Example: <code>nkygloigmkwxphlvazjrc</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>warranty_void_label</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="warranty_void_label" data-endpoint="PUTapi-v1-business--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>warranty_void</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="warranty_void" data-endpoint="PUTapi-v1-business--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_note</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_note"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_note"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>false</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_gratitude_msg</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_gratitude_msg"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_gratitude_msg"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>true</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_invoice_scanner_logo</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_invoice_scanner_logo"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_invoice_scanner_logo"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>false</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_a4_invoice_logo</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_a4_invoice_logo"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_a4_invoice_logo"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>true</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_thermal_invoice_logo</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_thermal_invoice_logo"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_thermal_invoice_logo"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>true</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_warranty</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_warranty"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-business--id-" style="display: none">
|
|
<input type="radio" name="show_warranty"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-business--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>true</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-business-categories">GET api/v1/business-categories</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-business-categories">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/business-categories" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/business-categories"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-business-categories">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-business-categories" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-business-categories"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-business-categories"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-business-categories" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-business-categories">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-business-categories" data-method="GET"
|
|
data-path="api/v1/business-categories"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-business-categories', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-business-categories"
|
|
onclick="tryItOut('GETapi-v1-business-categories');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-business-categories"
|
|
onclick="cancelTryOut('GETapi-v1-business-categories');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-business-categories"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/business-categories</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-business-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-business-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-purchase">GET api/v1/purchase</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-purchase">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/purchase" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/purchase"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-purchase">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-purchase" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-purchase"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-purchase"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-purchase" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-purchase">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-purchase" data-method="GET"
|
|
data-path="api/v1/purchase"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-purchase', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-purchase"
|
|
onclick="tryItOut('GETapi-v1-purchase');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-purchase"
|
|
onclick="cancelTryOut('GETapi-v1-purchase');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-purchase"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/purchase</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-purchase"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-purchase"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-purchase">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-purchase">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/purchase" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"products\": [
|
|
{
|
|
\"product_id\": \"consequatur\"
|
|
}
|
|
],
|
|
\"party_id\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/purchase"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"products": [
|
|
{
|
|
"product_id": "consequatur"
|
|
}
|
|
],
|
|
"party_id": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-purchase">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-purchase" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-purchase"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-purchase"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-purchase" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-purchase">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-purchase" data-method="POST"
|
|
data-path="api/v1/purchase"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-purchase', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-purchase"
|
|
onclick="tryItOut('POSTapi-v1-purchase');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-purchase"
|
|
onclick="cancelTryOut('POSTapi-v1-purchase');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-purchase"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/purchase</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-purchase"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-purchase"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>products</code></b>
|
|
<small>object[]</small>
|
|
|
|
|
|
<br>
|
|
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>product_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="products.0.product_id" data-endpoint="POSTapi-v1-purchase"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the products table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</details>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>party_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="party_id" data-endpoint="POSTapi-v1-purchase"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the parties table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-purchase--id-">GET api/v1/purchase/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-purchase--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/purchase/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/purchase/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-purchase--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-purchase--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-purchase--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-purchase--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-purchase--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-purchase--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-purchase--id-" data-method="GET"
|
|
data-path="api/v1/purchase/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-purchase--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-purchase--id-"
|
|
onclick="tryItOut('GETapi-v1-purchase--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-purchase--id-"
|
|
onclick="cancelTryOut('GETapi-v1-purchase--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-purchase--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/purchase/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-purchase--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-purchase--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-purchase--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the purchase. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-purchase--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-purchase--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/purchase/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"products\": [
|
|
{
|
|
\"product_id\": \"consequatur\"
|
|
}
|
|
],
|
|
\"party_id\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/purchase/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"products": [
|
|
{
|
|
"product_id": "consequatur"
|
|
}
|
|
],
|
|
"party_id": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-purchase--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-purchase--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-purchase--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-purchase--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-purchase--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-purchase--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-purchase--id-" data-method="PUT"
|
|
data-path="api/v1/purchase/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-purchase--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-purchase--id-"
|
|
onclick="tryItOut('PUTapi-v1-purchase--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-purchase--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-purchase--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-purchase--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/purchase/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/purchase/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-purchase--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-purchase--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-purchase--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the purchase. Example: <code>17</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>products</code></b>
|
|
<small>object[]</small>
|
|
|
|
|
|
<br>
|
|
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>product_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="products.0.product_id" data-endpoint="PUTapi-v1-purchase--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the products table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</details>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>party_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="party_id" data-endpoint="PUTapi-v1-purchase--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the parties table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-purchase--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-purchase--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/purchase/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/purchase/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-purchase--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-purchase--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-purchase--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-purchase--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-purchase--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-purchase--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-purchase--id-" data-method="DELETE"
|
|
data-path="api/v1/purchase/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-purchase--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-purchase--id-"
|
|
onclick="tryItOut('DELETEapi-v1-purchase--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-purchase--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-purchase--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-purchase--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/purchase/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-purchase--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-purchase--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-purchase--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the purchase. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-sales">GET api/v1/sales</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-sales">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/sales" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sales"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-sales">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-sales" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-sales"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-sales"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-sales" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-sales">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-sales" data-method="GET"
|
|
data-path="api/v1/sales"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-sales', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-sales"
|
|
onclick="tryItOut('GETapi-v1-sales');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-sales"
|
|
onclick="cancelTryOut('GETapi-v1-sales');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-sales"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/sales</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-sales"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-sales"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-sales">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-sales">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/sales" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "products=consequatur"\
|
|
--form "saleDate=2026-04-25T14:39:34"\
|
|
--form "rounding_option=nearest_0.05"\
|
|
--form "image=@/tmp/phpKCJEeF" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sales"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('products', 'consequatur');
|
|
body.append('saleDate', '2026-04-25T14:39:34');
|
|
body.append('rounding_option', 'nearest_0.05');
|
|
body.append('image', document.querySelector('input[name="image"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-sales">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-sales" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-sales"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-sales"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-sales" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-sales">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-sales" data-method="POST"
|
|
data-path="api/v1/sales"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-sales', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-sales"
|
|
onclick="tryItOut('POSTapi-v1-sales');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-sales"
|
|
onclick="cancelTryOut('POSTapi-v1-sales');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-sales"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/sales</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-sales"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-sales"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>party_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="party_id" data-endpoint="POSTapi-v1-sales"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the parties table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>vat_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="vat_id" data-endpoint="POSTapi-v1-sales"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the vats table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>products</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="products" data-endpoint="POSTapi-v1-sales"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>saleDate</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="saleDate" data-endpoint="POSTapi-v1-sales"
|
|
value="2026-04-25T14:39:34"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:34</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>image</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="image" data-endpoint="POSTapi-v1-sales"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phpKCJEeF</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>rounding_option</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="rounding_option" data-endpoint="POSTapi-v1-sales"
|
|
value="nearest_0.05"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>nearest_0.05</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>none</code></li> <li><code>round_up</code></li> <li><code>nearest_whole_number</code></li> <li><code>nearest_0.05</code></li> <li><code>nearest_0.1</code></li> <li><code>nearest_0.5</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-sales--id-">GET api/v1/sales/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-sales--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/sales/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sales/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-sales--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-sales--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-sales--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-sales--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-sales--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-sales--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-sales--id-" data-method="GET"
|
|
data-path="api/v1/sales/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-sales--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-sales--id-"
|
|
onclick="tryItOut('GETapi-v1-sales--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-sales--id-"
|
|
onclick="cancelTryOut('GETapi-v1-sales--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-sales--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/sales/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-sales--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-sales--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-sales--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the sale. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-sales--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-sales--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/sales/consequatur" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "products=consequatur"\
|
|
--form "saleDate=2026-04-25T14:39:34"\
|
|
--form "rounding_option=nearest_0.05"\
|
|
--form "image=@/tmp/phpcpOmkF" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sales/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('products', 'consequatur');
|
|
body.append('saleDate', '2026-04-25T14:39:34');
|
|
body.append('rounding_option', 'nearest_0.05');
|
|
body.append('image', document.querySelector('input[name="image"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-sales--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-sales--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-sales--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-sales--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-sales--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-sales--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-sales--id-" data-method="PUT"
|
|
data-path="api/v1/sales/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-sales--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-sales--id-"
|
|
onclick="tryItOut('PUTapi-v1-sales--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-sales--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-sales--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-sales--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/sales/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/sales/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-sales--id-"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-sales--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-sales--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the sale. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>party_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="party_id" data-endpoint="PUTapi-v1-sales--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the parties table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>vat_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="vat_id" data-endpoint="PUTapi-v1-sales--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the vats table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>products</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="products" data-endpoint="PUTapi-v1-sales--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>saleDate</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="saleDate" data-endpoint="PUTapi-v1-sales--id-"
|
|
value="2026-04-25T14:39:34"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:34</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>image</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="image" data-endpoint="PUTapi-v1-sales--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phpcpOmkF</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>rounding_option</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="rounding_option" data-endpoint="PUTapi-v1-sales--id-"
|
|
value="nearest_0.05"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>nearest_0.05</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>none</code></li> <li><code>round_up</code></li> <li><code>nearest_whole_number</code></li> <li><code>nearest_0.05</code></li> <li><code>nearest_0.1</code></li> <li><code>nearest_0.5</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-sales--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-sales--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/sales/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sales/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-sales--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-sales--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-sales--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-sales--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-sales--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-sales--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-sales--id-" data-method="DELETE"
|
|
data-path="api/v1/sales/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-sales--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-sales--id-"
|
|
onclick="tryItOut('DELETEapi-v1-sales--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-sales--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-sales--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-sales--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/sales/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-sales--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-sales--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-sales--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the sale. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-loss-profit">GET api/v1/reports/loss-profit</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-loss-profit">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/loss-profit" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/loss-profit"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-loss-profit">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-loss-profit" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-loss-profit"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-loss-profit"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-loss-profit" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-loss-profit">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-loss-profit" data-method="GET"
|
|
data-path="api/v1/reports/loss-profit"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-loss-profit', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-loss-profit"
|
|
onclick="tryItOut('GETapi-v1-reports-loss-profit');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-loss-profit"
|
|
onclick="cancelTryOut('GETapi-v1-reports-loss-profit');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-loss-profit"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/loss-profit</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-loss-profit"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-loss-profit"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-cashflow">GET api/v1/reports/cashflow</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-cashflow">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/cashflow" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/cashflow"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-cashflow">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-cashflow" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-cashflow"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-cashflow"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-cashflow" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-cashflow">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-cashflow" data-method="GET"
|
|
data-path="api/v1/reports/cashflow"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-cashflow', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-cashflow"
|
|
onclick="tryItOut('GETapi-v1-reports-cashflow');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-cashflow"
|
|
onclick="cancelTryOut('GETapi-v1-reports-cashflow');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-cashflow"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/cashflow</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-cashflow"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-cashflow"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-balance-sheet">GET api/v1/reports/balance-sheet</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-balance-sheet">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/balance-sheet" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/balance-sheet"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-balance-sheet">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-balance-sheet" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-balance-sheet"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-balance-sheet"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-balance-sheet" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-balance-sheet">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-balance-sheet" data-method="GET"
|
|
data-path="api/v1/reports/balance-sheet"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-balance-sheet', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-balance-sheet"
|
|
onclick="tryItOut('GETapi-v1-reports-balance-sheet');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-balance-sheet"
|
|
onclick="cancelTryOut('GETapi-v1-reports-balance-sheet');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-balance-sheet"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/balance-sheet</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-balance-sheet"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-balance-sheet"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-subscription">GET api/v1/reports/subscription</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-subscription">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/subscription" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/subscription"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-subscription">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-subscription" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-subscription"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-subscription"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-subscription" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-subscription">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-subscription" data-method="GET"
|
|
data-path="api/v1/reports/subscription"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-subscription', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-subscription"
|
|
onclick="tryItOut('GETapi-v1-reports-subscription');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-subscription"
|
|
onclick="cancelTryOut('GETapi-v1-reports-subscription');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-subscription"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/subscription</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-subscription"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-subscription"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-tax">GET api/v1/reports/tax</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-tax">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/tax" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/tax"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-tax">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-tax" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-tax"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-tax"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-tax" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-tax">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-tax" data-method="GET"
|
|
data-path="api/v1/reports/tax"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-tax', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-tax"
|
|
onclick="tryItOut('GETapi-v1-reports-tax');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-tax"
|
|
onclick="cancelTryOut('GETapi-v1-reports-tax');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-tax"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/tax</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-tax"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-tax"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-bill-wise-profit">GET api/v1/reports/bill-wise-profit</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-bill-wise-profit">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/bill-wise-profit" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/bill-wise-profit"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-bill-wise-profit">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-bill-wise-profit" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-bill-wise-profit"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-bill-wise-profit"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-bill-wise-profit" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-bill-wise-profit">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-bill-wise-profit" data-method="GET"
|
|
data-path="api/v1/reports/bill-wise-profit"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-bill-wise-profit', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-bill-wise-profit"
|
|
onclick="tryItOut('GETapi-v1-reports-bill-wise-profit');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-bill-wise-profit"
|
|
onclick="cancelTryOut('GETapi-v1-reports-bill-wise-profit');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-bill-wise-profit"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/bill-wise-profit</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-bill-wise-profit"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-bill-wise-profit"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-product-sale-history">GET api/v1/reports/product-sale-history</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-product-sale-history">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/product-sale-history" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/product-sale-history"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-product-sale-history">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-product-sale-history" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-product-sale-history"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-product-sale-history"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-product-sale-history" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-product-sale-history">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-product-sale-history" data-method="GET"
|
|
data-path="api/v1/reports/product-sale-history"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-product-sale-history', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-product-sale-history"
|
|
onclick="tryItOut('GETapi-v1-reports-product-sale-history');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-product-sale-history"
|
|
onclick="cancelTryOut('GETapi-v1-reports-product-sale-history');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-product-sale-history"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/product-sale-history</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-product-sale-history"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-product-sale-history"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-product-sale-history--id-">GET api/v1/reports/product-sale-history/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-product-sale-history--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/product-sale-history/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/product-sale-history/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-product-sale-history--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-product-sale-history--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-product-sale-history--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-product-sale-history--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-product-sale-history--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-product-sale-history--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-product-sale-history--id-" data-method="GET"
|
|
data-path="api/v1/reports/product-sale-history/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-product-sale-history--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-product-sale-history--id-"
|
|
onclick="tryItOut('GETapi-v1-reports-product-sale-history--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-product-sale-history--id-"
|
|
onclick="cancelTryOut('GETapi-v1-reports-product-sale-history--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-product-sale-history--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/product-sale-history/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-product-sale-history--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-product-sale-history--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-reports-product-sale-history--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the product sale history. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-product-purchase-history">GET api/v1/reports/product-purchase-history</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-product-purchase-history">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/product-purchase-history" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/product-purchase-history"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-product-purchase-history">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-product-purchase-history" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-product-purchase-history"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-product-purchase-history"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-product-purchase-history" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-product-purchase-history">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-product-purchase-history" data-method="GET"
|
|
data-path="api/v1/reports/product-purchase-history"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-product-purchase-history', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-product-purchase-history"
|
|
onclick="tryItOut('GETapi-v1-reports-product-purchase-history');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-product-purchase-history"
|
|
onclick="cancelTryOut('GETapi-v1-reports-product-purchase-history');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-product-purchase-history"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/product-purchase-history</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-product-purchase-history"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-product-purchase-history"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-reports-product-purchase-history--id-">GET api/v1/reports/product-purchase-history/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-reports-product-purchase-history--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/reports/product-purchase-history/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/reports/product-purchase-history/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-reports-product-purchase-history--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-reports-product-purchase-history--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-reports-product-purchase-history--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-reports-product-purchase-history--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-reports-product-purchase-history--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-reports-product-purchase-history--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-reports-product-purchase-history--id-" data-method="GET"
|
|
data-path="api/v1/reports/product-purchase-history/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-reports-product-purchase-history--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-reports-product-purchase-history--id-"
|
|
onclick="tryItOut('GETapi-v1-reports-product-purchase-history--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-reports-product-purchase-history--id-"
|
|
onclick="cancelTryOut('GETapi-v1-reports-product-purchase-history--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-reports-product-purchase-history--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/reports/product-purchase-history/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-reports-product-purchase-history--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-reports-product-purchase-history--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-reports-product-purchase-history--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the product purchase history. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-sales-return">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-sales-return">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/sales-return" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sales-return"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-sales-return">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-sales-return" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-sales-return"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-sales-return"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-sales-return" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-sales-return">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-sales-return" data-method="GET"
|
|
data-path="api/v1/sales-return"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-sales-return', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-sales-return"
|
|
onclick="tryItOut('GETapi-v1-sales-return');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-sales-return"
|
|
onclick="cancelTryOut('GETapi-v1-sales-return');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-sales-return"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/sales-return</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-sales-return"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-sales-return"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-sales-return">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-sales-return">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/sales-return" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"sale_id\": \"consequatur\",
|
|
\"return_qty\": []
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sales-return"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"sale_id": "consequatur",
|
|
"return_qty": []
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-sales-return">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-sales-return" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-sales-return"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-sales-return"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-sales-return" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-sales-return">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-sales-return" data-method="POST"
|
|
data-path="api/v1/sales-return"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-sales-return', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-sales-return"
|
|
onclick="tryItOut('POSTapi-v1-sales-return');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-sales-return"
|
|
onclick="cancelTryOut('POSTapi-v1-sales-return');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-sales-return"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/sales-return</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-sales-return"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-sales-return"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>sale_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="sale_id" data-endpoint="POSTapi-v1-sales-return"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the sales table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>return_qty</code></b>
|
|
<small>object</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="return_qty" data-endpoint="POSTapi-v1-sales-return"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-sales-return--id-">GET api/v1/sales-return/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-sales-return--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/sales-return/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sales-return/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-sales-return--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-sales-return--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-sales-return--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-sales-return--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-sales-return--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-sales-return--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-sales-return--id-" data-method="GET"
|
|
data-path="api/v1/sales-return/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-sales-return--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-sales-return--id-"
|
|
onclick="tryItOut('GETapi-v1-sales-return--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-sales-return--id-"
|
|
onclick="cancelTryOut('GETapi-v1-sales-return--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-sales-return--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/sales-return/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-sales-return--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-sales-return--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-sales-return--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the sales return. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-purchases-return">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-purchases-return">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/purchases-return" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/purchases-return"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-purchases-return">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-purchases-return" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-purchases-return"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-purchases-return"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-purchases-return" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-purchases-return">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-purchases-return" data-method="GET"
|
|
data-path="api/v1/purchases-return"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-purchases-return', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-purchases-return"
|
|
onclick="tryItOut('GETapi-v1-purchases-return');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-purchases-return"
|
|
onclick="cancelTryOut('GETapi-v1-purchases-return');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-purchases-return"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/purchases-return</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-purchases-return"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-purchases-return"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-purchases-return">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-purchases-return">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/purchases-return" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"purchase_id\": \"consequatur\",
|
|
\"return_qty\": []
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/purchases-return"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"purchase_id": "consequatur",
|
|
"return_qty": []
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-purchases-return">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-purchases-return" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-purchases-return"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-purchases-return"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-purchases-return" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-purchases-return">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-purchases-return" data-method="POST"
|
|
data-path="api/v1/purchases-return"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-purchases-return', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-purchases-return"
|
|
onclick="tryItOut('POSTapi-v1-purchases-return');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-purchases-return"
|
|
onclick="cancelTryOut('POSTapi-v1-purchases-return');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-purchases-return"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/purchases-return</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-purchases-return"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-purchases-return"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>purchase_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="purchase_id" data-endpoint="POSTapi-v1-purchases-return"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the purchases table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>return_qty</code></b>
|
|
<small>object</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="return_qty" data-endpoint="POSTapi-v1-purchases-return"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-purchases-return--id-">GET api/v1/purchases-return/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-purchases-return--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/purchases-return/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/purchases-return/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-purchases-return--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-purchases-return--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-purchases-return--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-purchases-return--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-purchases-return--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-purchases-return--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-purchases-return--id-" data-method="GET"
|
|
data-path="api/v1/purchases-return/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-purchases-return--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-purchases-return--id-"
|
|
onclick="tryItOut('GETapi-v1-purchases-return--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-purchases-return--id-"
|
|
onclick="cancelTryOut('GETapi-v1-purchases-return--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-purchases-return--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/purchases-return/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-purchases-return--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-purchases-return--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-purchases-return--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the purchases return. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-invoices">GET api/v1/invoices</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-invoices">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/invoices" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"party_id\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/invoices"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"party_id": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-invoices">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-invoices" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-invoices"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-invoices"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-invoices" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-invoices">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-invoices" data-method="GET"
|
|
data-path="api/v1/invoices"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-invoices', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-invoices"
|
|
onclick="tryItOut('GETapi-v1-invoices');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-invoices"
|
|
onclick="cancelTryOut('GETapi-v1-invoices');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-invoices"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/invoices</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-invoices"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-invoices"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>party_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="party_id" data-endpoint="GETapi-v1-invoices"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the parties table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-dues">GET api/v1/dues</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-dues">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/dues" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/dues"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-dues">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-dues" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-dues"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-dues"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-dues" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-dues">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-dues" data-method="GET"
|
|
data-path="api/v1/dues"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-dues', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-dues"
|
|
onclick="tryItOut('GETapi-v1-dues');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-dues"
|
|
onclick="cancelTryOut('GETapi-v1-dues');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-dues"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/dues</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-dues"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-dues"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-dues">POST api/v1/dues</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-dues">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/dues" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"paymentDate\": \"consequatur\",
|
|
\"payDueAmount\": 11613.31890586,
|
|
\"party_id\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/dues"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"paymentDate": "consequatur",
|
|
"payDueAmount": 11613.31890586,
|
|
"party_id": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-dues">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-dues" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-dues"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-dues"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-dues" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-dues">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-dues" data-method="POST"
|
|
data-path="api/v1/dues"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-dues', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-dues"
|
|
onclick="tryItOut('POSTapi-v1-dues');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-dues"
|
|
onclick="cancelTryOut('POSTapi-v1-dues');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-dues"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/dues</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-dues"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-dues"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>paymentDate</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="paymentDate" data-endpoint="POSTapi-v1-dues"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>payDueAmount</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="payDueAmount" data-endpoint="POSTapi-v1-dues"
|
|
value="11613.31890586"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>11613.31890586</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>party_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="party_id" data-endpoint="POSTapi-v1-dues"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the parties table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>invoiceNumber</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="invoiceNumber" data-endpoint="POSTapi-v1-dues"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-invoice-wise-dues">GET api/v1/invoice-wise-dues</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-invoice-wise-dues">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/invoice-wise-dues" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/invoice-wise-dues"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-invoice-wise-dues">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-invoice-wise-dues" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-invoice-wise-dues"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-invoice-wise-dues"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-invoice-wise-dues" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-invoice-wise-dues">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-invoice-wise-dues" data-method="GET"
|
|
data-path="api/v1/invoice-wise-dues"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-invoice-wise-dues', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-invoice-wise-dues"
|
|
onclick="tryItOut('GETapi-v1-invoice-wise-dues');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-invoice-wise-dues"
|
|
onclick="cancelTryOut('GETapi-v1-invoice-wise-dues');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-invoice-wise-dues"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/invoice-wise-dues</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-invoice-wise-dues"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-invoice-wise-dues"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-collect-invoice-due">POST api/v1/collect-invoice-due</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-collect-invoice-due">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/collect-invoice-due" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"paymentDate\": \"consequatur\",
|
|
\"payDueAmount\": 11613.31890586,
|
|
\"invoiceNumber\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/collect-invoice-due"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"paymentDate": "consequatur",
|
|
"payDueAmount": 11613.31890586,
|
|
"invoiceNumber": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-collect-invoice-due">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-collect-invoice-due" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-collect-invoice-due"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-collect-invoice-due"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-collect-invoice-due" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-collect-invoice-due">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-collect-invoice-due" data-method="POST"
|
|
data-path="api/v1/collect-invoice-due"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-collect-invoice-due', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-collect-invoice-due"
|
|
onclick="tryItOut('POSTapi-v1-collect-invoice-due');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-collect-invoice-due"
|
|
onclick="cancelTryOut('POSTapi-v1-collect-invoice-due');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-collect-invoice-due"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/collect-invoice-due</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-collect-invoice-due"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-collect-invoice-due"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>paymentDate</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="paymentDate" data-endpoint="POSTapi-v1-collect-invoice-due"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>payDueAmount</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="payDueAmount" data-endpoint="POSTapi-v1-collect-invoice-due"
|
|
value="11613.31890586"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>11613.31890586</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>invoiceNumber</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="invoiceNumber" data-endpoint="POSTapi-v1-collect-invoice-due"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>invoiceNumber</code> of an existing record in the sales table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-expense-categories">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-expense-categories">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/expense-categories" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/expense-categories"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-expense-categories">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-expense-categories" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-expense-categories"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-expense-categories"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-expense-categories" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-expense-categories">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-expense-categories" data-method="GET"
|
|
data-path="api/v1/expense-categories"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-expense-categories', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-expense-categories"
|
|
onclick="tryItOut('GETapi-v1-expense-categories');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-expense-categories"
|
|
onclick="cancelTryOut('GETapi-v1-expense-categories');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-expense-categories"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/expense-categories</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-expense-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-expense-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-expense-categories">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-expense-categories">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/expense-categories" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/expense-categories"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-expense-categories">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-expense-categories" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-expense-categories"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-expense-categories"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-expense-categories" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-expense-categories">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-expense-categories" data-method="POST"
|
|
data-path="api/v1/expense-categories"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-expense-categories', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-expense-categories"
|
|
onclick="tryItOut('POSTapi-v1-expense-categories');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-expense-categories"
|
|
onclick="cancelTryOut('POSTapi-v1-expense-categories');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-expense-categories"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/expense-categories</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-expense-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-expense-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>categoryName</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="categoryName" data-endpoint="POSTapi-v1-expense-categories"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-expense-categories--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-expense-categories--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/expense-categories/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"categoryName\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/expense-categories/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"categoryName": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-expense-categories--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-expense-categories--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-expense-categories--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-expense-categories--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-expense-categories--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-expense-categories--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-expense-categories--id-" data-method="PUT"
|
|
data-path="api/v1/expense-categories/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-expense-categories--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-expense-categories--id-"
|
|
onclick="tryItOut('PUTapi-v1-expense-categories--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-expense-categories--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-expense-categories--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-expense-categories--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/expense-categories/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/expense-categories/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-expense-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-expense-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-expense-categories--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the expense category. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>categoryName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="categoryName" data-endpoint="PUTapi-v1-expense-categories--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-expense-categories--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-expense-categories--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/expense-categories/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/expense-categories/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-expense-categories--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-expense-categories--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-expense-categories--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-expense-categories--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-expense-categories--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-expense-categories--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-expense-categories--id-" data-method="DELETE"
|
|
data-path="api/v1/expense-categories/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-expense-categories--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-expense-categories--id-"
|
|
onclick="tryItOut('DELETEapi-v1-expense-categories--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-expense-categories--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-expense-categories--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-expense-categories--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/expense-categories/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-expense-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-expense-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-expense-categories--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the expense category. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-expenses">GET api/v1/expenses</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-expenses">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/expenses" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/expenses"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-expenses">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-expenses" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-expenses"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-expenses"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-expenses" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-expenses">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-expenses" data-method="GET"
|
|
data-path="api/v1/expenses"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-expenses', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-expenses"
|
|
onclick="tryItOut('GETapi-v1-expenses');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-expenses"
|
|
onclick="cancelTryOut('GETapi-v1-expenses');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-expenses"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/expenses</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-expenses"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-expenses"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-expenses">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-expenses">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/expenses" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"expense_category_id\": \"consequatur\",
|
|
\"expanseFor\": \"consequatur\",
|
|
\"referenceNo\": \"consequatur\",
|
|
\"note\": \"consequatur\",
|
|
\"payments\": [
|
|
{
|
|
\"type\": \"consequatur\",
|
|
\"amount\": 45
|
|
}
|
|
]
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/expenses"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"expense_category_id": "consequatur",
|
|
"expanseFor": "consequatur",
|
|
"referenceNo": "consequatur",
|
|
"note": "consequatur",
|
|
"payments": [
|
|
{
|
|
"type": "consequatur",
|
|
"amount": 45
|
|
}
|
|
]
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-expenses">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-expenses" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-expenses"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-expenses"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-expenses" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-expenses">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-expenses" data-method="POST"
|
|
data-path="api/v1/expenses"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-expenses', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-expenses"
|
|
onclick="tryItOut('POSTapi-v1-expenses');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-expenses"
|
|
onclick="cancelTryOut('POSTapi-v1-expenses');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-expenses"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/expenses</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-expenses"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-expenses"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>expense_category_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="expense_category_id" data-endpoint="POSTapi-v1-expenses"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the expense_categories table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>expanseFor</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="expanseFor" data-endpoint="POSTapi-v1-expenses"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>referenceNo</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="referenceNo" data-endpoint="POSTapi-v1-expenses"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>note</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="note" data-endpoint="POSTapi-v1-expenses"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>payments</code></b>
|
|
<small>object[]</small>
|
|
|
|
|
|
<br>
|
|
<p>Must have at least 1 items.</p>
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="payments.0.type" data-endpoint="POSTapi-v1-expenses"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>amount</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="payments.0.amount" data-endpoint="POSTapi-v1-expenses"
|
|
value="45"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Example: <code>45</code></p>
|
|
</div>
|
|
</details>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-income-categories">GET api/v1/income-categories</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-income-categories">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/income-categories" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/income-categories"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-income-categories">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-income-categories" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-income-categories"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-income-categories"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-income-categories" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-income-categories">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-income-categories" data-method="GET"
|
|
data-path="api/v1/income-categories"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-income-categories', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-income-categories"
|
|
onclick="tryItOut('GETapi-v1-income-categories');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-income-categories"
|
|
onclick="cancelTryOut('GETapi-v1-income-categories');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-income-categories"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/income-categories</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-income-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-income-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-income-categories">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-income-categories">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/income-categories" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/income-categories"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-income-categories">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-income-categories" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-income-categories"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-income-categories"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-income-categories" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-income-categories">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-income-categories" data-method="POST"
|
|
data-path="api/v1/income-categories"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-income-categories', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-income-categories"
|
|
onclick="tryItOut('POSTapi-v1-income-categories');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-income-categories"
|
|
onclick="cancelTryOut('POSTapi-v1-income-categories');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-income-categories"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/income-categories</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-income-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-income-categories"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>categoryName</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="categoryName" data-endpoint="POSTapi-v1-income-categories"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-income-categories--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-income-categories--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/income-categories/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"categoryName\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/income-categories/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"categoryName": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-income-categories--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-income-categories--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-income-categories--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-income-categories--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-income-categories--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-income-categories--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-income-categories--id-" data-method="PUT"
|
|
data-path="api/v1/income-categories/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-income-categories--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-income-categories--id-"
|
|
onclick="tryItOut('PUTapi-v1-income-categories--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-income-categories--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-income-categories--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-income-categories--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/income-categories/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/income-categories/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-income-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-income-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-income-categories--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the income category. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>categoryName</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="categoryName" data-endpoint="PUTapi-v1-income-categories--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-income-categories--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-income-categories--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/income-categories/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/income-categories/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-income-categories--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-income-categories--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-income-categories--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-income-categories--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-income-categories--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-income-categories--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-income-categories--id-" data-method="DELETE"
|
|
data-path="api/v1/income-categories/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-income-categories--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-income-categories--id-"
|
|
onclick="tryItOut('DELETEapi-v1-income-categories--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-income-categories--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-income-categories--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-income-categories--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/income-categories/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-income-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-income-categories--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-income-categories--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the income category. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-incomes">GET api/v1/incomes</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-incomes">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/incomes" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/incomes"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-incomes">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-incomes" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-incomes"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-incomes"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-incomes" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-incomes">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-incomes" data-method="GET"
|
|
data-path="api/v1/incomes"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-incomes', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-incomes"
|
|
onclick="tryItOut('GETapi-v1-incomes');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-incomes"
|
|
onclick="cancelTryOut('GETapi-v1-incomes');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-incomes"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/incomes</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-incomes"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-incomes"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-incomes">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-incomes">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/incomes" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"income_category_id\": \"consequatur\",
|
|
\"incomeFor\": \"consequatur\",
|
|
\"referenceNo\": \"consequatur\",
|
|
\"note\": \"consequatur\",
|
|
\"payments\": [
|
|
{
|
|
\"type\": \"consequatur\",
|
|
\"amount\": 45,
|
|
\"cheque_number\": \"consequatur\"
|
|
}
|
|
]
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/incomes"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"income_category_id": "consequatur",
|
|
"incomeFor": "consequatur",
|
|
"referenceNo": "consequatur",
|
|
"note": "consequatur",
|
|
"payments": [
|
|
{
|
|
"type": "consequatur",
|
|
"amount": 45,
|
|
"cheque_number": "consequatur"
|
|
}
|
|
]
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-incomes">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-incomes" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-incomes"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-incomes"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-incomes" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-incomes">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-incomes" data-method="POST"
|
|
data-path="api/v1/incomes"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-incomes', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-incomes"
|
|
onclick="tryItOut('POSTapi-v1-incomes');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-incomes"
|
|
onclick="cancelTryOut('POSTapi-v1-incomes');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-incomes"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/incomes</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-incomes"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-incomes"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>income_category_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="income_category_id" data-endpoint="POSTapi-v1-incomes"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the income_categories table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>incomeFor</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="incomeFor" data-endpoint="POSTapi-v1-incomes"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>referenceNo</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="referenceNo" data-endpoint="POSTapi-v1-incomes"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>note</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="note" data-endpoint="POSTapi-v1-incomes"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>payments</code></b>
|
|
<small>object[]</small>
|
|
|
|
|
|
<br>
|
|
<p>Must have at least 1 items.</p>
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="payments.0.type" data-endpoint="POSTapi-v1-incomes"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>amount</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="payments.0.amount" data-endpoint="POSTapi-v1-incomes"
|
|
value="45"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Example: <code>45</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>cheque_number</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="payments.0.cheque_number" data-endpoint="POSTapi-v1-incomes"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</details>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-banners">GET api/v1/banners</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-banners">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/banners" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/banners"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-banners">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-banners" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-banners"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-banners"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-banners" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-banners">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-banners" data-method="GET"
|
|
data-path="api/v1/banners"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-banners', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-banners"
|
|
onclick="tryItOut('GETapi-v1-banners');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-banners"
|
|
onclick="cancelTryOut('GETapi-v1-banners');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-banners"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/banners</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-banners"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-banners"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-lang">GET api/v1/lang</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-lang">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/lang" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/lang"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-lang">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-lang" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-lang"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-lang"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-lang" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-lang">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-lang" data-method="GET"
|
|
data-path="api/v1/lang"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-lang', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-lang"
|
|
onclick="tryItOut('GETapi-v1-lang');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-lang"
|
|
onclick="cancelTryOut('GETapi-v1-lang');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-lang"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/lang</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-lang"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-lang"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-lang">POST api/v1/lang</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-lang">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/lang" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"lang\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/lang"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"lang": "vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-lang">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-lang" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-lang"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-lang"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-lang" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-lang">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-lang" data-method="POST"
|
|
data-path="api/v1/lang"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-lang', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-lang"
|
|
onclick="tryItOut('POSTapi-v1-lang');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-lang"
|
|
onclick="cancelTryOut('POSTapi-v1-lang');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-lang"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/lang</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-lang"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-lang"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>lang</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="lang" data-endpoint="POSTapi-v1-lang"
|
|
value="vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 30 characters. Must be at least 1 character. Example: <code>vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-profile">GET api/v1/profile</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-profile">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/profile" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/profile"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-profile">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-profile" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-profile"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-profile"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-profile" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-profile">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-profile" data-method="GET"
|
|
data-path="api/v1/profile"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-profile', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-profile"
|
|
onclick="tryItOut('GETapi-v1-profile');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-profile"
|
|
onclick="cancelTryOut('GETapi-v1-profile');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-profile"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/profile</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-profile"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-profile"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-profile">POST api/v1/profile</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-profile">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/profile" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "name=vmqeopfuudtdsufvyvddq"\
|
|
--form "email=kunde.eloisa@example.com"\
|
|
--form "image=@/tmp/phpNbjGeM" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/profile"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('name', 'vmqeopfuudtdsufvyvddq');
|
|
body.append('email', 'kunde.eloisa@example.com');
|
|
body.append('image', document.querySelector('input[name="image"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-profile">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-profile" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-profile"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-profile"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-profile" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-profile">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-profile" data-method="POST"
|
|
data-path="api/v1/profile"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-profile', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-profile"
|
|
onclick="tryItOut('POSTapi-v1-profile');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-profile"
|
|
onclick="cancelTryOut('POSTapi-v1-profile');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-profile"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/profile</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-profile"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-profile"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-profile"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 250 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-profile"
|
|
value="kunde.eloisa@example.com"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Example: <code>kunde.eloisa@example.com</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>image</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="image" data-endpoint="POSTapi-v1-profile"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Must not be greater than 1048 kilobytes. Example: <code>/tmp/phpNbjGeM</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-plans">GET api/v1/plans</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-plans">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/plans" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/plans"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-plans">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-plans" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-plans"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-plans"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-plans" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-plans">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-plans" data-method="GET"
|
|
data-path="api/v1/plans"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-plans', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-plans"
|
|
onclick="tryItOut('GETapi-v1-plans');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-plans"
|
|
onclick="cancelTryOut('GETapi-v1-plans');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-plans"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/plans</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-plans"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-plans"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-subscribes">GET api/v1/subscribes</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-subscribes">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/subscribes" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/subscribes"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-subscribes">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-subscribes" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-subscribes"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-subscribes"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-subscribes" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-subscribes">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-subscribes" data-method="GET"
|
|
data-path="api/v1/subscribes"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-subscribes', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-subscribes"
|
|
onclick="tryItOut('GETapi-v1-subscribes');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-subscribes"
|
|
onclick="cancelTryOut('GETapi-v1-subscribes');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-subscribes"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/subscribes</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-subscribes"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-subscribes"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-currencies">GET api/v1/currencies</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-currencies">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/currencies" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/currencies"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-currencies">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-currencies" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-currencies"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-currencies"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-currencies" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-currencies">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-currencies" data-method="GET"
|
|
data-path="api/v1/currencies"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-currencies', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-currencies"
|
|
onclick="tryItOut('GETapi-v1-currencies');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-currencies"
|
|
onclick="cancelTryOut('GETapi-v1-currencies');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-currencies"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/currencies</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-currencies"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-currencies"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-currencies--id-">GET api/v1/currencies/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-currencies--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/currencies/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/currencies/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-currencies--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-currencies--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-currencies--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-currencies--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-currencies--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-currencies--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-currencies--id-" data-method="GET"
|
|
data-path="api/v1/currencies/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-currencies--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-currencies--id-"
|
|
onclick="tryItOut('GETapi-v1-currencies--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-currencies--id-"
|
|
onclick="cancelTryOut('GETapi-v1-currencies--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-currencies--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/currencies/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-currencies--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-currencies--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-currencies--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the currency. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-vats">GET api/v1/vats</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-vats">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/vats" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/vats"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-vats">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-vats" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-vats"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-vats"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-vats" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-vats">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-vats" data-method="GET"
|
|
data-path="api/v1/vats"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-vats', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-vats"
|
|
onclick="tryItOut('GETapi-v1-vats');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-vats"
|
|
onclick="cancelTryOut('GETapi-v1-vats');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-vats"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/vats</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-vats"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-vats"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-vats">POST api/v1/vats</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-vats">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/vats" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"rate\": 11613.31890586
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/vats"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"rate": 11613.31890586
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-vats">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-vats" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-vats"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-vats"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-vats" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-vats">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-vats" data-method="POST"
|
|
data-path="api/v1/vats"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-vats', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-vats"
|
|
onclick="tryItOut('POSTapi-v1-vats');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-vats"
|
|
onclick="cancelTryOut('POSTapi-v1-vats');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-vats"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/vats</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-vats"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-vats"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-vats"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>vat_ids</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="vat_ids" data-endpoint="POSTapi-v1-vats"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>rate</code> is <code>null</code>.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>rate</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="rate" data-endpoint="POSTapi-v1-vats"
|
|
value="11613.31890586"
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>rate</code> is <code>null</code>. Example: <code>11613.31890586</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-vats--id-">PUT api/v1/vats/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-vats--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/vats/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"rate\": 11613.31890586
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/vats/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"rate": 11613.31890586
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-vats--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-vats--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-vats--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-vats--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-vats--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-vats--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-vats--id-" data-method="PUT"
|
|
data-path="api/v1/vats/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-vats--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-vats--id-"
|
|
onclick="tryItOut('PUTapi-v1-vats--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-vats--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-vats--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-vats--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/vats/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/vats/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-vats--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-vats--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="PUTapi-v1-vats--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the vat. Example: <code>17</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-vats--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>vat_ids</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="vat_ids" data-endpoint="PUTapi-v1-vats--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>rate</code> is <code>null</code>.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>rate</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="rate" data-endpoint="PUTapi-v1-vats--id-"
|
|
value="11613.31890586"
|
|
data-component="body">
|
|
<br>
|
|
<p>This field is required when <code>rate</code> is <code>null</code>. Example: <code>11613.31890586</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-vats--id-">DELETE api/v1/vats/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-vats--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/vats/17" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/vats/17"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-vats--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-vats--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-vats--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-vats--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-vats--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-vats--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-vats--id-" data-method="DELETE"
|
|
data-path="api/v1/vats/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-vats--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-vats--id-"
|
|
onclick="tryItOut('DELETEapi-v1-vats--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-vats--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-vats--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-vats--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/vats/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-vats--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-vats--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>integer</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="id" data-endpoint="DELETEapi-v1-vats--id-"
|
|
value="17"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the vat. Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-payment-types">GET api/v1/payment-types</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-payment-types">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/payment-types" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/payment-types"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-payment-types">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-payment-types" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-payment-types"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-payment-types"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-payment-types" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-payment-types">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-payment-types" data-method="GET"
|
|
data-path="api/v1/payment-types"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-payment-types', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-payment-types"
|
|
onclick="tryItOut('GETapi-v1-payment-types');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-payment-types"
|
|
onclick="cancelTryOut('GETapi-v1-payment-types');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-payment-types"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/payment-types</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-payment-types"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-payment-types"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-payment-types">POST api/v1/payment-types</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-payment-types">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/payment-types" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/payment-types"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-payment-types">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-payment-types" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-payment-types"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-payment-types"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-payment-types" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-payment-types">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-payment-types" data-method="POST"
|
|
data-path="api/v1/payment-types"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-payment-types', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-payment-types"
|
|
onclick="tryItOut('POSTapi-v1-payment-types');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-payment-types"
|
|
onclick="cancelTryOut('POSTapi-v1-payment-types');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-payment-types"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/payment-types</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-payment-types"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-payment-types"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-payment-types"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-payment-types--id-">PUT api/v1/payment-types/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-payment-types--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/payment-types/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/payment-types/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-payment-types--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-payment-types--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-payment-types--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-payment-types--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-payment-types--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-payment-types--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-payment-types--id-" data-method="PUT"
|
|
data-path="api/v1/payment-types/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-payment-types--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-payment-types--id-"
|
|
onclick="tryItOut('PUTapi-v1-payment-types--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-payment-types--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-payment-types--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-payment-types--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/payment-types/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/payment-types/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-payment-types--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-payment-types--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-payment-types--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the payment type. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-payment-types--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-payment-types--id-">DELETE api/v1/payment-types/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-payment-types--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/payment-types/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/payment-types/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-payment-types--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-payment-types--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-payment-types--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-payment-types--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-payment-types--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-payment-types--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-payment-types--id-" data-method="DELETE"
|
|
data-path="api/v1/payment-types/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-payment-types--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-payment-types--id-"
|
|
onclick="tryItOut('DELETEapi-v1-payment-types--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-payment-types--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-payment-types--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-payment-types--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/payment-types/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-payment-types--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-payment-types--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-payment-types--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the payment type. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-product-models">GET api/v1/product-models</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-product-models">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/product-models" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/product-models"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-product-models">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-product-models" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-product-models"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-product-models"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-product-models" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-product-models">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-product-models" data-method="GET"
|
|
data-path="api/v1/product-models"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-product-models', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-product-models"
|
|
onclick="tryItOut('GETapi-v1-product-models');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-product-models"
|
|
onclick="cancelTryOut('GETapi-v1-product-models');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-product-models"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/product-models</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-product-models"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-product-models"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-product-models">POST api/v1/product-models</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-product-models">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/product-models" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/product-models"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-product-models">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-product-models" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-product-models"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-product-models"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-product-models" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-product-models">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-product-models" data-method="POST"
|
|
data-path="api/v1/product-models"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-product-models', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-product-models"
|
|
onclick="tryItOut('POSTapi-v1-product-models');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-product-models"
|
|
onclick="cancelTryOut('POSTapi-v1-product-models');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-product-models"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/product-models</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-product-models"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-product-models"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-product-models"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-product-models--id-">PUT api/v1/product-models/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-product-models--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/product-models/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/product-models/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-product-models--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-product-models--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-product-models--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-product-models--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-product-models--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-product-models--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-product-models--id-" data-method="PUT"
|
|
data-path="api/v1/product-models/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-product-models--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-product-models--id-"
|
|
onclick="tryItOut('PUTapi-v1-product-models--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-product-models--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-product-models--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-product-models--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/product-models/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/product-models/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-product-models--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-product-models--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-product-models--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the product model. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-product-models--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-product-models--id-">DELETE api/v1/product-models/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-product-models--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/product-models/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/product-models/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-product-models--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-product-models--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-product-models--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-product-models--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-product-models--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-product-models--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-product-models--id-" data-method="DELETE"
|
|
data-path="api/v1/product-models/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-product-models--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-product-models--id-"
|
|
onclick="tryItOut('DELETEapi-v1-product-models--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-product-models--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-product-models--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-product-models--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/product-models/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-product-models--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-product-models--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-product-models--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the product model. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-variations">GET api/v1/variations</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-variations">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/variations" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/variations"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-variations">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-variations" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-variations"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-variations"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-variations" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-variations">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-variations" data-method="GET"
|
|
data-path="api/v1/variations"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-variations', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-variations"
|
|
onclick="tryItOut('GETapi-v1-variations');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-variations"
|
|
onclick="cancelTryOut('GETapi-v1-variations');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-variations"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/variations</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-variations"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-variations"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-variations">POST api/v1/variations</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-variations">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/variations" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"values\": \"consequatur\",
|
|
\"status\": 1
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/variations"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"values": "consequatur",
|
|
"status": 1
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-variations">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-variations" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-variations"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-variations"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-variations" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-variations">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-variations" data-method="POST"
|
|
data-path="api/v1/variations"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-variations', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-variations"
|
|
onclick="tryItOut('POSTapi-v1-variations');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-variations"
|
|
onclick="cancelTryOut('POSTapi-v1-variations');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-variations"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/variations</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-variations"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-variations"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-variations"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>values</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="values" data-endpoint="POSTapi-v1-variations"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>status</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="status" data-endpoint="POSTapi-v1-variations"
|
|
value="1"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>1</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>0</code></li> <li><code>1</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-variations--id-">PUT api/v1/variations/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-variations--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/variations/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"values\": \"consequatur\",
|
|
\"status\": 1
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/variations/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"values": "consequatur",
|
|
"status": 1
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-variations--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-variations--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-variations--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-variations--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-variations--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-variations--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-variations--id-" data-method="PUT"
|
|
data-path="api/v1/variations/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-variations--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-variations--id-"
|
|
onclick="tryItOut('PUTapi-v1-variations--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-variations--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-variations--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-variations--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/variations/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/variations/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-variations--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-variations--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-variations--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the variation. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-variations--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>values</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="values" data-endpoint="PUTapi-v1-variations--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>status</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="status" data-endpoint="PUTapi-v1-variations--id-"
|
|
value="1"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>1</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>0</code></li> <li><code>1</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-variations--id-">DELETE api/v1/variations/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-variations--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/variations/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/variations/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-variations--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-variations--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-variations--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-variations--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-variations--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-variations--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-variations--id-" data-method="DELETE"
|
|
data-path="api/v1/variations/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-variations--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-variations--id-"
|
|
onclick="tryItOut('DELETEapi-v1-variations--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-variations--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-variations--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-variations--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/variations/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-variations--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-variations--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-variations--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the variation. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-racks">GET api/v1/racks</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-racks">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/racks" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/racks"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-racks">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-racks" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-racks"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-racks"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-racks" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-racks">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-racks" data-method="GET"
|
|
data-path="api/v1/racks"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-racks', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-racks"
|
|
onclick="tryItOut('GETapi-v1-racks');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-racks"
|
|
onclick="cancelTryOut('GETapi-v1-racks');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-racks"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/racks</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-racks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-racks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-racks">POST api/v1/racks</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-racks">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/racks" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"status\": 0
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/racks"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"status": 0
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-racks">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-racks" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-racks"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-racks"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-racks" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-racks">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-racks" data-method="POST"
|
|
data-path="api/v1/racks"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-racks', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-racks"
|
|
onclick="tryItOut('POSTapi-v1-racks');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-racks"
|
|
onclick="cancelTryOut('POSTapi-v1-racks');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-racks"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/racks</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-racks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-racks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>shelf_id</code></b>
|
|
<small>string[]</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="shelf_id[0]" data-endpoint="POSTapi-v1-racks"
|
|
data-component="body">
|
|
<input type="text" style="display: none"
|
|
name="shelf_id[1]" data-endpoint="POSTapi-v1-racks"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the shelves table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-racks"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>status</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="status" data-endpoint="POSTapi-v1-racks"
|
|
value="0"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>0</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>0</code></li> <li><code>1</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-racks--id-">PUT api/v1/racks/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-racks--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/racks/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"status\": 0
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/racks/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"status": 0
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-racks--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-racks--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-racks--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-racks--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-racks--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-racks--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-racks--id-" data-method="PUT"
|
|
data-path="api/v1/racks/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-racks--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-racks--id-"
|
|
onclick="tryItOut('PUTapi-v1-racks--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-racks--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-racks--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-racks--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/racks/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/racks/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-racks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-racks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-racks--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the rack. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>shelf_id</code></b>
|
|
<small>string[]</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="shelf_id[0]" data-endpoint="PUTapi-v1-racks--id-"
|
|
data-component="body">
|
|
<input type="text" style="display: none"
|
|
name="shelf_id[1]" data-endpoint="PUTapi-v1-racks--id-"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the shelves table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-racks--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>status</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="status" data-endpoint="PUTapi-v1-racks--id-"
|
|
value="0"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>0</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>0</code></li> <li><code>1</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-racks--id-">DELETE api/v1/racks/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-racks--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/racks/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/racks/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-racks--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-racks--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-racks--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-racks--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-racks--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-racks--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-racks--id-" data-method="DELETE"
|
|
data-path="api/v1/racks/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-racks--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-racks--id-"
|
|
onclick="tryItOut('DELETEapi-v1-racks--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-racks--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-racks--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-racks--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/racks/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-racks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-racks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-racks--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the rack. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-shelfs">GET api/v1/shelfs</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-shelfs">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/shelfs" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/shelfs"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-shelfs">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-shelfs" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-shelfs"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-shelfs"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-shelfs" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-shelfs">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-shelfs" data-method="GET"
|
|
data-path="api/v1/shelfs"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-shelfs', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-shelfs"
|
|
onclick="tryItOut('GETapi-v1-shelfs');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-shelfs"
|
|
onclick="cancelTryOut('GETapi-v1-shelfs');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-shelfs"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/shelfs</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-shelfs"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-shelfs"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-shelfs">POST api/v1/shelfs</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-shelfs">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/shelfs" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"status\": 0
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/shelfs"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"status": 0
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-shelfs">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-shelfs" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-shelfs"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-shelfs"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-shelfs" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-shelfs">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-shelfs" data-method="POST"
|
|
data-path="api/v1/shelfs"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-shelfs', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-shelfs"
|
|
onclick="tryItOut('POSTapi-v1-shelfs');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-shelfs"
|
|
onclick="cancelTryOut('POSTapi-v1-shelfs');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-shelfs"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/shelfs</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-shelfs"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-shelfs"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-shelfs"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>status</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="status" data-endpoint="POSTapi-v1-shelfs"
|
|
value="0"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>0</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>0</code></li> <li><code>1</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-shelfs--id-">PUT api/v1/shelfs/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-shelfs--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/shelfs/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"status\": 0
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/shelfs/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"status": 0
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-shelfs--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-shelfs--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-shelfs--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-shelfs--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-shelfs--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-shelfs--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-shelfs--id-" data-method="PUT"
|
|
data-path="api/v1/shelfs/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-shelfs--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-shelfs--id-"
|
|
onclick="tryItOut('PUTapi-v1-shelfs--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-shelfs--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-shelfs--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-shelfs--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/shelfs/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/shelfs/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-shelfs--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-shelfs--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-shelfs--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the shelf. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-shelfs--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>status</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="status" data-endpoint="PUTapi-v1-shelfs--id-"
|
|
value="0"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>0</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>0</code></li> <li><code>1</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-shelfs--id-">DELETE api/v1/shelfs/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-shelfs--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/shelfs/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/shelfs/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-shelfs--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-shelfs--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-shelfs--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-shelfs--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-shelfs--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-shelfs--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-shelfs--id-" data-method="DELETE"
|
|
data-path="api/v1/shelfs/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-shelfs--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-shelfs--id-"
|
|
onclick="tryItOut('DELETEapi-v1-shelfs--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-shelfs--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-shelfs--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-shelfs--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/shelfs/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-shelfs--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-shelfs--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-shelfs--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the shelf. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-banks">GET api/v1/banks</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-banks">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/banks" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/banks"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-banks">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-banks" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-banks"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-banks"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-banks" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-banks">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-banks" data-method="GET"
|
|
data-path="api/v1/banks"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-banks', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-banks"
|
|
onclick="tryItOut('GETapi-v1-banks');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-banks"
|
|
onclick="cancelTryOut('GETapi-v1-banks');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-banks"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/banks</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-banks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-banks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-banks">POST api/v1/banks</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-banks">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/banks" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"opening_balance\": 1,
|
|
\"opening_date\": \"2026-04-25T14:39:34\",
|
|
\"show_in_invoice\": true,
|
|
\"meta\": {
|
|
\"account_number\": \"niihfqcoynlazghdtqtqx\",
|
|
\"routing_number\": \"bajwbpilpmufinllwloau\",
|
|
\"upi_id\": \"ydlsmsjuryvojcybzvrby\",
|
|
\"bank_name\": \"ickznkygloigmkwxphlva\",
|
|
\"account_holder\": \"zjrcnfbaqywuxhgjjmzux\",
|
|
\"branch\": \"jubqouzswiwxtrkimfcat\"
|
|
}
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/banks"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"opening_balance": 1,
|
|
"opening_date": "2026-04-25T14:39:34",
|
|
"show_in_invoice": true,
|
|
"meta": {
|
|
"account_number": "niihfqcoynlazghdtqtqx",
|
|
"routing_number": "bajwbpilpmufinllwloau",
|
|
"upi_id": "ydlsmsjuryvojcybzvrby",
|
|
"bank_name": "ickznkygloigmkwxphlva",
|
|
"account_holder": "zjrcnfbaqywuxhgjjmzux",
|
|
"branch": "jubqouzswiwxtrkimfcat"
|
|
}
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-banks">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-banks" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-banks"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-banks"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-banks" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-banks">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-banks" data-method="POST"
|
|
data-path="api/v1/banks"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-banks', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-banks"
|
|
onclick="tryItOut('POSTapi-v1-banks');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-banks"
|
|
onclick="cancelTryOut('POSTapi-v1-banks');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-banks"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/banks</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-banks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-banks"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-banks"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>branch_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="branch_id" data-endpoint="POSTapi-v1-banks"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the branches table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>opening_balance</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="opening_balance" data-endpoint="POSTapi-v1-banks"
|
|
value="1"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Example: <code>1</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>opening_date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="opening_date" data-endpoint="POSTapi-v1-banks"
|
|
value="2026-04-25T14:39:34"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:34</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_in_invoice</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="POSTapi-v1-banks" style="display: none">
|
|
<input type="radio" name="show_in_invoice"
|
|
value="true"
|
|
data-endpoint="POSTapi-v1-banks"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="POSTapi-v1-banks" style="display: none">
|
|
<input type="radio" name="show_in_invoice"
|
|
value="false"
|
|
data-endpoint="POSTapi-v1-banks"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>true</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>meta</code></b>
|
|
<small>object</small>
|
|
<i>optional</i>
|
|
|
|
<br>
|
|
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>account_number</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.account_number" data-endpoint="POSTapi-v1-banks"
|
|
value="niihfqcoynlazghdtqtqx"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>niihfqcoynlazghdtqtqx</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>routing_number</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.routing_number" data-endpoint="POSTapi-v1-banks"
|
|
value="bajwbpilpmufinllwloau"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>bajwbpilpmufinllwloau</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>upi_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.upi_id" data-endpoint="POSTapi-v1-banks"
|
|
value="ydlsmsjuryvojcybzvrby"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>ydlsmsjuryvojcybzvrby</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>bank_name</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.bank_name" data-endpoint="POSTapi-v1-banks"
|
|
value="ickznkygloigmkwxphlva"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>ickznkygloigmkwxphlva</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>account_holder</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.account_holder" data-endpoint="POSTapi-v1-banks"
|
|
value="zjrcnfbaqywuxhgjjmzux"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>zjrcnfbaqywuxhgjjmzux</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>branch</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.branch" data-endpoint="POSTapi-v1-banks"
|
|
value="jubqouzswiwxtrkimfcat"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>jubqouzswiwxtrkimfcat</code></p>
|
|
</div>
|
|
</details>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-banks--id-">GET api/v1/banks/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-banks--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/banks/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/banks/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-banks--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-banks--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-banks--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-banks--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-banks--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-banks--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-banks--id-" data-method="GET"
|
|
data-path="api/v1/banks/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-banks--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-banks--id-"
|
|
onclick="tryItOut('GETapi-v1-banks--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-banks--id-"
|
|
onclick="cancelTryOut('GETapi-v1-banks--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-banks--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/banks/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-banks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-banks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-banks--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the bank. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-banks--id-">PUT api/v1/banks/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-banks--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/banks/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"opening_balance\": 1,
|
|
\"opening_date\": \"2026-04-25T14:39:34\",
|
|
\"show_in_invoice\": true,
|
|
\"meta\": {
|
|
\"account_number\": \"niihfqcoynlazghdtqtqx\",
|
|
\"routing_number\": \"bajwbpilpmufinllwloau\",
|
|
\"upi_id\": \"ydlsmsjuryvojcybzvrby\",
|
|
\"bank_name\": \"ickznkygloigmkwxphlva\",
|
|
\"account_holder\": \"zjrcnfbaqywuxhgjjmzux\",
|
|
\"branch\": \"jubqouzswiwxtrkimfcat\"
|
|
}
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/banks/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"opening_balance": 1,
|
|
"opening_date": "2026-04-25T14:39:34",
|
|
"show_in_invoice": true,
|
|
"meta": {
|
|
"account_number": "niihfqcoynlazghdtqtqx",
|
|
"routing_number": "bajwbpilpmufinllwloau",
|
|
"upi_id": "ydlsmsjuryvojcybzvrby",
|
|
"bank_name": "ickznkygloigmkwxphlva",
|
|
"account_holder": "zjrcnfbaqywuxhgjjmzux",
|
|
"branch": "jubqouzswiwxtrkimfcat"
|
|
}
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-banks--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-banks--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-banks--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-banks--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-banks--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-banks--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-banks--id-" data-method="PUT"
|
|
data-path="api/v1/banks/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-banks--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-banks--id-"
|
|
onclick="tryItOut('PUTapi-v1-banks--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-banks--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-banks--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-banks--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/banks/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/banks/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the bank. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>branch_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="branch_id" data-endpoint="PUTapi-v1-banks--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the branches table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>opening_balance</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="opening_balance" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="1"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Example: <code>1</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>opening_date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="opening_date" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="2026-04-25T14:39:34"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:34</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_in_invoice</code></b>
|
|
<small>boolean</small>
|
|
<i>optional</i>
|
|
|
|
<label data-endpoint="PUTapi-v1-banks--id-" style="display: none">
|
|
<input type="radio" name="show_in_invoice"
|
|
value="true"
|
|
data-endpoint="PUTapi-v1-banks--id-"
|
|
data-component="body" >
|
|
<code>true</code>
|
|
</label>
|
|
<label data-endpoint="PUTapi-v1-banks--id-" style="display: none">
|
|
<input type="radio" name="show_in_invoice"
|
|
value="false"
|
|
data-endpoint="PUTapi-v1-banks--id-"
|
|
data-component="body" >
|
|
<code>false</code>
|
|
</label>
|
|
<br>
|
|
<p>Example: <code>true</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<details>
|
|
<summary style="padding-bottom: 10px;">
|
|
<b style="line-height: 2;"><code>meta</code></b>
|
|
<small>object</small>
|
|
<i>optional</i>
|
|
|
|
<br>
|
|
|
|
</summary>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>account_number</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.account_number" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="niihfqcoynlazghdtqtqx"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>niihfqcoynlazghdtqtqx</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>routing_number</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.routing_number" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="bajwbpilpmufinllwloau"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>bajwbpilpmufinllwloau</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>upi_id</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.upi_id" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="ydlsmsjuryvojcybzvrby"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>ydlsmsjuryvojcybzvrby</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>bank_name</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.bank_name" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="ickznkygloigmkwxphlva"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>ickznkygloigmkwxphlva</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>account_holder</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.account_holder" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="zjrcnfbaqywuxhgjjmzux"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>zjrcnfbaqywuxhgjjmzux</code></p>
|
|
</div>
|
|
<div style="margin-left: 14px; clear: unset;">
|
|
<b style="line-height: 2;"><code>branch</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="meta.branch" data-endpoint="PUTapi-v1-banks--id-"
|
|
value="jubqouzswiwxtrkimfcat"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>jubqouzswiwxtrkimfcat</code></p>
|
|
</div>
|
|
</details>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-banks--id-">DELETE api/v1/banks/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-banks--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/banks/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/banks/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-banks--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-banks--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-banks--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-banks--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-banks--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-banks--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-banks--id-" data-method="DELETE"
|
|
data-path="api/v1/banks/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-banks--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-banks--id-"
|
|
onclick="tryItOut('DELETEapi-v1-banks--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-banks--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-banks--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-banks--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/banks/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-banks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-banks--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-banks--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the bank. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-bank-transactions">GET api/v1/bank-transactions</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-bank-transactions">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/bank-transactions" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/bank-transactions"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-bank-transactions">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-bank-transactions" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-bank-transactions"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-bank-transactions"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-bank-transactions" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-bank-transactions">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-bank-transactions" data-method="GET"
|
|
data-path="api/v1/bank-transactions"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-bank-transactions', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-bank-transactions"
|
|
onclick="tryItOut('GETapi-v1-bank-transactions');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-bank-transactions"
|
|
onclick="cancelTryOut('GETapi-v1-bank-transactions');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-bank-transactions"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/bank-transactions</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-bank-transactions"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-bank-transactions"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-bank-transactions">POST api/v1/bank-transactions</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-bank-transactions">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/bank-transactions" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "from=consequatur"\
|
|
--form "type=debit"\
|
|
--form "transaction_type=bank_to_bank"\
|
|
--form "amount=16"\
|
|
--form "date=2026-04-25T14:39:34"\
|
|
--form "note=consequatur"\
|
|
--form "image=@/tmp/phphaGPjb" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/bank-transactions"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('from', 'consequatur');
|
|
body.append('type', 'debit');
|
|
body.append('transaction_type', 'bank_to_bank');
|
|
body.append('amount', '16');
|
|
body.append('date', '2026-04-25T14:39:34');
|
|
body.append('note', 'consequatur');
|
|
body.append('image', document.querySelector('input[name="image"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-bank-transactions">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-bank-transactions" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-bank-transactions"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-bank-transactions"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-bank-transactions" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-bank-transactions">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-bank-transactions" data-method="POST"
|
|
data-path="api/v1/bank-transactions"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-bank-transactions', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-bank-transactions"
|
|
onclick="tryItOut('POSTapi-v1-bank-transactions');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-bank-transactions"
|
|
onclick="cancelTryOut('POSTapi-v1-bank-transactions');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-bank-transactions"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/bank-transactions</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-bank-transactions"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-bank-transactions"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>from</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="from" data-endpoint="POSTapi-v1-bank-transactions"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the payment_types table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="type" data-endpoint="POSTapi-v1-bank-transactions"
|
|
value="debit"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>debit</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>credit</code></li> <li><code>debit</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>transaction_type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="transaction_type" data-endpoint="POSTapi-v1-bank-transactions"
|
|
value="bank_to_bank"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>bank_to_bank</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>bank_to_bank</code></li> <li><code>bank_to_cash</code></li> <li><code>adjust_bank</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>amount</code></b>
|
|
<small>number</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="amount" data-endpoint="POSTapi-v1-bank-transactions"
|
|
value="16"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0.01. Example: <code>16</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="date" data-endpoint="POSTapi-v1-bank-transactions"
|
|
value="2026-04-25T14:39:34"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:34</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>image</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="image" data-endpoint="POSTapi-v1-bank-transactions"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phphaGPjb</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>note</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="note" data-endpoint="POSTapi-v1-bank-transactions"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-bank-transactions--id-">GET api/v1/bank-transactions/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-bank-transactions--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/bank-transactions/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/bank-transactions/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-bank-transactions--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-bank-transactions--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-bank-transactions--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-bank-transactions--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-bank-transactions--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-bank-transactions--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-bank-transactions--id-" data-method="GET"
|
|
data-path="api/v1/bank-transactions/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-bank-transactions--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-bank-transactions--id-"
|
|
onclick="tryItOut('GETapi-v1-bank-transactions--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-bank-transactions--id-"
|
|
onclick="cancelTryOut('GETapi-v1-bank-transactions--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-bank-transactions--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/bank-transactions/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-bank-transactions--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-bank-transactions--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-bank-transactions--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the bank transaction. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-bank-transactions--id-">PUT api/v1/bank-transactions/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-bank-transactions--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/bank-transactions/consequatur" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "from=consequatur"\
|
|
--form "type=debit"\
|
|
--form "transaction_type=bank_to_bank"\
|
|
--form "amount=16"\
|
|
--form "date=2026-04-25T14:39:34"\
|
|
--form "note=consequatur"\
|
|
--form "image=@/tmp/phpoAohAc" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/bank-transactions/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('from', 'consequatur');
|
|
body.append('type', 'debit');
|
|
body.append('transaction_type', 'bank_to_bank');
|
|
body.append('amount', '16');
|
|
body.append('date', '2026-04-25T14:39:34');
|
|
body.append('note', 'consequatur');
|
|
body.append('image', document.querySelector('input[name="image"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-bank-transactions--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-bank-transactions--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-bank-transactions--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-bank-transactions--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-bank-transactions--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-bank-transactions--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-bank-transactions--id-" data-method="PUT"
|
|
data-path="api/v1/bank-transactions/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-bank-transactions--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-bank-transactions--id-"
|
|
onclick="tryItOut('PUTapi-v1-bank-transactions--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-bank-transactions--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-bank-transactions--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-bank-transactions--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/bank-transactions/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/bank-transactions/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the bank transaction. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>from</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="from" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the payment_types table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="type" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value="debit"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>debit</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>credit</code></li> <li><code>debit</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>transaction_type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="transaction_type" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value="bank_to_bank"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>bank_to_bank</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>bank_to_bank</code></li> <li><code>bank_to_cash</code></li> <li><code>adjust_bank</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>amount</code></b>
|
|
<small>number</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="amount" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value="16"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0.01. Example: <code>16</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="date" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value="2026-04-25T14:39:34"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:34</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>image</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="image" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phpoAohAc</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>note</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="note" data-endpoint="PUTapi-v1-bank-transactions--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-bank-transactions--id-">DELETE api/v1/bank-transactions/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-bank-transactions--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/bank-transactions/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/bank-transactions/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-bank-transactions--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-bank-transactions--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-bank-transactions--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-bank-transactions--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-bank-transactions--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-bank-transactions--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-bank-transactions--id-" data-method="DELETE"
|
|
data-path="api/v1/bank-transactions/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-bank-transactions--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-bank-transactions--id-"
|
|
onclick="tryItOut('DELETEapi-v1-bank-transactions--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-bank-transactions--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-bank-transactions--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-bank-transactions--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/bank-transactions/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-bank-transactions--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-bank-transactions--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-bank-transactions--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the bank transaction. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-cashes">GET api/v1/cashes</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-cashes">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/cashes" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/cashes"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-cashes">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-cashes" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-cashes"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-cashes"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-cashes" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-cashes">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-cashes" data-method="GET"
|
|
data-path="api/v1/cashes"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-cashes', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-cashes"
|
|
onclick="tryItOut('GETapi-v1-cashes');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-cashes"
|
|
onclick="cancelTryOut('GETapi-v1-cashes');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-cashes"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/cashes</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-cashes"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-cashes"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-cashes">POST api/v1/cashes</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-cashes">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/cashes" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "type=debit"\
|
|
--form "transaction_type=adjust_cash"\
|
|
--form "amount=56"\
|
|
--form "date=2026-04-25T14:39:35"\
|
|
--form "note=consequatur"\
|
|
--form "image=@/tmp/phpddcDDf" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/cashes"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('type', 'debit');
|
|
body.append('transaction_type', 'adjust_cash');
|
|
body.append('amount', '56');
|
|
body.append('date', '2026-04-25T14:39:35');
|
|
body.append('note', 'consequatur');
|
|
body.append('image', document.querySelector('input[name="image"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-cashes">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-cashes" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-cashes"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-cashes"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-cashes" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-cashes">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-cashes" data-method="POST"
|
|
data-path="api/v1/cashes"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-cashes', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-cashes"
|
|
onclick="tryItOut('POSTapi-v1-cashes');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-cashes"
|
|
onclick="cancelTryOut('POSTapi-v1-cashes');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-cashes"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/cashes</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-cashes"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-cashes"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>to</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="to" data-endpoint="POSTapi-v1-cashes"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the payment_types table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="type" data-endpoint="POSTapi-v1-cashes"
|
|
value="debit"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>debit</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>credit</code></li> <li><code>debit</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>transaction_type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="transaction_type" data-endpoint="POSTapi-v1-cashes"
|
|
value="adjust_cash"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>adjust_cash</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>cash_to_bank</code></li> <li><code>adjust_cash</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>amount</code></b>
|
|
<small>number</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="amount" data-endpoint="POSTapi-v1-cashes"
|
|
value="56"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0.01. Example: <code>56</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="date" data-endpoint="POSTapi-v1-cashes"
|
|
value="2026-04-25T14:39:35"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:35</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>image</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="image" data-endpoint="POSTapi-v1-cashes"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phpddcDDf</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>note</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="note" data-endpoint="POSTapi-v1-cashes"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-cashes--id-">GET api/v1/cashes/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-cashes--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/cashes/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/cashes/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-cashes--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-cashes--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-cashes--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-cashes--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-cashes--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-cashes--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-cashes--id-" data-method="GET"
|
|
data-path="api/v1/cashes/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-cashes--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-cashes--id-"
|
|
onclick="tryItOut('GETapi-v1-cashes--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-cashes--id-"
|
|
onclick="cancelTryOut('GETapi-v1-cashes--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-cashes--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/cashes/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-cashes--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-cashes--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-cashes--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the cash. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-cashes--id-">PUT api/v1/cashes/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-cashes--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/cashes/consequatur" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "type=debit"\
|
|
--form "transaction_type=adjust_cash"\
|
|
--form "amount=56"\
|
|
--form "date=2026-04-25T14:39:35"\
|
|
--form "note=consequatur"\
|
|
--form "image=@/tmp/phpBmCmLf" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/cashes/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('type', 'debit');
|
|
body.append('transaction_type', 'adjust_cash');
|
|
body.append('amount', '56');
|
|
body.append('date', '2026-04-25T14:39:35');
|
|
body.append('note', 'consequatur');
|
|
body.append('image', document.querySelector('input[name="image"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-cashes--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-cashes--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-cashes--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-cashes--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-cashes--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-cashes--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-cashes--id-" data-method="PUT"
|
|
data-path="api/v1/cashes/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-cashes--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-cashes--id-"
|
|
onclick="tryItOut('PUTapi-v1-cashes--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-cashes--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-cashes--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-cashes--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/cashes/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/cashes/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the cash. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>to</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="to" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the payment_types table.</p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>type</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="type" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value="debit"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>debit</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>credit</code></li> <li><code>debit</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>transaction_type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="transaction_type" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value="adjust_cash"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>adjust_cash</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>cash_to_bank</code></li> <li><code>adjust_cash</code></li></ul>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>amount</code></b>
|
|
<small>number</small>
|
|
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="amount" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value="56"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0.01. Example: <code>56</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="date" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value="2026-04-25T14:39:35"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:35</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>image</code></b>
|
|
<small>file</small>
|
|
<i>optional</i>
|
|
|
|
<input type="file" style="display: none"
|
|
name="image" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be an image. Example: <code>/tmp/phpBmCmLf</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>note</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="note" data-endpoint="PUTapi-v1-cashes--id-"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-cashes--id-">DELETE api/v1/cashes/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-cashes--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/cashes/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/cashes/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-cashes--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-cashes--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-cashes--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-cashes--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-cashes--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-cashes--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-cashes--id-" data-method="DELETE"
|
|
data-path="api/v1/cashes/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-cashes--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-cashes--id-"
|
|
onclick="tryItOut('DELETEapi-v1-cashes--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-cashes--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-cashes--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-cashes--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/cashes/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-cashes--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-cashes--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-cashes--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the cash. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-cheques">GET api/v1/cheques</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-cheques">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/cheques" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/cheques"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-cheques">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-cheques" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-cheques"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-cheques"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-cheques" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-cheques">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-cheques" data-method="GET"
|
|
data-path="api/v1/cheques"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-cheques', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-cheques"
|
|
onclick="tryItOut('GETapi-v1-cheques');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-cheques"
|
|
onclick="cancelTryOut('GETapi-v1-cheques');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-cheques"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/cheques</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-cheques"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-cheques"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-cheques">POST api/v1/cheques</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-cheques">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/cheques" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"transaction_id\": \"consequatur\",
|
|
\"date\": \"2026-04-25T14:39:35\",
|
|
\"note\": \"consequatur\",
|
|
\"payment_type\": \"consequatur\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/cheques"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"transaction_id": "consequatur",
|
|
"date": "2026-04-25T14:39:35",
|
|
"note": "consequatur",
|
|
"payment_type": "consequatur"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-cheques">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-cheques" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-cheques"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-cheques"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-cheques" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-cheques">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-cheques" data-method="POST"
|
|
data-path="api/v1/cheques"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-cheques', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-cheques"
|
|
onclick="tryItOut('POSTapi-v1-cheques');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-cheques"
|
|
onclick="cancelTryOut('POSTapi-v1-cheques');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-cheques"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/cheques</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-cheques"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-cheques"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>transaction_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="transaction_id" data-endpoint="POSTapi-v1-cheques"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>The <code>id</code> of an existing record in the transactions table. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>date</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="date" data-endpoint="POSTapi-v1-cheques"
|
|
value="2026-04-25T14:39:35"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid date. Example: <code>2026-04-25T14:39:35</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>note</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="note" data-endpoint="POSTapi-v1-cheques"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>payment_type</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="payment_type" data-endpoint="POSTapi-v1-cheques"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-cheques--id-">GET api/v1/cheques/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-cheques--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/cheques/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/cheques/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-cheques--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-cheques--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-cheques--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-cheques--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-cheques--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-cheques--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-cheques--id-" data-method="GET"
|
|
data-path="api/v1/cheques/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-cheques--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-cheques--id-"
|
|
onclick="tryItOut('GETapi-v1-cheques--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-cheques--id-"
|
|
onclick="cancelTryOut('GETapi-v1-cheques--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-cheques--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/cheques/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-cheques--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-cheques--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-cheques--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the cheque. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-cheque-reopen--id-">POST api/v1/cheque-reopen/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-cheque-reopen--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/cheque-reopen/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/cheque-reopen/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-cheque-reopen--id-">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-cheque-reopen--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-cheque-reopen--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-cheque-reopen--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-cheque-reopen--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-cheque-reopen--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-cheque-reopen--id-" data-method="POST"
|
|
data-path="api/v1/cheque-reopen/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-cheque-reopen--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-cheque-reopen--id-"
|
|
onclick="tryItOut('POSTapi-v1-cheque-reopen--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-cheque-reopen--id-"
|
|
onclick="cancelTryOut('POSTapi-v1-cheque-reopen--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-cheque-reopen--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/cheque-reopen/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-cheque-reopen--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-cheque-reopen--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="POSTapi-v1-cheque-reopen--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the cheque reopen. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-product-settings">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-product-settings">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/product-settings" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/product-settings"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-product-settings">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-product-settings" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-product-settings"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-product-settings"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-product-settings" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-product-settings">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-product-settings" data-method="GET"
|
|
data-path="api/v1/product-settings"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-product-settings', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-product-settings"
|
|
onclick="tryItOut('GETapi-v1-product-settings');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-product-settings"
|
|
onclick="cancelTryOut('GETapi-v1-product-settings');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-product-settings"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/product-settings</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-product-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-product-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-product-settings">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-product-settings">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/product-settings" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"show_product_name\": 17,
|
|
\"show_product_price\": 17,
|
|
\"show_product_code\": 17,
|
|
\"show_product_stock\": 17,
|
|
\"show_product_sale_price\": 17,
|
|
\"show_product_dealer_price\": 17,
|
|
\"show_product_wholesale_price\": 17,
|
|
\"show_product_unit\": 17,
|
|
\"show_product_brand\": 17,
|
|
\"show_product_category\": 17,
|
|
\"show_product_manufacturer\": 17,
|
|
\"show_product_image\": 17,
|
|
\"show_expire_date\": 17,
|
|
\"show_alert_qty\": 17,
|
|
\"show_vat_id\": 17,
|
|
\"show_vat_type\": 17,
|
|
\"show_exclusive_price\": 17,
|
|
\"show_inclusive_price\": 17,
|
|
\"show_profit_percent\": 17,
|
|
\"show_capacity\": 17,
|
|
\"show_weight\": 17,
|
|
\"show_color\": 17,
|
|
\"show_type\": 17,
|
|
\"show_size\": 17,
|
|
\"show_batch_no\": 17,
|
|
\"show_mfg_date\": 17,
|
|
\"show_model_no\": 17,
|
|
\"default_sale_price\": 17,
|
|
\"default_wholesale_price\": 17,
|
|
\"default_dealer_price\": 17,
|
|
\"show_product_type_single\": 17,
|
|
\"show_product_type_variant\": 17,
|
|
\"show_product_type_combo\": 17,
|
|
\"show_warehouse\": 17,
|
|
\"show_action\": 17,
|
|
\"show_rack\": 17,
|
|
\"show_shelf\": 17,
|
|
\"show_guarantee\": 17,
|
|
\"show_warranty\": 17,
|
|
\"show_serial\": 17,
|
|
\"default_batch_no\": 17,
|
|
\"default_expired_date\": 17,
|
|
\"default_mfg_date\": 17,
|
|
\"expire_date_type\": 17,
|
|
\"mfg_date_type\": 17,
|
|
\"show_product_batch_no\": 17,
|
|
\"show_product_expire_date\": 17
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/product-settings"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"show_product_name": 17,
|
|
"show_product_price": 17,
|
|
"show_product_code": 17,
|
|
"show_product_stock": 17,
|
|
"show_product_sale_price": 17,
|
|
"show_product_dealer_price": 17,
|
|
"show_product_wholesale_price": 17,
|
|
"show_product_unit": 17,
|
|
"show_product_brand": 17,
|
|
"show_product_category": 17,
|
|
"show_product_manufacturer": 17,
|
|
"show_product_image": 17,
|
|
"show_expire_date": 17,
|
|
"show_alert_qty": 17,
|
|
"show_vat_id": 17,
|
|
"show_vat_type": 17,
|
|
"show_exclusive_price": 17,
|
|
"show_inclusive_price": 17,
|
|
"show_profit_percent": 17,
|
|
"show_capacity": 17,
|
|
"show_weight": 17,
|
|
"show_color": 17,
|
|
"show_type": 17,
|
|
"show_size": 17,
|
|
"show_batch_no": 17,
|
|
"show_mfg_date": 17,
|
|
"show_model_no": 17,
|
|
"default_sale_price": 17,
|
|
"default_wholesale_price": 17,
|
|
"default_dealer_price": 17,
|
|
"show_product_type_single": 17,
|
|
"show_product_type_variant": 17,
|
|
"show_product_type_combo": 17,
|
|
"show_warehouse": 17,
|
|
"show_action": 17,
|
|
"show_rack": 17,
|
|
"show_shelf": 17,
|
|
"show_guarantee": 17,
|
|
"show_warranty": 17,
|
|
"show_serial": 17,
|
|
"default_batch_no": 17,
|
|
"default_expired_date": 17,
|
|
"default_mfg_date": 17,
|
|
"expire_date_type": 17,
|
|
"mfg_date_type": 17,
|
|
"show_product_batch_no": 17,
|
|
"show_product_expire_date": 17
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-product-settings">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-product-settings" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-product-settings"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-product-settings"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-product-settings" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-product-settings">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-product-settings" data-method="POST"
|
|
data-path="api/v1/product-settings"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-product-settings', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-product-settings"
|
|
onclick="tryItOut('POSTapi-v1-product-settings');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-product-settings"
|
|
onclick="cancelTryOut('POSTapi-v1-product-settings');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-product-settings"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/product-settings</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-product-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-product-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_name</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_name" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_price</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_price" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_code</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_code" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_stock</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_stock" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_sale_price</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_sale_price" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_dealer_price</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_dealer_price" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_wholesale_price</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_wholesale_price" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_unit</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_unit" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_brand</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_brand" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_category</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_category" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_manufacturer</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_manufacturer" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_image</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_image" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_expire_date</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_expire_date" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_alert_qty</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_alert_qty" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_vat_id</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_vat_id" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_vat_type</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_vat_type" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_exclusive_price</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_exclusive_price" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_inclusive_price</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_inclusive_price" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_profit_percent</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_profit_percent" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_capacity</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_capacity" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_weight</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_weight" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_color</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_color" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_type</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_type" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_size</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_size" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_batch_no</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_batch_no" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_mfg_date</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_mfg_date" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_model_no</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_model_no" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>default_sale_price</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="default_sale_price" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>default_wholesale_price</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="default_wholesale_price" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>default_dealer_price</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="default_dealer_price" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_type_single</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_type_single" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_type_variant</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_type_variant" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_type_combo</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_type_combo" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_warehouse</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_warehouse" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_action</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_action" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_rack</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_rack" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_shelf</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_shelf" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_guarantee</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_guarantee" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_warranty</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_warranty" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_serial</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_serial" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>default_batch_no</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="default_batch_no" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>default_expired_date</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="default_expired_date" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>default_mfg_date</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="default_mfg_date" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>expire_date_type</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="expire_date_type" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>mfg_date_type</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="mfg_date_type" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_batch_no</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_batch_no" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>show_product_expire_date</code></b>
|
|
<small>integer</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="show_product_expire_date" data-endpoint="POSTapi-v1-product-settings"
|
|
value="17"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>17</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-product-generate-code">GET api/v1/product/generate-code</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-product-generate-code">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/product/generate-code" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/product/generate-code"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-product-generate-code">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-product-generate-code" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-product-generate-code"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-product-generate-code"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-product-generate-code" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-product-generate-code">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-product-generate-code" data-method="GET"
|
|
data-path="api/v1/product/generate-code"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-product-generate-code', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-product-generate-code"
|
|
onclick="tryItOut('GETapi-v1-product-generate-code');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-product-generate-code"
|
|
onclick="cancelTryOut('GETapi-v1-product-generate-code');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-product-generate-code"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/product/generate-code</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-product-generate-code"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-product-generate-code"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-bulk-uploads">POST api/v1/bulk-uploads</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-bulk-uploads">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/bulk-uploads" \
|
|
--header "Content-Type: multipart/form-data" \
|
|
--header "Accept: application/json" \
|
|
--form "file=@/tmp/phpALAOJh" </code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/bulk-uploads"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "multipart/form-data",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
const body = new FormData();
|
|
body.append('file', document.querySelector('input[name="file"]').files[0]);
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-bulk-uploads">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-bulk-uploads" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-bulk-uploads"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-bulk-uploads"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-bulk-uploads" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-bulk-uploads">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-bulk-uploads" data-method="POST"
|
|
data-path="api/v1/bulk-uploads"
|
|
data-authed="0"
|
|
data-hasfiles="1"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-bulk-uploads', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-bulk-uploads"
|
|
onclick="tryItOut('POSTapi-v1-bulk-uploads');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-bulk-uploads"
|
|
onclick="cancelTryOut('POSTapi-v1-bulk-uploads');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-bulk-uploads"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/bulk-uploads</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-bulk-uploads"
|
|
value="multipart/form-data"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>multipart/form-data</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-bulk-uploads"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>file</code></b>
|
|
<small>file</small>
|
|
|
|
|
|
<input type="file" style="display: none"
|
|
name="file" data-endpoint="POSTapi-v1-bulk-uploads"
|
|
value=""
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a file. Example: <code>/tmp/phpALAOJh</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-change-password">POST api/v1/change-password</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-change-password">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/change-password" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"current_password\": \"consequatur\",
|
|
\"password\": \"[2UZ5ij-e\\/dl4\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/change-password"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"current_password": "consequatur",
|
|
"password": "[2UZ5ij-e\/dl4"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-change-password">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-change-password" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-change-password"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-change-password"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-change-password" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-change-password">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-change-password" data-method="POST"
|
|
data-path="api/v1/change-password"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-change-password', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-change-password"
|
|
onclick="tryItOut('POSTapi-v1-change-password');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-change-password"
|
|
onclick="cancelTryOut('POSTapi-v1-change-password');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-change-password"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/change-password</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-change-password"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-change-password"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>current_password</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="current_password" data-endpoint="POSTapi-v1-change-password"
|
|
value="consequatur"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>consequatur</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>password</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="password" data-endpoint="POSTapi-v1-change-password"
|
|
value="[2UZ5ij-e/dl4"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 6 characters. Example: <code>[2UZ5ij-e/dl4</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-new-invoice">GET api/v1/new-invoice</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-new-invoice">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/new-invoice" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"platform\": \"due_collects\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/new-invoice"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"platform": "due_collects"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-new-invoice">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-new-invoice" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-new-invoice"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-new-invoice"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-new-invoice" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-new-invoice">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-new-invoice" data-method="GET"
|
|
data-path="api/v1/new-invoice"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-new-invoice', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-new-invoice"
|
|
onclick="tryItOut('GETapi-v1-new-invoice');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-new-invoice"
|
|
onclick="cancelTryOut('GETapi-v1-new-invoice');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-new-invoice"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/new-invoice</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-new-invoice"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-new-invoice"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>platform</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="platform" data-endpoint="GETapi-v1-new-invoice"
|
|
value="due_collects"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>due_collects</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>sales</code></li> <li><code>purchases</code></li> <li><code>due_collects</code></li> <li><code>sales_return</code></li> <li><code>purchases_return</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-invoice-settings">GET api/v1/invoice-settings</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-invoice-settings">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/invoice-settings" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/invoice-settings"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-invoice-settings">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-invoice-settings" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-invoice-settings"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-invoice-settings"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-invoice-settings" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-invoice-settings">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-invoice-settings" data-method="GET"
|
|
data-path="api/v1/invoice-settings"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-invoice-settings', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-invoice-settings"
|
|
onclick="tryItOut('GETapi-v1-invoice-settings');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-invoice-settings"
|
|
onclick="cancelTryOut('GETapi-v1-invoice-settings');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-invoice-settings"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/invoice-settings</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-invoice-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-invoice-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-invoice-settings-update">POST api/v1/invoice-settings/update</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-invoice-settings-update">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/invoice-settings/update" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"invoice_size\": \"vmqeopfuudtdsufvyvddq\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/invoice-settings/update"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"invoice_size": "vmqeopfuudtdsufvyvddq"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-invoice-settings-update">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-invoice-settings-update" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-invoice-settings-update"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-invoice-settings-update"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-invoice-settings-update" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-invoice-settings-update">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-invoice-settings-update" data-method="POST"
|
|
data-path="api/v1/invoice-settings/update"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-invoice-settings-update', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-invoice-settings-update"
|
|
onclick="tryItOut('POSTapi-v1-invoice-settings-update');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-invoice-settings-update"
|
|
onclick="cancelTryOut('POSTapi-v1-invoice-settings-update');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-invoice-settings-update"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/invoice-settings/update</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-invoice-settings-update"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-invoice-settings-update"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>invoice_size</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="invoice_size" data-endpoint="POSTapi-v1-invoice-settings-update"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 100 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>a4</code></li> <li><code>3_inch_80mm</code></li> <li><code>2_inch_58mm</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-business-delete">POST api/v1/business-delete</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-business-delete">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/business-delete" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"password\": \"O[2UZ5ij-e\\/dl4m{o,\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/business-delete"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"password": "O[2UZ5ij-e\/dl4m{o,"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-business-delete">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-business-delete" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-business-delete"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-business-delete"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-business-delete" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-business-delete">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-business-delete" data-method="POST"
|
|
data-path="api/v1/business-delete"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-business-delete', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-business-delete"
|
|
onclick="tryItOut('POSTapi-v1-business-delete');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-business-delete"
|
|
onclick="cancelTryOut('POSTapi-v1-business-delete');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-business-delete"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/business-delete</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-business-delete"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-business-delete"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>password</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="password" data-endpoint="POSTapi-v1-business-delete"
|
|
value="O[2UZ5ij-e/dl4m{o,"
|
|
data-component="body">
|
|
<br>
|
|
<p>Example: <code>O[2UZ5ij-e/dl4m{o,</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-party-ledger--party_id-">GET api/v1/party-ledger/{party_id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-party-ledger--party_id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/party-ledger/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/party-ledger/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-party-ledger--party_id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-party-ledger--party_id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-party-ledger--party_id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-party-ledger--party_id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-party-ledger--party_id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-party-ledger--party_id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-party-ledger--party_id-" data-method="GET"
|
|
data-path="api/v1/party-ledger/{party_id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-party-ledger--party_id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-party-ledger--party_id-"
|
|
onclick="tryItOut('GETapi-v1-party-ledger--party_id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-party-ledger--party_id-"
|
|
onclick="cancelTryOut('GETapi-v1-party-ledger--party_id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-party-ledger--party_id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/party-ledger/{party_id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-party-ledger--party_id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-party-ledger--party_id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>party_id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="party_id" data-endpoint="GETapi-v1-party-ledger--party_id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the party. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-money-receipt--id-">GET api/v1/money-receipt/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-money-receipt--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/money-receipt/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/money-receipt/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-money-receipt--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-money-receipt--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-money-receipt--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-money-receipt--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-money-receipt--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-money-receipt--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-money-receipt--id-" data-method="GET"
|
|
data-path="api/v1/money-receipt/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-money-receipt--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-money-receipt--id-"
|
|
onclick="tryItOut('GETapi-v1-money-receipt--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-money-receipt--id-"
|
|
onclick="cancelTryOut('GETapi-v1-money-receipt--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-money-receipt--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/money-receipt/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-money-receipt--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-money-receipt--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-money-receipt--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the money receipt. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-currency-settings">GET api/v1/currency-settings</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-currency-settings">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/currency-settings" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/currency-settings"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-currency-settings">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-currency-settings" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-currency-settings"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-currency-settings"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-currency-settings" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-currency-settings">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-currency-settings" data-method="GET"
|
|
data-path="api/v1/currency-settings"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-currency-settings', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-currency-settings"
|
|
onclick="tryItOut('GETapi-v1-currency-settings');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-currency-settings"
|
|
onclick="cancelTryOut('GETapi-v1-currency-settings');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-currency-settings"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/currency-settings</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-currency-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-currency-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-currency-settings">POST api/v1/currency-settings</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-currency-settings">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/currency-settings" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"currency\": \"vmqeopfuudtdsufvyvddq\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/currency-settings"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"currency": "vmqeopfuudtdsufvyvddq"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-currency-settings">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-currency-settings" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-currency-settings"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-currency-settings"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-currency-settings" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-currency-settings">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-currency-settings" data-method="POST"
|
|
data-path="api/v1/currency-settings"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-currency-settings', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-currency-settings"
|
|
onclick="tryItOut('POSTapi-v1-currency-settings');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-currency-settings"
|
|
onclick="cancelTryOut('POSTapi-v1-currency-settings');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-currency-settings"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/currency-settings</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-currency-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-currency-settings"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>currency</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="currency" data-endpoint="POSTapi-v1-currency-settings"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 100 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
Must be one of:
|
|
<ul style="list-style-type: square;"><li><code>us</code></li> <li><code>european</code></li></ul>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-transactions">GET api/v1/transactions</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-transactions">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/transactions" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/transactions"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-transactions">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-transactions" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-transactions"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-transactions"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-transactions" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-transactions">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-transactions" data-method="GET"
|
|
data-path="api/v1/transactions"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-transactions', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-transactions"
|
|
onclick="tryItOut('GETapi-v1-transactions');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-transactions"
|
|
onclick="cancelTryOut('GETapi-v1-transactions');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-transactions"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/transactions</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-transactions"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-transactions"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-sign-out">GET api/v1/sign-out</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-sign-out">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/sign-out" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/sign-out"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-sign-out">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-sign-out" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-sign-out"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-sign-out"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-sign-out" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-sign-out">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-sign-out" data-method="GET"
|
|
data-path="api/v1/sign-out"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-sign-out', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-sign-out"
|
|
onclick="tryItOut('GETapi-v1-sign-out');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-sign-out"
|
|
onclick="cancelTryOut('GETapi-v1-sign-out');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-sign-out"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/sign-out</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-sign-out"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-sign-out"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-refresh-token">GET api/v1/refresh-token</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-refresh-token">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/refresh-token" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/refresh-token"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-refresh-token">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-refresh-token" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-refresh-token"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-refresh-token"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-refresh-token" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-refresh-token">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-refresh-token" data-method="GET"
|
|
data-path="api/v1/refresh-token"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-refresh-token', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-refresh-token"
|
|
onclick="tryItOut('GETapi-v1-refresh-token');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-refresh-token"
|
|
onclick="cancelTryOut('GETapi-v1-refresh-token');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-refresh-token"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/refresh-token</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-refresh-token"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-refresh-token"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-branches">Display a listing of the resource.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-branches">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/branches" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/branches"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-branches">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-branches" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-branches"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-branches"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-branches" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-branches">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-branches" data-method="GET"
|
|
data-path="api/v1/branches"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-branches', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-branches"
|
|
onclick="tryItOut('GETapi-v1-branches');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-branches"
|
|
onclick="cancelTryOut('GETapi-v1-branches');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-branches"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/branches</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-branches"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-branches"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-branches">Store a newly created resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-branches">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/branches" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"phone\": \"amniihfqcoynlazgh\",
|
|
\"email\": \"roob.mona@example.org\",
|
|
\"address\": \"xbajwbpilpmufinllwloa\",
|
|
\"branchOpeningBalance\": 72,
|
|
\"description\": \"Qui ducimus nihil laudantium nihil autem omnis cum molestiae.\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/branches"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"phone": "amniihfqcoynlazgh",
|
|
"email": "roob.mona@example.org",
|
|
"address": "xbajwbpilpmufinllwloa",
|
|
"branchOpeningBalance": 72,
|
|
"description": "Qui ducimus nihil laudantium nihil autem omnis cum molestiae."
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-branches">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-branches" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-branches"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-branches"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-branches" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-branches">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-branches" data-method="POST"
|
|
data-path="api/v1/branches"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-branches', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-branches"
|
|
onclick="tryItOut('POSTapi-v1-branches');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-branches"
|
|
onclick="cancelTryOut('POSTapi-v1-branches');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-branches"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/branches</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-branches"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-branches"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-branches"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>phone</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="phone" data-endpoint="POSTapi-v1-branches"
|
|
value="amniihfqcoynlazgh"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 20 characters. Example: <code>amniihfqcoynlazgh</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-branches"
|
|
value="roob.mona@example.org"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Must not be greater than 255 characters. Example: <code>roob.mona@example.org</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>address</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="address" data-endpoint="POSTapi-v1-branches"
|
|
value="xbajwbpilpmufinllwloa"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>xbajwbpilpmufinllwloa</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>branchOpeningBalance</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="branchOpeningBalance" data-endpoint="POSTapi-v1-branches"
|
|
value="72"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Example: <code>72</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>description</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="description" data-endpoint="POSTapi-v1-branches"
|
|
value="Qui ducimus nihil laudantium nihil autem omnis cum molestiae."
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 1000 characters. Example: <code>Qui ducimus nihil laudantium nihil autem omnis cum molestiae.</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-branches--id-">Update the specified resource in storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-branches--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/branches/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"phone\": \"amniihfqcoynlazgh\",
|
|
\"email\": \"roob.mona@example.org\",
|
|
\"address\": \"xbajwbpilpmufinllwloa\",
|
|
\"branchOpeningBalance\": 72,
|
|
\"description\": \"Qui ducimus nihil laudantium nihil autem omnis cum molestiae.\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/branches/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"phone": "amniihfqcoynlazgh",
|
|
"email": "roob.mona@example.org",
|
|
"address": "xbajwbpilpmufinllwloa",
|
|
"branchOpeningBalance": 72,
|
|
"description": "Qui ducimus nihil laudantium nihil autem omnis cum molestiae."
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-branches--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-branches--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-branches--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-branches--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-branches--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-branches--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-branches--id-" data-method="PUT"
|
|
data-path="api/v1/branches/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-branches--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-branches--id-"
|
|
onclick="tryItOut('PUTapi-v1-branches--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-branches--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-branches--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-branches--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/branches/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/branches/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-branches--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-branches--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-branches--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the branch. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-branches--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>phone</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="phone" data-endpoint="PUTapi-v1-branches--id-"
|
|
value="amniihfqcoynlazgh"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 20 characters. Example: <code>amniihfqcoynlazgh</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="PUTapi-v1-branches--id-"
|
|
value="roob.mona@example.org"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Must not be greater than 255 characters. Example: <code>roob.mona@example.org</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>address</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="address" data-endpoint="PUTapi-v1-branches--id-"
|
|
value="xbajwbpilpmufinllwloa"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>xbajwbpilpmufinllwloa</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>branchOpeningBalance</code></b>
|
|
<small>number</small>
|
|
<i>optional</i>
|
|
|
|
<input type="number" style="display: none"
|
|
step="any" name="branchOpeningBalance" data-endpoint="PUTapi-v1-branches--id-"
|
|
value="72"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be at least 0. Example: <code>72</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>description</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="description" data-endpoint="PUTapi-v1-branches--id-"
|
|
value="Qui ducimus nihil laudantium nihil autem omnis cum molestiae."
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 1000 characters. Example: <code>Qui ducimus nihil laudantium nihil autem omnis cum molestiae.</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-branches--id-">Remove the specified resource from storage.</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-branches--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/branches/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/branches/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-branches--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-branches--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-branches--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-branches--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-branches--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-branches--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-branches--id-" data-method="DELETE"
|
|
data-path="api/v1/branches/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-branches--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-branches--id-"
|
|
onclick="tryItOut('DELETEapi-v1-branches--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-branches--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-branches--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-branches--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/branches/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-branches--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-branches--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-branches--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the branch. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-switch-branch--id-">GET api/v1/switch-branch/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-switch-branch--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/switch-branch/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/switch-branch/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-switch-branch--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-switch-branch--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-switch-branch--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-switch-branch--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-switch-branch--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-switch-branch--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-switch-branch--id-" data-method="GET"
|
|
data-path="api/v1/switch-branch/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-switch-branch--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-switch-branch--id-"
|
|
onclick="tryItOut('GETapi-v1-switch-branch--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-switch-branch--id-"
|
|
onclick="cancelTryOut('GETapi-v1-switch-branch--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-switch-branch--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/switch-branch/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-switch-branch--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-switch-branch--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-switch-branch--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the switch branch. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-exit-branch--id-">GET api/v1/exit-branch/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-exit-branch--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/exit-branch/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/exit-branch/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-exit-branch--id-">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-exit-branch--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-exit-branch--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-exit-branch--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-exit-branch--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-exit-branch--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-exit-branch--id-" data-method="GET"
|
|
data-path="api/v1/exit-branch/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-exit-branch--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-exit-branch--id-"
|
|
onclick="tryItOut('GETapi-v1-exit-branch--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-exit-branch--id-"
|
|
onclick="cancelTryOut('GETapi-v1-exit-branch--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-exit-branch--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/exit-branch/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-exit-branch--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-exit-branch--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="GETapi-v1-exit-branch--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the exit branch. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-GETapi-v1-warehouses">GET api/v1/warehouses</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-GETapi-v1-warehouses">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request GET \
|
|
--get "http://localhost:8080/api/v1/warehouses" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/warehouses"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "GET",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-GETapi-v1-warehouses">
|
|
<blockquote>
|
|
<p>Example response (401):</p>
|
|
</blockquote>
|
|
<details class="annotation">
|
|
<summary style="cursor: pointer;">
|
|
<small onclick="textContent = parentElement.parentElement.open ? 'Show headers' : 'Hide headers'">Show headers</small>
|
|
</summary>
|
|
<pre><code class="language-http">cache-control: no-cache, private
|
|
content-type: application/json
|
|
access-control-allow-origin: *
|
|
</code></pre></details> <pre>
|
|
|
|
<code class="language-json" style="max-height: 300px;">{
|
|
"message": "Unauthenticated."
|
|
}</code>
|
|
</pre>
|
|
</span>
|
|
<span id="execution-results-GETapi-v1-warehouses" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-GETapi-v1-warehouses"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-GETapi-v1-warehouses"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-GETapi-v1-warehouses" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-GETapi-v1-warehouses">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-GETapi-v1-warehouses" data-method="GET"
|
|
data-path="api/v1/warehouses"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('GETapi-v1-warehouses', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-GETapi-v1-warehouses"
|
|
onclick="tryItOut('GETapi-v1-warehouses');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-GETapi-v1-warehouses"
|
|
onclick="cancelTryOut('GETapi-v1-warehouses');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-GETapi-v1-warehouses"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-green">GET</small>
|
|
<b><code>api/v1/warehouses</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="GETapi-v1-warehouses"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="GETapi-v1-warehouses"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-POSTapi-v1-warehouses">POST api/v1/warehouses</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-POSTapi-v1-warehouses">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request POST \
|
|
"http://localhost:8080/api/v1/warehouses" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"phone\": \"amniihfqcoynlazgh\",
|
|
\"address\": \"dtqtqxbajwbpilpmufinl\",
|
|
\"email\": \"imogene.mante@example.com\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/warehouses"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"phone": "amniihfqcoynlazgh",
|
|
"address": "dtqtqxbajwbpilpmufinl",
|
|
"email": "imogene.mante@example.com"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "POST",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-POSTapi-v1-warehouses">
|
|
</span>
|
|
<span id="execution-results-POSTapi-v1-warehouses" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-POSTapi-v1-warehouses"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-POSTapi-v1-warehouses"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-POSTapi-v1-warehouses" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-POSTapi-v1-warehouses">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-POSTapi-v1-warehouses" data-method="POST"
|
|
data-path="api/v1/warehouses"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('POSTapi-v1-warehouses', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-POSTapi-v1-warehouses"
|
|
onclick="tryItOut('POSTapi-v1-warehouses');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-POSTapi-v1-warehouses"
|
|
onclick="cancelTryOut('POSTapi-v1-warehouses');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-POSTapi-v1-warehouses"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-black">POST</small>
|
|
<b><code>api/v1/warehouses</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="POSTapi-v1-warehouses"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="POSTapi-v1-warehouses"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="POSTapi-v1-warehouses"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>phone</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="phone" data-endpoint="POSTapi-v1-warehouses"
|
|
value="amniihfqcoynlazgh"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 20 characters. Example: <code>amniihfqcoynlazgh</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>address</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="address" data-endpoint="POSTapi-v1-warehouses"
|
|
value="dtqtqxbajwbpilpmufinl"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 500 characters. Example: <code>dtqtqxbajwbpilpmufinl</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="POSTapi-v1-warehouses"
|
|
value="imogene.mante@example.com"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Must not be greater than 255 characters. Example: <code>imogene.mante@example.com</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-PUTapi-v1-warehouses--id-">PUT api/v1/warehouses/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-PUTapi-v1-warehouses--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request PUT \
|
|
"http://localhost:8080/api/v1/warehouses/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json" \
|
|
--data "{
|
|
\"name\": \"vmqeopfuudtdsufvyvddq\",
|
|
\"phone\": \"amniihfqcoynlazgh\",
|
|
\"address\": \"dtqtqxbajwbpilpmufinl\",
|
|
\"email\": \"imogene.mante@example.com\"
|
|
}"
|
|
</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/warehouses/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
let body = {
|
|
"name": "vmqeopfuudtdsufvyvddq",
|
|
"phone": "amniihfqcoynlazgh",
|
|
"address": "dtqtqxbajwbpilpmufinl",
|
|
"email": "imogene.mante@example.com"
|
|
};
|
|
|
|
fetch(url, {
|
|
method: "PUT",
|
|
headers,
|
|
body: JSON.stringify(body),
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-PUTapi-v1-warehouses--id-">
|
|
</span>
|
|
<span id="execution-results-PUTapi-v1-warehouses--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-PUTapi-v1-warehouses--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-PUTapi-v1-warehouses--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-PUTapi-v1-warehouses--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-PUTapi-v1-warehouses--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-PUTapi-v1-warehouses--id-" data-method="PUT"
|
|
data-path="api/v1/warehouses/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('PUTapi-v1-warehouses--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-PUTapi-v1-warehouses--id-"
|
|
onclick="tryItOut('PUTapi-v1-warehouses--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-PUTapi-v1-warehouses--id-"
|
|
onclick="cancelTryOut('PUTapi-v1-warehouses--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-PUTapi-v1-warehouses--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-darkblue">PUT</small>
|
|
<b><code>api/v1/warehouses/{id}</code></b>
|
|
</p>
|
|
<p>
|
|
<small class="badge badge-purple">PATCH</small>
|
|
<b><code>api/v1/warehouses/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="PUTapi-v1-warehouses--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="PUTapi-v1-warehouses--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="PUTapi-v1-warehouses--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the warehouse. Example: <code>consequatur</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>Body Parameters</b></h4>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>name</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="name" data-endpoint="PUTapi-v1-warehouses--id-"
|
|
value="vmqeopfuudtdsufvyvddq"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 255 characters. Example: <code>vmqeopfuudtdsufvyvddq</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>phone</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="phone" data-endpoint="PUTapi-v1-warehouses--id-"
|
|
value="amniihfqcoynlazgh"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 20 characters. Example: <code>amniihfqcoynlazgh</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>address</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="address" data-endpoint="PUTapi-v1-warehouses--id-"
|
|
value="dtqtqxbajwbpilpmufinl"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must not be greater than 500 characters. Example: <code>dtqtqxbajwbpilpmufinl</code></p>
|
|
</div>
|
|
<div style=" padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>email</code></b>
|
|
<small>string</small>
|
|
<i>optional</i>
|
|
|
|
<input type="text" style="display: none"
|
|
name="email" data-endpoint="PUTapi-v1-warehouses--id-"
|
|
value="imogene.mante@example.com"
|
|
data-component="body">
|
|
<br>
|
|
<p>Must be a valid email address. Must not be greater than 255 characters. Example: <code>imogene.mante@example.com</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
<h2 id="endpoints-DELETEapi-v1-warehouses--id-">DELETE api/v1/warehouses/{id}</h2>
|
|
|
|
<p>
|
|
</p>
|
|
|
|
|
|
|
|
<span id="example-requests-DELETEapi-v1-warehouses--id-">
|
|
<blockquote>Example request:</blockquote>
|
|
|
|
|
|
<div class="bash-example">
|
|
<pre><code class="language-bash">curl --request DELETE \
|
|
"http://localhost:8080/api/v1/warehouses/consequatur" \
|
|
--header "Content-Type: application/json" \
|
|
--header "Accept: application/json"</code></pre></div>
|
|
|
|
|
|
<div class="javascript-example">
|
|
<pre><code class="language-javascript">const url = new URL(
|
|
"http://localhost:8080/api/v1/warehouses/consequatur"
|
|
);
|
|
|
|
const headers = {
|
|
"Content-Type": "application/json",
|
|
"Accept": "application/json",
|
|
};
|
|
|
|
|
|
fetch(url, {
|
|
method: "DELETE",
|
|
headers,
|
|
}).then(response => response.json());</code></pre></div>
|
|
|
|
</span>
|
|
|
|
<span id="example-responses-DELETEapi-v1-warehouses--id-">
|
|
</span>
|
|
<span id="execution-results-DELETEapi-v1-warehouses--id-" hidden>
|
|
<blockquote>Received response<span
|
|
id="execution-response-status-DELETEapi-v1-warehouses--id-"></span>:
|
|
</blockquote>
|
|
<pre class="json"><code id="execution-response-content-DELETEapi-v1-warehouses--id-"
|
|
data-empty-response-text="<Empty response>" style="max-height: 400px;"></code></pre>
|
|
</span>
|
|
<span id="execution-error-DELETEapi-v1-warehouses--id-" hidden>
|
|
<blockquote>Request failed with error:</blockquote>
|
|
<pre><code id="execution-error-message-DELETEapi-v1-warehouses--id-">
|
|
|
|
Tip: Check that you're properly connected to the network.
|
|
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
|
|
You can check the Dev Tools console for debugging information.</code></pre>
|
|
</span>
|
|
<form id="form-DELETEapi-v1-warehouses--id-" data-method="DELETE"
|
|
data-path="api/v1/warehouses/{id}"
|
|
data-authed="0"
|
|
data-hasfiles="0"
|
|
data-isarraybody="0"
|
|
autocomplete="off"
|
|
onsubmit="event.preventDefault(); executeTryOut('DELETEapi-v1-warehouses--id-', this);">
|
|
<h3>
|
|
Request
|
|
<button type="button"
|
|
style="background-color: #8fbcd4; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-tryout-DELETEapi-v1-warehouses--id-"
|
|
onclick="tryItOut('DELETEapi-v1-warehouses--id-');">Try it out ⚡
|
|
</button>
|
|
<button type="button"
|
|
style="background-color: #c97a7e; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-canceltryout-DELETEapi-v1-warehouses--id-"
|
|
onclick="cancelTryOut('DELETEapi-v1-warehouses--id-');" hidden>Cancel 🛑
|
|
</button>
|
|
<button type="submit"
|
|
style="background-color: #6ac174; padding: 5px 10px; border-radius: 5px; border-width: thin;"
|
|
id="btn-executetryout-DELETEapi-v1-warehouses--id-"
|
|
data-initial-text="Send Request 💥"
|
|
data-loading-text="⏱ Sending..."
|
|
hidden>Send Request 💥
|
|
</button>
|
|
</h3>
|
|
<p>
|
|
<small class="badge badge-red">DELETE</small>
|
|
<b><code>api/v1/warehouses/{id}</code></b>
|
|
</p>
|
|
<h4 class="fancy-heading-panel"><b>Headers</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Content-Type</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Content-Type" data-endpoint="DELETEapi-v1-warehouses--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>Accept</code></b>
|
|
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="Accept" data-endpoint="DELETEapi-v1-warehouses--id-"
|
|
value="application/json"
|
|
data-component="header">
|
|
<br>
|
|
<p>Example: <code>application/json</code></p>
|
|
</div>
|
|
<h4 class="fancy-heading-panel"><b>URL Parameters</b></h4>
|
|
<div style="padding-left: 28px; clear: unset;">
|
|
<b style="line-height: 2;"><code>id</code></b>
|
|
<small>string</small>
|
|
|
|
|
|
<input type="text" style="display: none"
|
|
name="id" data-endpoint="DELETEapi-v1-warehouses--id-"
|
|
value="consequatur"
|
|
data-component="url">
|
|
<br>
|
|
<p>The ID of the warehouse. Example: <code>consequatur</code></p>
|
|
</div>
|
|
</form>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="dark-box">
|
|
<div class="lang-selector">
|
|
<button type="button" class="lang-button" data-language-name="bash">bash</button>
|
|
<button type="button" class="lang-button" data-language-name="javascript">javascript</button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|