MENU navbar-image

Introduction

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>

Authenticating requests

This API is not authenticated.

Endpoints

GET api/v1/module-check

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/module-check" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (500):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 100
x-ratelimit-remaining: 99
access-control-allow-origin: *
 

{
    "message": "Server Error"
}

Request      

GET api/v1/module-check

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/sign-in

Example request:
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\"
}"

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());

Request      

POST api/v1/sign-in

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

password   string     

Example: consequatur

email   string     

Must be a valid email address. Example: carolyne.luettgen@example.org

POST api/v1/submit-otp

Example request:
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\"
}"

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());

Request      

POST api/v1/submit-otp

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

email   string     

Must be a valid email address. Example: qkunze@example.com

otp   string     

Must be at least 4 characters. Must not be greater than 15 characters. Example: opfuudtdsufvy

POST api/v1/sign-up

Example request:
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\"
}"

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());

Request      

POST api/v1/sign-up

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

password   string     

Must be at least 6 characters. Must not be greater than 100 characters. Example: OP>@;4

email   string     

Must be a valid email address. Example: kacey94@example.org

POST api/v1/resend-otp

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/resend-otp" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"qkunze@example.com\"
}"

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());

Request      

POST api/v1/resend-otp

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

email   string     

Must be a valid email address. The email of an existing record in the users table. Example: qkunze@example.com

GET api/v1/otp-settings

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/otp-settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 100
x-ratelimit-remaining: 98
access-control-allow-origin: *
 

{
    "message": "Data fetched successfully.",
    "data": []
}

Request      

GET api/v1/otp-settings

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/send-reset-code

Example request:
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\"
}"

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());

Request      

POST api/v1/send-reset-code

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

email   string     

Must be a valid email address. The email of an existing record in the users table. Example: qkunze@example.com

POST api/v1/verify-reset-code

Example request:
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\"
}"

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());

Request      

POST api/v1/verify-reset-code

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

code   integer     

Example: 17

email   string     

The email of an existing record in the users table. Example: consequatur

POST api/v1/password-reset

Example request:
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\"
}"

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());

Request      

POST api/v1/password-reset

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

email   string     

The email of an existing record in the users table. Example: consequatur

password   string     

Must be at least 4 characters. Example: [2UZ5ij-e/dl4

GET api/v1/default-lang

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/default-lang" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (200):

Show headers 
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 100
x-ratelimit-remaining: 97
access-control-allow-origin: *
 

{
    "message": "Data fetched successfully.",
    "data": ""
}

Request      

GET api/v1/default-lang

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/update-expire-date

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/update-expire-date" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/update-expire-date

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/summary

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/summary" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/summary

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/dashboard

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/dashboard" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/dashboard

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/parties

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/parties" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/parties

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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" 
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());

Request      

POST api/v1/parties

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

type   string     

Example: Retailer

Must be one of:
  • Retailer
  • Dealer
  • Wholesaler
  • Supplier
phone   string  optional    
image   file  optional    

Must be an image. Example: /tmp/phpidPlHn

address   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

credit_limit   number  optional    

Must be at least 0. Must not be greater than 999999999999.99. Example: 1

opening_balance   number  optional    

Must be at least -999999999999.99. Must not be greater than 999999999999.99. Example: 13

opening_balance_type   string     

Example: due

Must be one of:
  • due
  • advance

GET api/v1/parties/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/parties/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/parties/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the party. Example: 17

Update the specified resource in storage.

Example request:
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" 
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());

Request      

PUT api/v1/parties/{id}

PATCH api/v1/parties/{id}

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the party. Example: 17

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

type   string     

Example: Retailer

Must be one of:
  • Retailer
  • Dealer
  • Wholesaler
  • Supplier
phone   string  optional    
image   file  optional    

Must be an image. Example: /tmp/phpNhnJln

address   string  optional    

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

credit_limit   number  optional    

Must be at least 0. Must not be greater than 999999999999.99. Example: 1

opening_balance   number  optional    

Must be at least -999999999999.99. Must not be greater than 999999999999.99. Example: 13

opening_balance_type   string     

Example: due

Must be one of:
  • due
  • advance

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/parties/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/parties/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the party. Example: 17

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/users

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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\"
}"

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());

Request      

POST api/v1/users

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 30 characters. Example: vmqeopfuudtdsufvyvddq

password   string     

Must be at least 4 characters. Must not be greater than 15 characters. Example: OP>@;4

email   string     

Must be a valid email address. Example: kacey94@example.org

branch_id   string  optional    

The id of an existing record in the branches table.

Update the specified resource in storage.

Example request:
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\"
}"

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());

Request      

PUT api/v1/users/{id}

PATCH api/v1/users/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 17

Body Parameters

name   string     

Must not be greater than 30 characters. Example: vmqeopfuudtdsufvyvddq

password   string  optional    

Must be at least 4 characters. Must not be greater than 15 characters. Example: OP>@;4

branch_id   string  optional    

The id of an existing record in the branches table.

email   string  optional    

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/users/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/users/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the user. Example: 17

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/units" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/units

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/units" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

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());

Request      

POST api/v1/units

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

unitName   string  optional    

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/units/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unitName\": \"consequatur\"
}"

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());

Request      

PUT api/v1/units/{id}

PATCH api/v1/units/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the unit. Example: 17

Body Parameters

unitName   string     

Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/units/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/units/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the unit. Example: 17

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/brands" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/brands

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/brands" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

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());

Request      

POST api/v1/brands

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

brandName   string  optional    

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/brands/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"brandName\": \"consequatur\"
}"

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());

Request      

PUT api/v1/brands/{id}

PATCH api/v1/brands/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the brand. Example: 17

Body Parameters

brandName   string     

Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/brands/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/brands/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the brand. Example: 17

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

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());

Request      

POST api/v1/categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

categoryName   string  optional    

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/categories/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"categoryName\": \"consequatur\"
}"

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());

Request      

PUT api/v1/categories/{id}

PATCH api/v1/categories/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the category. Example: 17

Body Parameters

categoryName   string     

Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/categories/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/categories/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the category. Example: 17

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/products" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/products

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/products

Example request:
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" 
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());

Request      

POST api/v1/products

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

vat_id   string  optional    

The id of an existing record in the vats table.

unit_id   string  optional    

The id of an existing record in the units table.

brand_id   string  optional    

The id of an existing record in the brands table.

category_id   string  optional    

The id of an existing record in the categories table.

model_id   string  optional    

The id of an existing record in the product_models table.

vat_type   string  optional    

Example: exclusive

Must be one of:
  • inclusive
  • exclusive
productName   string     

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

productPicture   file  optional    

Must be an image. Example: /tmp/phpIlpNJB

productCode   string  optional    
alert_qty   number  optional    

Must be at least 0. Example: 73

size   string  optional    

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

type   string  optional    

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

color   string  optional    

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

weight   string  optional    

Must not be greater than 255 characters. Example: uydlsmsjuryvojcybzvrb

capacity   string  optional    

Must not be greater than 255 characters. Example: yickznkygloigmkwxphlv

productManufacturer   string  optional    

Must not be greater than 255 characters. Example: azjrcnfbaqywuxhgjjmzu

product_type   string     

Example: variant

Must be one of:
  • single
  • variant
  • combo
variation_ids   string[]  optional    

The id of an existing record in the variations table.

stocks   object[]  optional    
warehouse_id   string  optional    

The id of an existing record in the warehouses table.

productStock   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 10

exclusive_price   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 20

inclusive_price   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 2

profit_percent   number  optional    

Must not be greater than 99999999.99. Example: 16

productSalePrice   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 14

productWholeSalePrice   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 20

productDealerPrice   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 25

mfg_date   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:34

expire_date   string  optional    

Must be a valid date. Must be a date after or equal to stocks.*.mfg_date. Example: 2107-05-25

batch_no   string  optional    
combo_products   object[]  optional    

Combo validation.
stock_id   string  optional    

This field is required when product_type is combo.

quantity   number  optional    

This field is required when product_type is combo. Must be at least 1. Example: 45

GET api/v1/products/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/products/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/products/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the product. Example: consequatur

Update the specified resource in storage.

Example request:
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" 
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());

Request      

PUT api/v1/products/{id}

PATCH api/v1/products/{id}

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the product. Example: 17

Body Parameters

vat_id   string  optional    

The id of an existing record in the vats table.

unit_id   string  optional    

The id of an existing record in the units table.

brand_id   string  optional    

The id of an existing record in the brands table.

category_id   string  optional    

The id of an existing record in the categories table.

model_id   string  optional    

The id of an existing record in the product_models table.

vat_type   string  optional    

Example: exclusive

Must be one of:
  • inclusive
  • exclusive
productName   string     

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

productPicture   file  optional    

Must be an image. Example: /tmp/phphmopkB

productCode   string  optional    
alert_qty   number  optional    

Must be at least 0. Example: 73

size   string  optional    

Must not be greater than 255 characters. Example: mqeopfuudtdsufvyvddqa

type   string  optional    

Must not be greater than 255 characters. Example: mniihfqcoynlazghdtqtq

color   string  optional    

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

weight   string  optional    

Must not be greater than 255 characters. Example: uydlsmsjuryvojcybzvrb

capacity   string  optional    

Must not be greater than 255 characters. Example: yickznkygloigmkwxphlv

productManufacturer   string  optional    

Must not be greater than 255 characters. Example: azjrcnfbaqywuxhgjjmzu

product_type   string     

Example: variant

Must be one of:
  • single
  • variant
  • combo
variation_ids   string[]  optional    

The id of an existing record in the variations table.

stocks   object[]  optional    
warehouse_id   string  optional    

The id of an existing record in the warehouses table.

productStock   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 10

exclusive_price   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 20

inclusive_price   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 2

profit_percent   number  optional    

Must not be greater than 99999999.99. Example: 16

productSalePrice   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 14

productWholeSalePrice   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 20

productDealerPrice   number  optional    

Must be at least 0. Must not be greater than 99999999.99. Example: 25

mfg_date   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:34

expire_date   string  optional    

Must be a valid date. Must be a date after or equal to stocks.*.mfg_date. Example: 2107-05-25

batch_no   string  optional    
combo_products   object[]  optional    

Combo validation.
stock_id   string  optional    

This field is required when product_type is combo.

quantity   number  optional    

This field is required when product_type is combo. Must be at least 1. Example: 45

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/products/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/products/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the product. Example: 17

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/stocks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"productStock\": 17,
    \"stock_id\": \"consequatur\"
}"

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());

Request      

POST api/v1/stocks

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

productStock   integer     

Example: 17

stock_id   string     

The id of an existing record in the stocks table. Example: consequatur

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/stocks/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

PUT api/v1/stocks/{id}

PATCH api/v1/stocks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the stock. Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/stocks/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/stocks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the stock. Example: consequatur

GET api/v1/business

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/business" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/business

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/business

Example request:
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" 
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());

Request      

POST api/v1/business

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

address   string  optional    

Must not be greater than 250 characters. Example: vmqeopfuudtdsufvyvddq

companyName   string     

Must not be greater than 250 characters. Example: amniihfqcoynlazghdtqt

pictureUrl   file  optional    

Must be an image. Must not be greater than 5120 kilobytes. Example: /tmp/phpIMNggC

shopOpeningBalance   number  optional    

Example: 11613.31890586

phoneNumber   string  optional    
business_category_id   string     

The id of an existing record in the business_categories table. Example: consequatur

PUT api/v1/business/{id}

Example request:
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" 
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());

Request      

PUT api/v1/business/{id}

PATCH api/v1/business/{id}

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the business. Example: 17

Body Parameters

address   string  optional    

Must not be greater than 250 characters. Example: vmqeopfuudtdsufvyvddq

companyName   string  optional    

This field is required when sale_rounding_option is != or null. Must not be greater than 250 characters. Example: amniihfqcoynlazghdtqt

business_category_id   string  optional    

This field is required when sale_rounding_option is != or null. The id of an existing record in the business_categories table.

pictureUrl   file  optional    

Must be an image. Must not be greater than 5120 kilobytes. Example: /tmp/phpDfKmPD

show_company_name   boolean  optional    

Example: true

show_phone_number   boolean  optional    

Example: false

show_address   boolean  optional    

Example: false

show_email   boolean  optional    

Example: true

show_vat   boolean  optional    

Example: false

invoice_logo   file  optional    

Must be an image. Must not be greater than 5120 kilobytes. Example: /tmp/phpniADaD

a4_invoice_logo   file  optional    

Must be an image. Must not be greater than 5120 kilobytes. Example: /tmp/phpaHhaaD

thermal_invoice_logo   file  optional    

Must be an image. Must not be greater than 5120 kilobytes. Example: /tmp/phpihnkaD

invoice_scanner_logo   file  optional    

Must be an image. Must not be greater than 5120 kilobytes. Example: /tmp/phphfCIbD

sale_rounding_option   string  optional    

Example: nearest_whole_number

Must be one of:
  • none
  • round_up
  • nearest_whole_number
  • nearest_0.05
  • nearest_0.1
  • nearest_0.5
phoneNumber   string  optional    
invoice_size   string  optional    

Must not be greater than 100 characters. Example: bpilpmufinllwloauydls

invoice_language   string  optional    

Must not be greater than 100 characters. Example: msjuryvojcybzvrbyickz

gratitude_message   string  optional    

Must not be greater than 100 characters. Example: nkygloigmkwxphlvazjrc

warranty_void_label   string  optional    

Example: consequatur

warranty_void   string  optional    

Example: consequatur

show_note   boolean  optional    

Example: false

show_gratitude_msg   boolean  optional    

Example: true

show_invoice_scanner_logo   boolean  optional    

Example: false

show_a4_invoice_logo   boolean  optional    

Example: true

show_thermal_invoice_logo   boolean  optional    

Example: true

show_warranty   boolean  optional    

Example: true

GET api/v1/business-categories

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/business-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/business-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/purchase

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/purchase" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/purchase

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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\"
}"

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());

Request      

POST api/v1/purchase

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

products   object[]     
product_id   string     

The id of an existing record in the products table. Example: consequatur

party_id   string     

The id of an existing record in the parties table. Example: consequatur

GET api/v1/purchase/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/purchase/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/purchase/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the purchase. Example: consequatur

Update the specified resource in storage.

Example request:
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\"
}"

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());

Request      

PUT api/v1/purchase/{id}

PATCH api/v1/purchase/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the purchase. Example: 17

Body Parameters

products   object[]     
product_id   string     

The id of an existing record in the products table. Example: consequatur

party_id   string     

The id of an existing record in the parties table. Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/purchase/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/purchase/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the purchase. Example: 17

GET api/v1/sales

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/sales" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/sales

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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" 
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());

Request      

POST api/v1/sales

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

party_id   string  optional    

The id of an existing record in the parties table.

vat_id   string  optional    

The id of an existing record in the vats table.

products   string     

Example: consequatur

saleDate   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:34

image   file  optional    

Must be an image. Example: /tmp/phpKCJEeF

rounding_option   string  optional    

Example: nearest_0.05

Must be one of:
  • none
  • round_up
  • nearest_whole_number
  • nearest_0.05
  • nearest_0.1
  • nearest_0.5

GET api/v1/sales/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/sales/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/sales/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the sale. Example: consequatur

Update the specified resource in storage.

Example request:
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" 
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());

Request      

PUT api/v1/sales/{id}

PATCH api/v1/sales/{id}

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the sale. Example: consequatur

Body Parameters

party_id   string  optional    

The id of an existing record in the parties table.

vat_id   string  optional    

The id of an existing record in the vats table.

products   string     

Example: consequatur

saleDate   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:34

image   file  optional    

Must be an image. Example: /tmp/phpcpOmkF

rounding_option   string  optional    

Example: nearest_0.05

Must be one of:
  • none
  • round_up
  • nearest_whole_number
  • nearest_0.05
  • nearest_0.1
  • nearest_0.5

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/sales/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/sales/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the sale. Example: 17

GET api/v1/reports/loss-profit

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/loss-profit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/loss-profit

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/reports/cashflow

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/cashflow" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/cashflow

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/reports/balance-sheet

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/balance-sheet" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/balance-sheet

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/reports/subscription

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/subscription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/subscription

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/reports/tax

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/tax" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/tax

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/reports/bill-wise-profit

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/bill-wise-profit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/bill-wise-profit

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/reports/product-sale-history

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/product-sale-history" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/product-sale-history

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/reports/product-sale-history/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/product-sale-history/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/product-sale-history/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the product sale history. Example: consequatur

GET api/v1/reports/product-purchase-history

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/product-purchase-history" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/product-purchase-history

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/reports/product-purchase-history/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/reports/product-purchase-history/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/reports/product-purchase-history/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the product purchase history. Example: consequatur

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/sales-return" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/sales-return

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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\": []
}"

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());

Request      

POST api/v1/sales-return

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

sale_id   string     

The id of an existing record in the sales table. Example: consequatur

return_qty   object     

GET api/v1/sales-return/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/sales-return/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/sales-return/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the sales return. Example: consequatur

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/purchases-return" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/purchases-return

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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\": []
}"

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());

Request      

POST api/v1/purchases-return

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

purchase_id   string     

The id of an existing record in the purchases table. Example: consequatur

return_qty   object     

GET api/v1/purchases-return/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/purchases-return/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/purchases-return/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the purchases return. Example: consequatur

GET api/v1/invoices

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/invoices" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"party_id\": \"consequatur\"
}"

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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/invoices

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

party_id   string     

The id of an existing record in the parties table. Example: consequatur

GET api/v1/dues

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/dues" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/dues

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/dues

Example request:
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\"
}"

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());

Request      

POST api/v1/dues

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

paymentDate   string     

Example: consequatur

payDueAmount   number  optional    

Example: 11613.31890586

party_id   string     

The id of an existing record in the parties table. Example: consequatur

invoiceNumber   string  optional    

GET api/v1/invoice-wise-dues

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/invoice-wise-dues" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/invoice-wise-dues

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/collect-invoice-due

Example request:
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\"
}"

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());

Request      

POST api/v1/collect-invoice-due

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

paymentDate   string     

Example: consequatur

payDueAmount   number  optional    

Example: 11613.31890586

invoiceNumber   string     

The invoiceNumber of an existing record in the sales table. Example: consequatur

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/expense-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/expense-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/expense-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

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());

Request      

POST api/v1/expense-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

categoryName   string  optional    

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/expense-categories/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"categoryName\": \"consequatur\"
}"

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());

Request      

PUT api/v1/expense-categories/{id}

PATCH api/v1/expense-categories/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the expense category. Example: consequatur

Body Parameters

categoryName   string     

Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/expense-categories/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/expense-categories/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the expense category. Example: consequatur

GET api/v1/expenses

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/expenses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/expenses

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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
        }
    ]
}"

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());

Request      

POST api/v1/expenses

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

expense_category_id   string     

The id of an existing record in the expense_categories table. Example: consequatur

expanseFor   string  optional    

Example: consequatur

referenceNo   string  optional    

Example: consequatur

note   string  optional    

Example: consequatur

payments   object[]     

Must have at least 1 items.
type   string     

Example: consequatur

amount   number  optional    

Must be at least 0. Example: 45

GET api/v1/income-categories

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/income-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/income-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/income-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

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());

Request      

POST api/v1/income-categories

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

categoryName   string  optional    

Update the specified resource in storage.

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/income-categories/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"categoryName\": \"consequatur\"
}"

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());

Request      

PUT api/v1/income-categories/{id}

PATCH api/v1/income-categories/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the income category. Example: consequatur

Body Parameters

categoryName   string     

Example: consequatur

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/income-categories/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/income-categories/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the income category. Example: consequatur

GET api/v1/incomes

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/incomes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/incomes

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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\"
        }
    ]
}"

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());

Request      

POST api/v1/incomes

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

income_category_id   string     

The id of an existing record in the income_categories table. Example: consequatur

incomeFor   string  optional    

Example: consequatur

referenceNo   string  optional    

Example: consequatur

note   string  optional    

Example: consequatur

payments   object[]     

Must have at least 1 items.
type   string     

Example: consequatur

amount   number  optional    

Must be at least 0. Example: 45

cheque_number   string  optional    

Example: consequatur

GET api/v1/banners

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/banners" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/banners

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/lang

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/lang" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/lang

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/lang

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/lang" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"lang\": \"vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju\"
}"

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());

Request      

POST api/v1/lang

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

lang   string     

Must not be greater than 30 characters. Must be at least 1 character. Example: vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju

GET api/v1/profile

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/profile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/profile

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/profile

Example request:
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" 
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());

Request      

POST api/v1/profile

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 250 characters. Example: vmqeopfuudtdsufvyvddq

email   string     

Must be a valid email address. Example: kunde.eloisa@example.com

image   file  optional    

Must be an image. Must not be greater than 1048 kilobytes. Example: /tmp/phpNbjGeM

GET api/v1/plans

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/plans" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/plans

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/subscribes

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/subscribes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/subscribes

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/currencies

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/currencies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/currencies

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/currencies/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/currencies/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/currencies/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the currency. Example: consequatur

GET api/v1/vats

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/vats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/vats

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/vats

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/vats" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"rate\": 11613.31890586
}"

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());

Request      

POST api/v1/vats

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

vat_ids   string  optional    

This field is required when rate is null.

rate   number  optional    

This field is required when rate is null. Example: 11613.31890586

PUT api/v1/vats/{id}

Example request:
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
}"

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());

Request      

PUT api/v1/vats/{id}

PATCH api/v1/vats/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the vat. Example: 17

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

vat_ids   string  optional    

This field is required when rate is null.

rate   number  optional    

This field is required when rate is null. Example: 11613.31890586

DELETE api/v1/vats/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/vats/17" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/vats/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   integer     

The ID of the vat. Example: 17

GET api/v1/payment-types

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/payment-types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/payment-types

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/payment-types

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/payment-types" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"

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());

Request      

POST api/v1/payment-types

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Example: consequatur

PUT api/v1/payment-types/{id}

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/payment-types/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

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());

Request      

PUT api/v1/payment-types/{id}

PATCH api/v1/payment-types/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the payment type. Example: consequatur

Body Parameters

name   string  optional    

DELETE api/v1/payment-types/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/payment-types/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/payment-types/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the payment type. Example: consequatur

GET api/v1/product-models

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/product-models" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/product-models

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/product-models

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/product-models" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

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());

Request      

POST api/v1/product-models

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string  optional    

PUT api/v1/product-models/{id}

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/product-models/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequatur\"
}"

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());

Request      

PUT api/v1/product-models/{id}

PATCH api/v1/product-models/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the product model. Example: consequatur

Body Parameters

name   string     

Example: consequatur

DELETE api/v1/product-models/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/product-models/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/product-models/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the product model. Example: consequatur

GET api/v1/variations

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/variations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/variations

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/variations

Example request:
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
}"

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());

Request      

POST api/v1/variations

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

values   string     

Example: consequatur

status   string     

Example: 1

Must be one of:
  • 0
  • 1

PUT api/v1/variations/{id}

Example request:
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
}"

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());

Request      

PUT api/v1/variations/{id}

PATCH api/v1/variations/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the variation. Example: consequatur

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

values   string     

Example: consequatur

status   string     

Example: 1

Must be one of:
  • 0
  • 1

DELETE api/v1/variations/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/variations/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/variations/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the variation. Example: consequatur

GET api/v1/racks

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/racks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/racks

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/racks

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/racks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"status\": 0
}"

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());

Request      

POST api/v1/racks

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

shelf_id   string[]  optional    

The id of an existing record in the shelves table.

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

status   string     

Example: 0

Must be one of:
  • 0
  • 1

PUT api/v1/racks/{id}

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/racks/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"status\": 0
}"

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());

Request      

PUT api/v1/racks/{id}

PATCH api/v1/racks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the rack. Example: consequatur

Body Parameters

shelf_id   string[]  optional    

The id of an existing record in the shelves table.

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

status   string     

Example: 0

Must be one of:
  • 0
  • 1

DELETE api/v1/racks/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/racks/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/racks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the rack. Example: consequatur

GET api/v1/shelfs

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/shelfs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/shelfs

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/shelfs

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/shelfs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"status\": 0
}"

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());

Request      

POST api/v1/shelfs

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

status   string     

Example: 0

Must be one of:
  • 0
  • 1

PUT api/v1/shelfs/{id}

Example request:
curl --request PUT \
    "http://localhost:8080/api/v1/shelfs/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vmqeopfuudtdsufvyvddq\",
    \"status\": 0
}"

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());

Request      

PUT api/v1/shelfs/{id}

PATCH api/v1/shelfs/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the shelf. Example: consequatur

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

status   string     

Example: 0

Must be one of:
  • 0
  • 1

DELETE api/v1/shelfs/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/shelfs/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/shelfs/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the shelf. Example: consequatur

GET api/v1/banks

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/banks" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/banks

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/banks

Example request:
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\"
    }
}"

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());

Request      

POST api/v1/banks

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

branch_id   string  optional    

The id of an existing record in the branches table.

opening_balance   number  optional    

Must be at least 0. Example: 1

opening_date   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:34

show_in_invoice   boolean  optional    

Example: true

meta   object  optional    
account_number   string  optional    

Must not be greater than 255 characters. Example: niihfqcoynlazghdtqtqx

routing_number   string  optional    

Must not be greater than 255 characters. Example: bajwbpilpmufinllwloau

upi_id   string  optional    

Must not be greater than 255 characters. Example: ydlsmsjuryvojcybzvrby

bank_name   string  optional    

Must not be greater than 255 characters. Example: ickznkygloigmkwxphlva

account_holder   string  optional    

Must not be greater than 255 characters. Example: zjrcnfbaqywuxhgjjmzux

branch   string  optional    

Must not be greater than 255 characters. Example: jubqouzswiwxtrkimfcat

GET api/v1/banks/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/banks/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/banks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the bank. Example: consequatur

PUT api/v1/banks/{id}

Example request:
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\"
    }
}"

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());

Request      

PUT api/v1/banks/{id}

PATCH api/v1/banks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the bank. Example: consequatur

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

branch_id   string  optional    

The id of an existing record in the branches table.

opening_balance   number  optional    

Must be at least 0. Example: 1

opening_date   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:34

show_in_invoice   boolean  optional    

Example: true

meta   object  optional    
account_number   string  optional    

Must not be greater than 255 characters. Example: niihfqcoynlazghdtqtqx

routing_number   string  optional    

Must not be greater than 255 characters. Example: bajwbpilpmufinllwloau

upi_id   string  optional    

Must not be greater than 255 characters. Example: ydlsmsjuryvojcybzvrby

bank_name   string  optional    

Must not be greater than 255 characters. Example: ickznkygloigmkwxphlva

account_holder   string  optional    

Must not be greater than 255 characters. Example: zjrcnfbaqywuxhgjjmzux

branch   string  optional    

Must not be greater than 255 characters. Example: jubqouzswiwxtrkimfcat

DELETE api/v1/banks/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/banks/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/banks/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the bank. Example: consequatur

GET api/v1/bank-transactions

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/bank-transactions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/bank-transactions

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/bank-transactions

Example request:
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" 
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());

Request      

POST api/v1/bank-transactions

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

from   string     

The id of an existing record in the payment_types table. Example: consequatur

type   string  optional    

Example: debit

Must be one of:
  • credit
  • debit
transaction_type   string     

Example: bank_to_bank

Must be one of:
  • bank_to_bank
  • bank_to_cash
  • adjust_bank
amount   number     

Must be at least 0.01. Example: 16

date   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:34

image   file  optional    

Must be an image. Example: /tmp/phphaGPjb

note   string  optional    

Example: consequatur

GET api/v1/bank-transactions/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/bank-transactions/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/bank-transactions/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the bank transaction. Example: consequatur

PUT api/v1/bank-transactions/{id}

Example request:
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" 
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());

Request      

PUT api/v1/bank-transactions/{id}

PATCH api/v1/bank-transactions/{id}

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the bank transaction. Example: consequatur

Body Parameters

from   string     

The id of an existing record in the payment_types table. Example: consequatur

type   string  optional    

Example: debit

Must be one of:
  • credit
  • debit
transaction_type   string     

Example: bank_to_bank

Must be one of:
  • bank_to_bank
  • bank_to_cash
  • adjust_bank
amount   number     

Must be at least 0.01. Example: 16

date   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:34

image   file  optional    

Must be an image. Example: /tmp/phpoAohAc

note   string  optional    

Example: consequatur

DELETE api/v1/bank-transactions/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/bank-transactions/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/bank-transactions/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the bank transaction. Example: consequatur

GET api/v1/cashes

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/cashes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/cashes

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/cashes

Example request:
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" 
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());

Request      

POST api/v1/cashes

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

to   string  optional    

The id of an existing record in the payment_types table.

type   string  optional    

Example: debit

Must be one of:
  • credit
  • debit
transaction_type   string     

Example: adjust_cash

Must be one of:
  • cash_to_bank
  • adjust_cash
amount   number     

Must be at least 0.01. Example: 56

date   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:35

image   file  optional    

Must be an image. Example: /tmp/phpddcDDf

note   string  optional    

Example: consequatur

GET api/v1/cashes/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/cashes/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/cashes/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the cash. Example: consequatur

PUT api/v1/cashes/{id}

Example request:
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" 
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());

Request      

PUT api/v1/cashes/{id}

PATCH api/v1/cashes/{id}

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the cash. Example: consequatur

Body Parameters

to   string  optional    

The id of an existing record in the payment_types table.

type   string  optional    

Example: debit

Must be one of:
  • credit
  • debit
transaction_type   string     

Example: adjust_cash

Must be one of:
  • cash_to_bank
  • adjust_cash
amount   number     

Must be at least 0.01. Example: 56

date   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:35

image   file  optional    

Must be an image. Example: /tmp/phpBmCmLf

note   string  optional    

Example: consequatur

DELETE api/v1/cashes/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/cashes/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/cashes/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the cash. Example: consequatur

GET api/v1/cheques

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/cheques" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/cheques

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/cheques

Example request:
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\"
}"

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());

Request      

POST api/v1/cheques

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

transaction_id   string     

The id of an existing record in the transactions table. Example: consequatur

date   string  optional    

Must be a valid date. Example: 2026-04-25T14:39:35

note   string  optional    

Example: consequatur

payment_type   string     

Example: consequatur

GET api/v1/cheques/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/cheques/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/cheques/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the cheque. Example: consequatur

POST api/v1/cheque-reopen/{id}

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/cheque-reopen/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

POST api/v1/cheque-reopen/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the cheque reopen. Example: consequatur

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/product-settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/product-settings

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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
}"

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());

Request      

POST api/v1/product-settings

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

show_product_name   integer  optional    

Example: 17

show_product_price   integer  optional    

Example: 17

show_product_code   integer  optional    

Example: 17

show_product_stock   integer  optional    

Example: 17

show_product_sale_price   integer  optional    

Example: 17

show_product_dealer_price   integer  optional    

Example: 17

show_product_wholesale_price   integer  optional    

Example: 17

show_product_unit   integer  optional    

Example: 17

show_product_brand   integer  optional    

Example: 17

show_product_category   integer  optional    

Example: 17

show_product_manufacturer   integer  optional    

Example: 17

show_product_image   integer  optional    

Example: 17

show_expire_date   integer  optional    

Example: 17

show_alert_qty   integer  optional    

Example: 17

show_vat_id   integer  optional    

Example: 17

show_vat_type   integer  optional    

Example: 17

show_exclusive_price   integer  optional    

Example: 17

show_inclusive_price   integer  optional    

Example: 17

show_profit_percent   integer  optional    

Example: 17

show_capacity   integer  optional    

Example: 17

show_weight   integer  optional    

Example: 17

show_color   integer  optional    

Example: 17

show_type   integer  optional    

Example: 17

show_size   integer  optional    

Example: 17

show_batch_no   integer  optional    

Example: 17

show_mfg_date   integer  optional    

Example: 17

show_model_no   integer  optional    

Example: 17

default_sale_price   integer  optional    

Example: 17

default_wholesale_price   integer  optional    

Example: 17

default_dealer_price   integer  optional    

Example: 17

show_product_type_single   integer  optional    

Example: 17

show_product_type_variant   integer  optional    

Example: 17

show_product_type_combo   integer  optional    

Example: 17

show_warehouse   integer  optional    

Example: 17

show_action   integer  optional    

Example: 17

show_rack   integer  optional    

Example: 17

show_shelf   integer  optional    

Example: 17

show_guarantee   integer  optional    

Example: 17

show_warranty   integer  optional    

Example: 17

show_serial   integer  optional    

Example: 17

default_batch_no   integer  optional    

Example: 17

default_expired_date   integer  optional    

Example: 17

default_mfg_date   integer  optional    

Example: 17

expire_date_type   integer  optional    

Example: 17

mfg_date_type   integer  optional    

Example: 17

show_product_batch_no   integer  optional    

Example: 17

show_product_expire_date   integer  optional    

Example: 17

GET api/v1/product/generate-code

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/product/generate-code" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/product/generate-code

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/bulk-uploads

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/bulk-uploads" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/phpALAOJh" 
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());

Request      

POST api/v1/bulk-uploads

Headers

Content-Type        

Example: multipart/form-data

Accept        

Example: application/json

Body Parameters

file   file     

Must be a file. Example: /tmp/phpALAOJh

POST api/v1/change-password

Example request:
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\"
}"

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());

Request      

POST api/v1/change-password

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

current_password   string     

Example: consequatur

password   string     

Must be at least 6 characters. Example: [2UZ5ij-e/dl4

GET api/v1/new-invoice

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/new-invoice" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"platform\": \"due_collects\"
}"

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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/new-invoice

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

platform   string     

Example: due_collects

Must be one of:
  • sales
  • purchases
  • due_collects
  • sales_return
  • purchases_return

GET api/v1/invoice-settings

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/invoice-settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/invoice-settings

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/invoice-settings/update

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/invoice-settings/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"invoice_size\": \"vmqeopfuudtdsufvyvddq\"
}"

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());

Request      

POST api/v1/invoice-settings/update

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

invoice_size   string     

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

Must be one of:
  • a4
  • 3_inch_80mm
  • 2_inch_58mm

POST api/v1/business-delete

Example request:
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,\"
}"

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());

Request      

POST api/v1/business-delete

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

password   string     

Example: O[2UZ5ij-e/dl4m{o,

GET api/v1/party-ledger/{party_id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/party-ledger/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/party-ledger/{party_id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

party_id   string     

The ID of the party. Example: consequatur

GET api/v1/money-receipt/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/money-receipt/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/money-receipt/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the money receipt. Example: consequatur

GET api/v1/currency-settings

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/currency-settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/currency-settings

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/currency-settings

Example request:
curl --request POST \
    "http://localhost:8080/api/v1/currency-settings" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"currency\": \"vmqeopfuudtdsufvyvddq\"
}"

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());

Request      

POST api/v1/currency-settings

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

currency   string     

Must not be greater than 100 characters. Example: vmqeopfuudtdsufvyvddq

Must be one of:
  • us
  • european

GET api/v1/transactions

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/transactions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/transactions

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/sign-out

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/sign-out" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/sign-out

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

GET api/v1/refresh-token

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/refresh-token" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/refresh-token

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Display a listing of the resource.

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/branches" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/branches

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Store a newly created resource in storage.

Example request:
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.\"
}"

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());

Request      

POST api/v1/branches

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

phone   string  optional    

Must not be greater than 20 characters. Example: amniihfqcoynlazgh

email   string  optional    

Must be a valid email address. Must not be greater than 255 characters. Example: roob.mona@example.org

address   string  optional    

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

branchOpeningBalance   number  optional    

Must be at least 0. Example: 72

description   string  optional    

Must not be greater than 1000 characters. Example: Qui ducimus nihil laudantium nihil autem omnis cum molestiae.

Update the specified resource in storage.

Example request:
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.\"
}"

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());

Request      

PUT api/v1/branches/{id}

PATCH api/v1/branches/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the branch. Example: consequatur

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

phone   string  optional    

Must not be greater than 20 characters. Example: amniihfqcoynlazgh

email   string  optional    

Must be a valid email address. Must not be greater than 255 characters. Example: roob.mona@example.org

address   string  optional    

Must not be greater than 255 characters. Example: xbajwbpilpmufinllwloa

branchOpeningBalance   number  optional    

Must be at least 0. Example: 72

description   string  optional    

Must not be greater than 1000 characters. Example: Qui ducimus nihil laudantium nihil autem omnis cum molestiae.

Remove the specified resource from storage.

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/branches/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/branches/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the branch. Example: consequatur

GET api/v1/switch-branch/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/switch-branch/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/switch-branch/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the switch branch. Example: consequatur

GET api/v1/exit-branch/{id}

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/exit-branch/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/exit-branch/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the exit branch. Example: consequatur

GET api/v1/warehouses

Example request:
curl --request GET \
    --get "http://localhost:8080/api/v1/warehouses" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Example response (401):

Show headers 
cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "message": "Unauthenticated."
}

Request      

GET api/v1/warehouses

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

POST api/v1/warehouses

Example request:
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\"
}"

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());

Request      

POST api/v1/warehouses

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

phone   string  optional    

Must not be greater than 20 characters. Example: amniihfqcoynlazgh

address   string  optional    

Must not be greater than 500 characters. Example: dtqtqxbajwbpilpmufinl

email   string  optional    

Must be a valid email address. Must not be greater than 255 characters. Example: imogene.mante@example.com

PUT api/v1/warehouses/{id}

Example request:
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\"
}"

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());

Request      

PUT api/v1/warehouses/{id}

PATCH api/v1/warehouses/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the warehouse. Example: consequatur

Body Parameters

name   string     

Must not be greater than 255 characters. Example: vmqeopfuudtdsufvyvddq

phone   string  optional    

Must not be greater than 20 characters. Example: amniihfqcoynlazgh

address   string  optional    

Must not be greater than 500 characters. Example: dtqtqxbajwbpilpmufinl

email   string  optional    

Must be a valid email address. Must not be greater than 255 characters. Example: imogene.mante@example.com

DELETE api/v1/warehouses/{id}

Example request:
curl --request DELETE \
    "http://localhost:8080/api/v1/warehouses/consequatur" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
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());

Request      

DELETE api/v1/warehouses/{id}

Headers

Content-Type        

Example: application/json

Accept        

Example: application/json

URL Parameters

id   string     

The ID of the warehouse. Example: consequatur