10923 lines
261 KiB
YAML
10923 lines
261 KiB
YAML
## Autogenerated by Scribe. DO NOT MODIFY.
|
|
|
|
name: Endpoints
|
|
description: ''
|
|
endpoints:
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/module-check
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 500
|
|
content: |-
|
|
{
|
|
"message": "Server Error"
|
|
}
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
x-ratelimit-limit: '100'
|
|
x-ratelimit-remaining: '99'
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/sign-in
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
password:
|
|
custom: []
|
|
name: password
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address.'
|
|
required: true
|
|
example: carolyne.luettgen@example.org
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
password: consequatur
|
|
email: carolyne.luettgen@example.org
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/submit-otp
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address.'
|
|
required: true
|
|
example: qkunze@example.com
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
otp:
|
|
custom: []
|
|
name: otp
|
|
description: 'Must be at least 4 characters. Must not be greater than 15 characters.'
|
|
required: true
|
|
example: opfuudtdsufvy
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
email: qkunze@example.com
|
|
otp: opfuudtdsufvy
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/sign-up
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
password:
|
|
custom: []
|
|
name: password
|
|
description: 'Must be at least 6 characters. Must not be greater than 100 characters.'
|
|
required: true
|
|
example: OP>@;4
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address.'
|
|
required: true
|
|
example: kacey94@example.org
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
password: OP>@;4
|
|
email: kacey94@example.org
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/resend-otp
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address. The <code>email</code> of an existing record in the users table.'
|
|
required: true
|
|
example: qkunze@example.com
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
email: qkunze@example.com
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/otp-settings
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 200
|
|
content: '{"message":"Data fetched successfully.","data":[]}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
x-ratelimit-limit: '100'
|
|
x-ratelimit-remaining: '98'
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/send-reset-code
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address. The <code>email</code> of an existing record in the users table.'
|
|
required: true
|
|
example: qkunze@example.com
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
email: qkunze@example.com
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/verify-reset-code
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
code:
|
|
custom: []
|
|
name: code
|
|
description: ''
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'The <code>email</code> of an existing record in the users table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
code: 17
|
|
email: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/password-reset
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'The <code>email</code> of an existing record in the users table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
password:
|
|
custom: []
|
|
name: password
|
|
description: 'Must be at least 4 characters.'
|
|
required: true
|
|
example: '[2UZ5ij-e/dl4'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
email: consequatur
|
|
password: '[2UZ5ij-e/dl4'
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/default-lang
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 200
|
|
content: '{"message":"Data fetched successfully.","data":""}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
x-ratelimit-limit: '100'
|
|
x-ratelimit-remaining: '97'
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/update-expire-date
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/summary
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/dashboard
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/parties
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/parties
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
type:
|
|
custom: []
|
|
name: type
|
|
description: ''
|
|
required: true
|
|
example: Retailer
|
|
type: string
|
|
enumValues:
|
|
- Retailer
|
|
- Dealer
|
|
- Wholesaler
|
|
- Supplier
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
phone:
|
|
custom: []
|
|
name: phone
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
image:
|
|
custom: []
|
|
name: image
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
address:
|
|
custom: []
|
|
name: address
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
credit_limit:
|
|
custom: []
|
|
name: credit_limit
|
|
description: 'Must be at least 0. Must not be greater than 999999999999.99.'
|
|
required: false
|
|
example: 1
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
opening_balance:
|
|
custom: []
|
|
name: opening_balance
|
|
description: 'Must be at least -999999999999.99. Must not be greater than 999999999999.99.'
|
|
required: false
|
|
example: 13
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
opening_balance_type:
|
|
custom: []
|
|
name: opening_balance_type
|
|
description: ''
|
|
required: true
|
|
example: due
|
|
type: string
|
|
enumValues:
|
|
- due
|
|
- advance
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
type: Retailer
|
|
address: vmqeopfuudtdsufvyvddq
|
|
credit_limit: 1
|
|
opening_balance: 13
|
|
opening_balance_type: due
|
|
fileParameters:
|
|
image: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/parties/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the party.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/parties/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the party.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
type:
|
|
custom: []
|
|
name: type
|
|
description: ''
|
|
required: true
|
|
example: Retailer
|
|
type: string
|
|
enumValues:
|
|
- Retailer
|
|
- Dealer
|
|
- Wholesaler
|
|
- Supplier
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
phone:
|
|
custom: []
|
|
name: phone
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
image:
|
|
custom: []
|
|
name: image
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
address:
|
|
custom: []
|
|
name: address
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
credit_limit:
|
|
custom: []
|
|
name: credit_limit
|
|
description: 'Must be at least 0. Must not be greater than 999999999999.99.'
|
|
required: false
|
|
example: 1
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
opening_balance:
|
|
custom: []
|
|
name: opening_balance
|
|
description: 'Must be at least -999999999999.99. Must not be greater than 999999999999.99.'
|
|
required: false
|
|
example: 13
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
opening_balance_type:
|
|
custom: []
|
|
name: opening_balance_type
|
|
description: ''
|
|
required: true
|
|
example: due
|
|
type: string
|
|
enumValues:
|
|
- due
|
|
- advance
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
type: Retailer
|
|
address: vmqeopfuudtdsufvyvddq
|
|
credit_limit: 1
|
|
opening_balance: 13
|
|
opening_balance_type: due
|
|
fileParameters:
|
|
image: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/parties/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the party.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/users
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/users
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 30 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
password:
|
|
custom: []
|
|
name: password
|
|
description: 'Must be at least 4 characters. Must not be greater than 15 characters.'
|
|
required: true
|
|
example: OP>@;4
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address.'
|
|
required: true
|
|
example: kacey94@example.org
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
branch_id:
|
|
custom: []
|
|
name: branch_id
|
|
description: 'The <code>id</code> of an existing record in the branches table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
password: OP>@;4
|
|
email: kacey94@example.org
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/users/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the user.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 30 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
password:
|
|
custom: []
|
|
name: password
|
|
description: 'Must be at least 4 characters. Must not be greater than 15 characters.'
|
|
required: false
|
|
example: OP>@;4
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
branch_id:
|
|
custom: []
|
|
name: branch_id
|
|
description: 'The <code>id</code> of an existing record in the branches table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
password: OP>@;4
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/users/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the user.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/units
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/units
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
unitName:
|
|
custom: []
|
|
name: unitName
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/units/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the unit.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
unitName:
|
|
custom: []
|
|
name: unitName
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
unitName: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/units/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the unit.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/brands
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/brands
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
brandName:
|
|
custom: []
|
|
name: brandName
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/brands/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the brand.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
brandName:
|
|
custom: []
|
|
name: brandName
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
brandName: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/brands/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the brand.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/categories
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/categories
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
categoryName:
|
|
custom: []
|
|
name: categoryName
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/categories/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the category.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
categoryName:
|
|
custom: []
|
|
name: categoryName
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
categoryName: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/categories/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the category.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/products
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/products
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
vat_id:
|
|
custom: []
|
|
name: vat_id
|
|
description: 'The <code>id</code> of an existing record in the vats table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
unit_id:
|
|
custom: []
|
|
name: unit_id
|
|
description: 'The <code>id</code> of an existing record in the units table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
brand_id:
|
|
custom: []
|
|
name: brand_id
|
|
description: 'The <code>id</code> of an existing record in the brands table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
category_id:
|
|
custom: []
|
|
name: category_id
|
|
description: 'The <code>id</code> of an existing record in the categories table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
model_id:
|
|
custom: []
|
|
name: model_id
|
|
description: 'The <code>id</code> of an existing record in the product_models table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
vat_type:
|
|
custom: []
|
|
name: vat_type
|
|
description: ''
|
|
required: false
|
|
example: exclusive
|
|
type: string
|
|
enumValues:
|
|
- inclusive
|
|
- exclusive
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
productName:
|
|
custom: []
|
|
name: productName
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: mqeopfuudtdsufvyvddqa
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
productPicture:
|
|
custom: []
|
|
name: productPicture
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
productCode:
|
|
custom: []
|
|
name: productCode
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
alert_qty:
|
|
custom: []
|
|
name: alert_qty
|
|
description: 'Must be at least 0.'
|
|
required: false
|
|
example: 73
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
size:
|
|
custom: []
|
|
name: size
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: mqeopfuudtdsufvyvddqa
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
type:
|
|
custom: []
|
|
name: type
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: mniihfqcoynlazghdtqtq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
color:
|
|
custom: []
|
|
name: color
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: xbajwbpilpmufinllwloa
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
weight:
|
|
custom: []
|
|
name: weight
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: uydlsmsjuryvojcybzvrb
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
capacity:
|
|
custom: []
|
|
name: capacity
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: yickznkygloigmkwxphlv
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
productManufacturer:
|
|
custom: []
|
|
name: productManufacturer
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: azjrcnfbaqywuxhgjjmzu
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
product_type:
|
|
custom: []
|
|
name: product_type
|
|
description: ''
|
|
required: true
|
|
example: variant
|
|
type: string
|
|
enumValues:
|
|
- single
|
|
- variant
|
|
- combo
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
variation_ids:
|
|
custom: []
|
|
name: variation_ids
|
|
description: 'The <code>id</code> of an existing record in the variations table.'
|
|
required: false
|
|
example: null
|
|
type: 'string[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
stocks:
|
|
custom: []
|
|
name: stocks
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: 'object[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
combo_products:
|
|
custom: []
|
|
name: combo_products
|
|
description: 'Combo validation.'
|
|
required: false
|
|
example: null
|
|
type: 'object[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].warehouse_id':
|
|
custom: []
|
|
name: 'stocks[].warehouse_id'
|
|
description: 'The <code>id</code> of an existing record in the warehouses table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].productStock':
|
|
custom: []
|
|
name: 'stocks[].productStock'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 10
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].exclusive_price':
|
|
custom: []
|
|
name: 'stocks[].exclusive_price'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 20
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].inclusive_price':
|
|
custom: []
|
|
name: 'stocks[].inclusive_price'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 2
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].profit_percent':
|
|
custom: []
|
|
name: 'stocks[].profit_percent'
|
|
description: 'Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 16
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].productSalePrice':
|
|
custom: []
|
|
name: 'stocks[].productSalePrice'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 14
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].productWholeSalePrice':
|
|
custom: []
|
|
name: 'stocks[].productWholeSalePrice'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 20
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].productDealerPrice':
|
|
custom: []
|
|
name: 'stocks[].productDealerPrice'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 25
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].mfg_date':
|
|
custom: []
|
|
name: 'stocks[].mfg_date'
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:34'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].expire_date':
|
|
custom: []
|
|
name: 'stocks[].expire_date'
|
|
description: 'Must be a valid date. Must be a date after or equal to <code>stocks.*.mfg_date</code>.'
|
|
required: false
|
|
example: '2107-05-25'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].batch_no':
|
|
custom: []
|
|
name: 'stocks[].batch_no'
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'combo_products[].stock_id':
|
|
custom: []
|
|
name: 'combo_products[].stock_id'
|
|
description: 'This field is required when <code>product_type</code> is <code>combo</code>.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
'combo_products[].quantity':
|
|
custom: []
|
|
name: 'combo_products[].quantity'
|
|
description: 'This field is required when <code>product_type</code> is <code>combo</code>. Must be at least 1.'
|
|
required: false
|
|
example: 45
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
vat_type: exclusive
|
|
productName: mqeopfuudtdsufvyvddqa
|
|
alert_qty: 73
|
|
size: mqeopfuudtdsufvyvddqa
|
|
type: mniihfqcoynlazghdtqtq
|
|
color: xbajwbpilpmufinllwloa
|
|
weight: uydlsmsjuryvojcybzvrb
|
|
capacity: yickznkygloigmkwxphlv
|
|
productManufacturer: azjrcnfbaqywuxhgjjmzu
|
|
product_type: variant
|
|
stocks:
|
|
-
|
|
productStock: 10
|
|
exclusive_price: 20
|
|
inclusive_price: 2
|
|
profit_percent: 16
|
|
productSalePrice: 14
|
|
productWholeSalePrice: 20
|
|
productDealerPrice: 25
|
|
mfg_date: '2026-04-25T14:39:34'
|
|
expire_date: '2107-05-25'
|
|
combo_products:
|
|
-
|
|
quantity: 45
|
|
fileParameters:
|
|
productPicture: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/products/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the product.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/products/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the product.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
vat_id:
|
|
custom: []
|
|
name: vat_id
|
|
description: 'The <code>id</code> of an existing record in the vats table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
unit_id:
|
|
custom: []
|
|
name: unit_id
|
|
description: 'The <code>id</code> of an existing record in the units table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
brand_id:
|
|
custom: []
|
|
name: brand_id
|
|
description: 'The <code>id</code> of an existing record in the brands table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
category_id:
|
|
custom: []
|
|
name: category_id
|
|
description: 'The <code>id</code> of an existing record in the categories table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
model_id:
|
|
custom: []
|
|
name: model_id
|
|
description: 'The <code>id</code> of an existing record in the product_models table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
vat_type:
|
|
custom: []
|
|
name: vat_type
|
|
description: ''
|
|
required: false
|
|
example: exclusive
|
|
type: string
|
|
enumValues:
|
|
- inclusive
|
|
- exclusive
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
productName:
|
|
custom: []
|
|
name: productName
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: mqeopfuudtdsufvyvddqa
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
productPicture:
|
|
custom: []
|
|
name: productPicture
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
productCode:
|
|
custom: []
|
|
name: productCode
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
alert_qty:
|
|
custom: []
|
|
name: alert_qty
|
|
description: 'Must be at least 0.'
|
|
required: false
|
|
example: 73
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
size:
|
|
custom: []
|
|
name: size
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: mqeopfuudtdsufvyvddqa
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
type:
|
|
custom: []
|
|
name: type
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: mniihfqcoynlazghdtqtq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
color:
|
|
custom: []
|
|
name: color
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: xbajwbpilpmufinllwloa
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
weight:
|
|
custom: []
|
|
name: weight
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: uydlsmsjuryvojcybzvrb
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
capacity:
|
|
custom: []
|
|
name: capacity
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: yickznkygloigmkwxphlv
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
productManufacturer:
|
|
custom: []
|
|
name: productManufacturer
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: azjrcnfbaqywuxhgjjmzu
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
product_type:
|
|
custom: []
|
|
name: product_type
|
|
description: ''
|
|
required: true
|
|
example: variant
|
|
type: string
|
|
enumValues:
|
|
- single
|
|
- variant
|
|
- combo
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
variation_ids:
|
|
custom: []
|
|
name: variation_ids
|
|
description: 'The <code>id</code> of an existing record in the variations table.'
|
|
required: false
|
|
example: null
|
|
type: 'string[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
stocks:
|
|
custom: []
|
|
name: stocks
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: 'object[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
combo_products:
|
|
custom: []
|
|
name: combo_products
|
|
description: 'Combo validation.'
|
|
required: false
|
|
example: null
|
|
type: 'object[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].warehouse_id':
|
|
custom: []
|
|
name: 'stocks[].warehouse_id'
|
|
description: 'The <code>id</code> of an existing record in the warehouses table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].productStock':
|
|
custom: []
|
|
name: 'stocks[].productStock'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 10
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].exclusive_price':
|
|
custom: []
|
|
name: 'stocks[].exclusive_price'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 20
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].inclusive_price':
|
|
custom: []
|
|
name: 'stocks[].inclusive_price'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 2
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].profit_percent':
|
|
custom: []
|
|
name: 'stocks[].profit_percent'
|
|
description: 'Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 16
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].productSalePrice':
|
|
custom: []
|
|
name: 'stocks[].productSalePrice'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 14
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].productWholeSalePrice':
|
|
custom: []
|
|
name: 'stocks[].productWholeSalePrice'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 20
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].productDealerPrice':
|
|
custom: []
|
|
name: 'stocks[].productDealerPrice'
|
|
description: 'Must be at least 0. Must not be greater than 99999999.99.'
|
|
required: false
|
|
example: 25
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].mfg_date':
|
|
custom: []
|
|
name: 'stocks[].mfg_date'
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:34'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].expire_date':
|
|
custom: []
|
|
name: 'stocks[].expire_date'
|
|
description: 'Must be a valid date. Must be a date after or equal to <code>stocks.*.mfg_date</code>.'
|
|
required: false
|
|
example: '2107-05-25'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'stocks[].batch_no':
|
|
custom: []
|
|
name: 'stocks[].batch_no'
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'combo_products[].stock_id':
|
|
custom: []
|
|
name: 'combo_products[].stock_id'
|
|
description: 'This field is required when <code>product_type</code> is <code>combo</code>.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
'combo_products[].quantity':
|
|
custom: []
|
|
name: 'combo_products[].quantity'
|
|
description: 'This field is required when <code>product_type</code> is <code>combo</code>. Must be at least 1.'
|
|
required: false
|
|
example: 45
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
vat_type: exclusive
|
|
productName: mqeopfuudtdsufvyvddqa
|
|
alert_qty: 73
|
|
size: mqeopfuudtdsufvyvddqa
|
|
type: mniihfqcoynlazghdtqtq
|
|
color: xbajwbpilpmufinllwloa
|
|
weight: uydlsmsjuryvojcybzvrb
|
|
capacity: yickznkygloigmkwxphlv
|
|
productManufacturer: azjrcnfbaqywuxhgjjmzu
|
|
product_type: variant
|
|
stocks:
|
|
-
|
|
productStock: 10
|
|
exclusive_price: 20
|
|
inclusive_price: 2
|
|
profit_percent: 16
|
|
productSalePrice: 14
|
|
productWholeSalePrice: 20
|
|
productDealerPrice: 25
|
|
mfg_date: '2026-04-25T14:39:34'
|
|
expire_date: '2107-05-25'
|
|
combo_products:
|
|
-
|
|
quantity: 45
|
|
fileParameters:
|
|
productPicture: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/products/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the product.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/stocks
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
productStock:
|
|
custom: []
|
|
name: productStock
|
|
description: ''
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
stock_id:
|
|
custom: []
|
|
name: stock_id
|
|
description: 'The <code>id</code> of an existing record in the stocks table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
productStock: 17
|
|
stock_id: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/stocks/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the stock.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/stocks/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the stock.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/business
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/business
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
address:
|
|
custom: []
|
|
name: address
|
|
description: 'Must not be greater than 250 characters.'
|
|
required: false
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
companyName:
|
|
custom: []
|
|
name: companyName
|
|
description: 'Must not be greater than 250 characters.'
|
|
required: true
|
|
example: amniihfqcoynlazghdtqt
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
pictureUrl:
|
|
custom: []
|
|
name: pictureUrl
|
|
description: 'Must be an image. Must not be greater than 5120 kilobytes.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
shopOpeningBalance:
|
|
custom: []
|
|
name: shopOpeningBalance
|
|
description: ''
|
|
required: false
|
|
example: 11613.31890586
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
phoneNumber:
|
|
custom: []
|
|
name: phoneNumber
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
business_category_id:
|
|
custom: []
|
|
name: business_category_id
|
|
description: 'The <code>id</code> of an existing record in the business_categories table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
address: vmqeopfuudtdsufvyvddq
|
|
companyName: amniihfqcoynlazghdtqt
|
|
shopOpeningBalance: 11613.31890586
|
|
business_category_id: consequatur
|
|
fileParameters:
|
|
pictureUrl: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/business/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the business.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
address:
|
|
custom: []
|
|
name: address
|
|
description: 'Must not be greater than 250 characters.'
|
|
required: false
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
companyName:
|
|
custom: []
|
|
name: companyName
|
|
description: 'This field is required when <code>sale_rounding_option</code> is <code>!=</code> or <code>null</code>. Must not be greater than 250 characters.'
|
|
required: false
|
|
example: amniihfqcoynlazghdtqt
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
business_category_id:
|
|
custom: []
|
|
name: business_category_id
|
|
description: 'This field is required when <code>sale_rounding_option</code> is <code>!=</code> or <code>null</code>. The <code>id</code> of an existing record in the business_categories table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
pictureUrl:
|
|
custom: []
|
|
name: pictureUrl
|
|
description: 'Must be an image. Must not be greater than 5120 kilobytes.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_company_name:
|
|
custom: []
|
|
name: show_company_name
|
|
description: ''
|
|
required: false
|
|
example: true
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_phone_number:
|
|
custom: []
|
|
name: show_phone_number
|
|
description: ''
|
|
required: false
|
|
example: false
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_address:
|
|
custom: []
|
|
name: show_address
|
|
description: ''
|
|
required: false
|
|
example: false
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_email:
|
|
custom: []
|
|
name: show_email
|
|
description: ''
|
|
required: false
|
|
example: true
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_vat:
|
|
custom: []
|
|
name: show_vat
|
|
description: ''
|
|
required: false
|
|
example: false
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
invoice_logo:
|
|
custom: []
|
|
name: invoice_logo
|
|
description: 'Must be an image. Must not be greater than 5120 kilobytes.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
a4_invoice_logo:
|
|
custom: []
|
|
name: a4_invoice_logo
|
|
description: 'Must be an image. Must not be greater than 5120 kilobytes.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
thermal_invoice_logo:
|
|
custom: []
|
|
name: thermal_invoice_logo
|
|
description: 'Must be an image. Must not be greater than 5120 kilobytes.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
invoice_scanner_logo:
|
|
custom: []
|
|
name: invoice_scanner_logo
|
|
description: 'Must be an image. Must not be greater than 5120 kilobytes.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
sale_rounding_option:
|
|
custom: []
|
|
name: sale_rounding_option
|
|
description: ''
|
|
required: false
|
|
example: nearest_whole_number
|
|
type: string
|
|
enumValues:
|
|
- none
|
|
- round_up
|
|
- nearest_whole_number
|
|
- nearest_0.05
|
|
- nearest_0.1
|
|
- nearest_0.5
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
phoneNumber:
|
|
custom: []
|
|
name: phoneNumber
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
invoice_size:
|
|
custom: []
|
|
name: invoice_size
|
|
description: 'Must not be greater than 100 characters.'
|
|
required: false
|
|
example: bpilpmufinllwloauydls
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
invoice_language:
|
|
custom: []
|
|
name: invoice_language
|
|
description: 'Must not be greater than 100 characters.'
|
|
required: false
|
|
example: msjuryvojcybzvrbyickz
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
gratitude_message:
|
|
custom: []
|
|
name: gratitude_message
|
|
description: 'Must not be greater than 100 characters.'
|
|
required: false
|
|
example: nkygloigmkwxphlvazjrc
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
warranty_void_label:
|
|
custom: []
|
|
name: warranty_void_label
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
warranty_void:
|
|
custom: []
|
|
name: warranty_void
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_note:
|
|
custom: []
|
|
name: show_note
|
|
description: ''
|
|
required: false
|
|
example: false
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_gratitude_msg:
|
|
custom: []
|
|
name: show_gratitude_msg
|
|
description: ''
|
|
required: false
|
|
example: true
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_invoice_scanner_logo:
|
|
custom: []
|
|
name: show_invoice_scanner_logo
|
|
description: ''
|
|
required: false
|
|
example: false
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_a4_invoice_logo:
|
|
custom: []
|
|
name: show_a4_invoice_logo
|
|
description: ''
|
|
required: false
|
|
example: true
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_thermal_invoice_logo:
|
|
custom: []
|
|
name: show_thermal_invoice_logo
|
|
description: ''
|
|
required: false
|
|
example: true
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_warranty:
|
|
custom: []
|
|
name: show_warranty
|
|
description: ''
|
|
required: false
|
|
example: true
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
address: vmqeopfuudtdsufvyvddq
|
|
companyName: amniihfqcoynlazghdtqt
|
|
show_company_name: true
|
|
show_phone_number: false
|
|
show_address: false
|
|
show_email: true
|
|
show_vat: false
|
|
sale_rounding_option: nearest_whole_number
|
|
invoice_size: bpilpmufinllwloauydls
|
|
invoice_language: msjuryvojcybzvrbyickz
|
|
gratitude_message: nkygloigmkwxphlvazjrc
|
|
warranty_void_label: consequatur
|
|
warranty_void: consequatur
|
|
show_note: false
|
|
show_gratitude_msg: true
|
|
show_invoice_scanner_logo: false
|
|
show_a4_invoice_logo: true
|
|
show_thermal_invoice_logo: true
|
|
show_warranty: true
|
|
fileParameters:
|
|
pictureUrl: null
|
|
invoice_logo: null
|
|
a4_invoice_logo: null
|
|
thermal_invoice_logo: null
|
|
invoice_scanner_logo: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/business-categories
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/purchase
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/purchase
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
products:
|
|
custom: []
|
|
name: products
|
|
description: ''
|
|
required: true
|
|
example:
|
|
- []
|
|
type: 'object[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
party_id:
|
|
custom: []
|
|
name: party_id
|
|
description: 'The <code>id</code> of an existing record in the parties table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
'products[].product_id':
|
|
custom: []
|
|
name: 'products[].product_id'
|
|
description: 'The <code>id</code> of an existing record in the products table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
products:
|
|
-
|
|
product_id: consequatur
|
|
party_id: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/purchase/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the purchase.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/purchase/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the purchase.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
products:
|
|
custom: []
|
|
name: products
|
|
description: ''
|
|
required: true
|
|
example:
|
|
- []
|
|
type: 'object[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
party_id:
|
|
custom: []
|
|
name: party_id
|
|
description: 'The <code>id</code> of an existing record in the parties table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
'products[].product_id':
|
|
custom: []
|
|
name: 'products[].product_id'
|
|
description: 'The <code>id</code> of an existing record in the products table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
products:
|
|
-
|
|
product_id: consequatur
|
|
party_id: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/purchase/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the purchase.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/sales
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/sales
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
party_id:
|
|
custom: []
|
|
name: party_id
|
|
description: 'The <code>id</code> of an existing record in the parties table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
vat_id:
|
|
custom: []
|
|
name: vat_id
|
|
description: 'The <code>id</code> of an existing record in the vats table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
products:
|
|
custom: []
|
|
name: products
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
saleDate:
|
|
custom: []
|
|
name: saleDate
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:34'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
image:
|
|
custom: []
|
|
name: image
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
rounding_option:
|
|
custom: []
|
|
name: rounding_option
|
|
description: ''
|
|
required: false
|
|
example: nearest_0.05
|
|
type: string
|
|
enumValues:
|
|
- none
|
|
- round_up
|
|
- nearest_whole_number
|
|
- nearest_0.05
|
|
- nearest_0.1
|
|
- nearest_0.5
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
products: consequatur
|
|
saleDate: '2026-04-25T14:39:34'
|
|
rounding_option: nearest_0.05
|
|
fileParameters:
|
|
image: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/sales/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the sale.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/sales/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the sale.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
party_id:
|
|
custom: []
|
|
name: party_id
|
|
description: 'The <code>id</code> of an existing record in the parties table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
vat_id:
|
|
custom: []
|
|
name: vat_id
|
|
description: 'The <code>id</code> of an existing record in the vats table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
products:
|
|
custom: []
|
|
name: products
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
saleDate:
|
|
custom: []
|
|
name: saleDate
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:34'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
image:
|
|
custom: []
|
|
name: image
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
rounding_option:
|
|
custom: []
|
|
name: rounding_option
|
|
description: ''
|
|
required: false
|
|
example: nearest_0.05
|
|
type: string
|
|
enumValues:
|
|
- none
|
|
- round_up
|
|
- nearest_whole_number
|
|
- nearest_0.05
|
|
- nearest_0.1
|
|
- nearest_0.5
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
products: consequatur
|
|
saleDate: '2026-04-25T14:39:34'
|
|
rounding_option: nearest_0.05
|
|
fileParameters:
|
|
image: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/sales/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the sale.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/reports/loss-profit
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/reports/cashflow
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/reports/balance-sheet
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/reports/subscription
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/reports/tax
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/reports/bill-wise-profit
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/reports/product-sale-history
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/reports/product-sale-history/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the product sale history.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/reports/product-purchase-history
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/reports/product-purchase-history/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the product purchase history.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/sales-return
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/sales-return
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
sale_id:
|
|
custom: []
|
|
name: sale_id
|
|
description: 'The <code>id</code> of an existing record in the sales table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
return_qty:
|
|
custom: []
|
|
name: return_qty
|
|
description: ''
|
|
required: true
|
|
example: []
|
|
type: object
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
sale_id: consequatur
|
|
return_qty: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/sales-return/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the sales return.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/purchases-return
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/purchases-return
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
purchase_id:
|
|
custom: []
|
|
name: purchase_id
|
|
description: 'The <code>id</code> of an existing record in the purchases table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
return_qty:
|
|
custom: []
|
|
name: return_qty
|
|
description: ''
|
|
required: true
|
|
example: []
|
|
type: object
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
purchase_id: consequatur
|
|
return_qty: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/purchases-return/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the purchases return.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/invoices
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
party_id:
|
|
custom: []
|
|
name: party_id
|
|
description: 'The <code>id</code> of an existing record in the parties table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
party_id: consequatur
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/dues
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/dues
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
paymentDate:
|
|
custom: []
|
|
name: paymentDate
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
payDueAmount:
|
|
custom: []
|
|
name: payDueAmount
|
|
description: ''
|
|
required: false
|
|
example: 11613.31890586
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
party_id:
|
|
custom: []
|
|
name: party_id
|
|
description: 'The <code>id</code> of an existing record in the parties table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
invoiceNumber:
|
|
custom: []
|
|
name: invoiceNumber
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
paymentDate: consequatur
|
|
payDueAmount: 11613.31890586
|
|
party_id: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/invoice-wise-dues
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/collect-invoice-due
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
paymentDate:
|
|
custom: []
|
|
name: paymentDate
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
payDueAmount:
|
|
custom: []
|
|
name: payDueAmount
|
|
description: ''
|
|
required: false
|
|
example: 11613.31890586
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
invoiceNumber:
|
|
custom: []
|
|
name: invoiceNumber
|
|
description: 'The <code>invoiceNumber</code> of an existing record in the sales table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
paymentDate: consequatur
|
|
payDueAmount: 11613.31890586
|
|
invoiceNumber: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/expense-categories
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/expense-categories
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
categoryName:
|
|
custom: []
|
|
name: categoryName
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/expense-categories/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the expense category.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
categoryName:
|
|
custom: []
|
|
name: categoryName
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
categoryName: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/expense-categories/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the expense category.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/expenses
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/expenses
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
expense_category_id:
|
|
custom: []
|
|
name: expense_category_id
|
|
description: 'The <code>id</code> of an existing record in the expense_categories table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
expanseFor:
|
|
custom: []
|
|
name: expanseFor
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
referenceNo:
|
|
custom: []
|
|
name: referenceNo
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
note:
|
|
custom: []
|
|
name: note
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
payments:
|
|
custom: []
|
|
name: payments
|
|
description: 'Must have at least 1 items.'
|
|
required: true
|
|
example:
|
|
- []
|
|
type: 'object[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
'payments[].type':
|
|
custom: []
|
|
name: 'payments[].type'
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
'payments[].amount':
|
|
custom: []
|
|
name: 'payments[].amount'
|
|
description: 'Must be at least 0.'
|
|
required: false
|
|
example: 45
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
expense_category_id: consequatur
|
|
expanseFor: consequatur
|
|
referenceNo: consequatur
|
|
note: consequatur
|
|
payments:
|
|
-
|
|
type: consequatur
|
|
amount: 45
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/income-categories
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/income-categories
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
categoryName:
|
|
custom: []
|
|
name: categoryName
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/income-categories/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the income category.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
categoryName:
|
|
custom: []
|
|
name: categoryName
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
categoryName: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/income-categories/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the income category.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/incomes
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/incomes
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
income_category_id:
|
|
custom: []
|
|
name: income_category_id
|
|
description: 'The <code>id</code> of an existing record in the income_categories table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
incomeFor:
|
|
custom: []
|
|
name: incomeFor
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
referenceNo:
|
|
custom: []
|
|
name: referenceNo
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
note:
|
|
custom: []
|
|
name: note
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
payments:
|
|
custom: []
|
|
name: payments
|
|
description: 'Must have at least 1 items.'
|
|
required: true
|
|
example:
|
|
- []
|
|
type: 'object[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
'payments[].type':
|
|
custom: []
|
|
name: 'payments[].type'
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
'payments[].amount':
|
|
custom: []
|
|
name: 'payments[].amount'
|
|
description: 'Must be at least 0.'
|
|
required: false
|
|
example: 45
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
'payments[].cheque_number':
|
|
custom: []
|
|
name: 'payments[].cheque_number'
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
income_category_id: consequatur
|
|
incomeFor: consequatur
|
|
referenceNo: consequatur
|
|
note: consequatur
|
|
payments:
|
|
-
|
|
type: consequatur
|
|
amount: 45
|
|
cheque_number: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/banners
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/lang
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/lang
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
lang:
|
|
custom: []
|
|
name: lang
|
|
description: 'Must not be greater than 30 characters. Must be at least 1 character.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
lang: vmqeopfuudtdsufvyvddqamniihfqcoynlazghdtqtqxbajwbpilpmufinllwloauydlsmsju
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/profile
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/profile
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 250 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address.'
|
|
required: true
|
|
example: kunde.eloisa@example.com
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
image:
|
|
custom: []
|
|
name: image
|
|
description: 'Must be an image. Must not be greater than 1048 kilobytes.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
email: kunde.eloisa@example.com
|
|
fileParameters:
|
|
image: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/plans
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/subscribes
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/currencies
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/currencies/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the currency.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/vats
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/vats
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
vat_ids:
|
|
custom: []
|
|
name: vat_ids
|
|
description: 'This field is required when <code>rate</code> is <code>null</code>.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
rate:
|
|
custom: []
|
|
name: rate
|
|
description: 'This field is required when <code>rate</code> is <code>null</code>.'
|
|
required: false
|
|
example: 11613.31890586
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
rate: 11613.31890586
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/vats/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the vat.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
vat_ids:
|
|
custom: []
|
|
name: vat_ids
|
|
description: 'This field is required when <code>rate</code> is <code>null</code>.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
rate:
|
|
custom: []
|
|
name: rate
|
|
description: 'This field is required when <code>rate</code> is <code>null</code>.'
|
|
required: false
|
|
example: 11613.31890586
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
rate: 11613.31890586
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/vats/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the vat.'
|
|
required: true
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: 17
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/payment-types
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/payment-types
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/payment-types/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the payment type.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/payment-types/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the payment type.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/product-models
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/product-models
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/product-models/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the product model.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/product-models/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the product model.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/variations
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/variations
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
values:
|
|
custom: []
|
|
name: values
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
status:
|
|
custom: []
|
|
name: status
|
|
description: ''
|
|
required: true
|
|
example: 1
|
|
type: string
|
|
enumValues:
|
|
- 0
|
|
- 1
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
values: consequatur
|
|
status: 1
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/variations/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the variation.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
values:
|
|
custom: []
|
|
name: values
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
status:
|
|
custom: []
|
|
name: status
|
|
description: ''
|
|
required: true
|
|
example: 1
|
|
type: string
|
|
enumValues:
|
|
- 0
|
|
- 1
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
values: consequatur
|
|
status: 1
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/variations/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the variation.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/racks
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/racks
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
shelf_id:
|
|
custom: []
|
|
name: shelf_id
|
|
description: 'The <code>id</code> of an existing record in the shelves table.'
|
|
required: false
|
|
example: null
|
|
type: 'string[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
status:
|
|
custom: []
|
|
name: status
|
|
description: ''
|
|
required: true
|
|
example: 0
|
|
type: string
|
|
enumValues:
|
|
- 0
|
|
- 1
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
status: 0
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/racks/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the rack.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
shelf_id:
|
|
custom: []
|
|
name: shelf_id
|
|
description: 'The <code>id</code> of an existing record in the shelves table.'
|
|
required: false
|
|
example: null
|
|
type: 'string[]'
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
status:
|
|
custom: []
|
|
name: status
|
|
description: ''
|
|
required: true
|
|
example: 0
|
|
type: string
|
|
enumValues:
|
|
- 0
|
|
- 1
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
status: 0
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/racks/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the rack.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/shelfs
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/shelfs
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
status:
|
|
custom: []
|
|
name: status
|
|
description: ''
|
|
required: true
|
|
example: 0
|
|
type: string
|
|
enumValues:
|
|
- 0
|
|
- 1
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
status: 0
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/shelfs/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the shelf.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
status:
|
|
custom: []
|
|
name: status
|
|
description: ''
|
|
required: true
|
|
example: 0
|
|
type: string
|
|
enumValues:
|
|
- 0
|
|
- 1
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
status: 0
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/shelfs/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the shelf.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/banks
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/banks
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
branch_id:
|
|
custom: []
|
|
name: branch_id
|
|
description: 'The <code>id</code> of an existing record in the branches table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
opening_balance:
|
|
custom: []
|
|
name: opening_balance
|
|
description: 'Must be at least 0.'
|
|
required: false
|
|
example: 1
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
opening_date:
|
|
custom: []
|
|
name: opening_date
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:34'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_in_invoice:
|
|
custom: []
|
|
name: show_in_invoice
|
|
description: ''
|
|
required: false
|
|
example: true
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
meta:
|
|
custom: []
|
|
name: meta
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: object
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.account_number:
|
|
custom: []
|
|
name: meta.account_number
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: niihfqcoynlazghdtqtqx
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.routing_number:
|
|
custom: []
|
|
name: meta.routing_number
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: bajwbpilpmufinllwloau
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.upi_id:
|
|
custom: []
|
|
name: meta.upi_id
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: ydlsmsjuryvojcybzvrby
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.bank_name:
|
|
custom: []
|
|
name: meta.bank_name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: ickznkygloigmkwxphlva
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.account_holder:
|
|
custom: []
|
|
name: meta.account_holder
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: zjrcnfbaqywuxhgjjmzux
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.branch:
|
|
custom: []
|
|
name: meta.branch
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: jubqouzswiwxtrkimfcat
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
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
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/banks/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the bank.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/banks/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the bank.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
branch_id:
|
|
custom: []
|
|
name: branch_id
|
|
description: 'The <code>id</code> of an existing record in the branches table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
opening_balance:
|
|
custom: []
|
|
name: opening_balance
|
|
description: 'Must be at least 0.'
|
|
required: false
|
|
example: 1
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
opening_date:
|
|
custom: []
|
|
name: opening_date
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:34'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_in_invoice:
|
|
custom: []
|
|
name: show_in_invoice
|
|
description: ''
|
|
required: false
|
|
example: true
|
|
type: boolean
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
meta:
|
|
custom: []
|
|
name: meta
|
|
description: ''
|
|
required: false
|
|
example: null
|
|
type: object
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.account_number:
|
|
custom: []
|
|
name: meta.account_number
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: niihfqcoynlazghdtqtqx
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.routing_number:
|
|
custom: []
|
|
name: meta.routing_number
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: bajwbpilpmufinllwloau
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.upi_id:
|
|
custom: []
|
|
name: meta.upi_id
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: ydlsmsjuryvojcybzvrby
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.bank_name:
|
|
custom: []
|
|
name: meta.bank_name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: ickznkygloigmkwxphlva
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.account_holder:
|
|
custom: []
|
|
name: meta.account_holder
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: zjrcnfbaqywuxhgjjmzux
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
meta.branch:
|
|
custom: []
|
|
name: meta.branch
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: jubqouzswiwxtrkimfcat
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
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
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/banks/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the bank.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/bank-transactions
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/bank-transactions
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
from:
|
|
custom: []
|
|
name: from
|
|
description: 'The <code>id</code> of an existing record in the payment_types table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
type:
|
|
custom: []
|
|
name: type
|
|
description: ''
|
|
required: false
|
|
example: debit
|
|
type: string
|
|
enumValues:
|
|
- credit
|
|
- debit
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
transaction_type:
|
|
custom: []
|
|
name: transaction_type
|
|
description: ''
|
|
required: true
|
|
example: bank_to_bank
|
|
type: string
|
|
enumValues:
|
|
- bank_to_bank
|
|
- bank_to_cash
|
|
- adjust_bank
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
amount:
|
|
custom: []
|
|
name: amount
|
|
description: 'Must be at least 0.01.'
|
|
required: true
|
|
example: 16
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
date:
|
|
custom: []
|
|
name: date
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:34'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
image:
|
|
custom: []
|
|
name: image
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
note:
|
|
custom: []
|
|
name: note
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
from: consequatur
|
|
type: debit
|
|
transaction_type: bank_to_bank
|
|
amount: 16
|
|
date: '2026-04-25T14:39:34'
|
|
note: consequatur
|
|
fileParameters:
|
|
image: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/bank-transactions/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the bank transaction.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/bank-transactions/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the bank transaction.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
from:
|
|
custom: []
|
|
name: from
|
|
description: 'The <code>id</code> of an existing record in the payment_types table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
type:
|
|
custom: []
|
|
name: type
|
|
description: ''
|
|
required: false
|
|
example: debit
|
|
type: string
|
|
enumValues:
|
|
- credit
|
|
- debit
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
transaction_type:
|
|
custom: []
|
|
name: transaction_type
|
|
description: ''
|
|
required: true
|
|
example: bank_to_bank
|
|
type: string
|
|
enumValues:
|
|
- bank_to_bank
|
|
- bank_to_cash
|
|
- adjust_bank
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
amount:
|
|
custom: []
|
|
name: amount
|
|
description: 'Must be at least 0.01.'
|
|
required: true
|
|
example: 16
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
date:
|
|
custom: []
|
|
name: date
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:34'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
image:
|
|
custom: []
|
|
name: image
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
note:
|
|
custom: []
|
|
name: note
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
from: consequatur
|
|
type: debit
|
|
transaction_type: bank_to_bank
|
|
amount: 16
|
|
date: '2026-04-25T14:39:34'
|
|
note: consequatur
|
|
fileParameters:
|
|
image: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/bank-transactions/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the bank transaction.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/cashes
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/cashes
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
to:
|
|
custom: []
|
|
name: to
|
|
description: 'The <code>id</code> of an existing record in the payment_types table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
type:
|
|
custom: []
|
|
name: type
|
|
description: ''
|
|
required: false
|
|
example: debit
|
|
type: string
|
|
enumValues:
|
|
- credit
|
|
- debit
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
transaction_type:
|
|
custom: []
|
|
name: transaction_type
|
|
description: ''
|
|
required: true
|
|
example: adjust_cash
|
|
type: string
|
|
enumValues:
|
|
- cash_to_bank
|
|
- adjust_cash
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
amount:
|
|
custom: []
|
|
name: amount
|
|
description: 'Must be at least 0.01.'
|
|
required: true
|
|
example: 56
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
date:
|
|
custom: []
|
|
name: date
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:35'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
image:
|
|
custom: []
|
|
name: image
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
note:
|
|
custom: []
|
|
name: note
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
type: debit
|
|
transaction_type: adjust_cash
|
|
amount: 56
|
|
date: '2026-04-25T14:39:35'
|
|
note: consequatur
|
|
fileParameters:
|
|
image: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/cashes/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the cash.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/cashes/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the cash.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
to:
|
|
custom: []
|
|
name: to
|
|
description: 'The <code>id</code> of an existing record in the payment_types table.'
|
|
required: false
|
|
example: null
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
type:
|
|
custom: []
|
|
name: type
|
|
description: ''
|
|
required: false
|
|
example: debit
|
|
type: string
|
|
enumValues:
|
|
- credit
|
|
- debit
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
transaction_type:
|
|
custom: []
|
|
name: transaction_type
|
|
description: ''
|
|
required: true
|
|
example: adjust_cash
|
|
type: string
|
|
enumValues:
|
|
- cash_to_bank
|
|
- adjust_cash
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
amount:
|
|
custom: []
|
|
name: amount
|
|
description: 'Must be at least 0.01.'
|
|
required: true
|
|
example: 56
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
date:
|
|
custom: []
|
|
name: date
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:35'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
image:
|
|
custom: []
|
|
name: image
|
|
description: 'Must be an image.'
|
|
required: false
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
note:
|
|
custom: []
|
|
name: note
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
type: debit
|
|
transaction_type: adjust_cash
|
|
amount: 56
|
|
date: '2026-04-25T14:39:35'
|
|
note: consequatur
|
|
fileParameters:
|
|
image: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/cashes/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the cash.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/cheques
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/cheques
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
transaction_id:
|
|
custom: []
|
|
name: transaction_id
|
|
description: 'The <code>id</code> of an existing record in the transactions table.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
date:
|
|
custom: []
|
|
name: date
|
|
description: 'Must be a valid date.'
|
|
required: false
|
|
example: '2026-04-25T14:39:35'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
note:
|
|
custom: []
|
|
name: note
|
|
description: ''
|
|
required: false
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
payment_type:
|
|
custom: []
|
|
name: payment_type
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
transaction_id: consequatur
|
|
date: '2026-04-25T14:39:35'
|
|
note: consequatur
|
|
payment_type: consequatur
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/cheques/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the cheque.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: 'api/v1/cheque-reopen/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the cheque reopen.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/product-settings
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/product-settings
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
show_product_name:
|
|
custom: []
|
|
name: show_product_name
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_price:
|
|
custom: []
|
|
name: show_product_price
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_code:
|
|
custom: []
|
|
name: show_product_code
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_stock:
|
|
custom: []
|
|
name: show_product_stock
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_sale_price:
|
|
custom: []
|
|
name: show_product_sale_price
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_dealer_price:
|
|
custom: []
|
|
name: show_product_dealer_price
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_wholesale_price:
|
|
custom: []
|
|
name: show_product_wholesale_price
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_unit:
|
|
custom: []
|
|
name: show_product_unit
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_brand:
|
|
custom: []
|
|
name: show_product_brand
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_category:
|
|
custom: []
|
|
name: show_product_category
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_manufacturer:
|
|
custom: []
|
|
name: show_product_manufacturer
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_image:
|
|
custom: []
|
|
name: show_product_image
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_expire_date:
|
|
custom: []
|
|
name: show_expire_date
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_alert_qty:
|
|
custom: []
|
|
name: show_alert_qty
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_vat_id:
|
|
custom: []
|
|
name: show_vat_id
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_vat_type:
|
|
custom: []
|
|
name: show_vat_type
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_exclusive_price:
|
|
custom: []
|
|
name: show_exclusive_price
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_inclusive_price:
|
|
custom: []
|
|
name: show_inclusive_price
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_profit_percent:
|
|
custom: []
|
|
name: show_profit_percent
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_capacity:
|
|
custom: []
|
|
name: show_capacity
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_weight:
|
|
custom: []
|
|
name: show_weight
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_color:
|
|
custom: []
|
|
name: show_color
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_type:
|
|
custom: []
|
|
name: show_type
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_size:
|
|
custom: []
|
|
name: show_size
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_batch_no:
|
|
custom: []
|
|
name: show_batch_no
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_mfg_date:
|
|
custom: []
|
|
name: show_mfg_date
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_model_no:
|
|
custom: []
|
|
name: show_model_no
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
default_sale_price:
|
|
custom: []
|
|
name: default_sale_price
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
default_wholesale_price:
|
|
custom: []
|
|
name: default_wholesale_price
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
default_dealer_price:
|
|
custom: []
|
|
name: default_dealer_price
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_type_single:
|
|
custom: []
|
|
name: show_product_type_single
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_type_variant:
|
|
custom: []
|
|
name: show_product_type_variant
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_type_combo:
|
|
custom: []
|
|
name: show_product_type_combo
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_warehouse:
|
|
custom: []
|
|
name: show_warehouse
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_action:
|
|
custom: []
|
|
name: show_action
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_rack:
|
|
custom: []
|
|
name: show_rack
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_shelf:
|
|
custom: []
|
|
name: show_shelf
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_guarantee:
|
|
custom: []
|
|
name: show_guarantee
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_warranty:
|
|
custom: []
|
|
name: show_warranty
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_serial:
|
|
custom: []
|
|
name: show_serial
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
default_batch_no:
|
|
custom: []
|
|
name: default_batch_no
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
default_expired_date:
|
|
custom: []
|
|
name: default_expired_date
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
default_mfg_date:
|
|
custom: []
|
|
name: default_mfg_date
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
expire_date_type:
|
|
custom: []
|
|
name: expire_date_type
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
mfg_date_type:
|
|
custom: []
|
|
name: mfg_date_type
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_batch_no:
|
|
custom: []
|
|
name: show_product_batch_no
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
show_product_expire_date:
|
|
custom: []
|
|
name: show_product_expire_date
|
|
description: ''
|
|
required: false
|
|
example: 17
|
|
type: integer
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
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
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/product/generate-code
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/bulk-uploads
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: multipart/form-data
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
file:
|
|
custom: []
|
|
name: file
|
|
description: 'Must be a file.'
|
|
required: true
|
|
example: null
|
|
type: file
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters: []
|
|
fileParameters:
|
|
file: null
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/change-password
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
current_password:
|
|
custom: []
|
|
name: current_password
|
|
description: ''
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
password:
|
|
custom: []
|
|
name: password
|
|
description: 'Must be at least 6 characters.'
|
|
required: true
|
|
example: '[2UZ5ij-e/dl4'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
current_password: consequatur
|
|
password: '[2UZ5ij-e/dl4'
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/new-invoice
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
platform:
|
|
custom: []
|
|
name: platform
|
|
description: ''
|
|
required: true
|
|
example: due_collects
|
|
type: string
|
|
enumValues:
|
|
- sales
|
|
- purchases
|
|
- due_collects
|
|
- sales_return
|
|
- purchases_return
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
platform: due_collects
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/invoice-settings
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/invoice-settings/update
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
invoice_size:
|
|
custom: []
|
|
name: invoice_size
|
|
description: 'Must not be greater than 100 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues:
|
|
- a4
|
|
- 3_inch_80mm
|
|
- 2_inch_58mm
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
invoice_size: vmqeopfuudtdsufvyvddq
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/business-delete
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
password:
|
|
custom: []
|
|
name: password
|
|
description: ''
|
|
required: true
|
|
example: 'O[2UZ5ij-e/dl4m{o,'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
password: 'O[2UZ5ij-e/dl4m{o,'
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/party-ledger/{party_id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
party_id:
|
|
custom: []
|
|
name: party_id
|
|
description: 'The ID of the party.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
party_id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/money-receipt/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the money receipt.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/currency-settings
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/currency-settings
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
currency:
|
|
custom: []
|
|
name: currency
|
|
description: 'Must not be greater than 100 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues:
|
|
- us
|
|
- european
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
currency: vmqeopfuudtdsufvyvddq
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/transactions
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/sign-out
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/refresh-token
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/branches
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Display a listing of the resource.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/branches
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Store a newly created resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
phone:
|
|
custom: []
|
|
name: phone
|
|
description: 'Must not be greater than 20 characters.'
|
|
required: false
|
|
example: amniihfqcoynlazgh
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address. Must not be greater than 255 characters.'
|
|
required: false
|
|
example: roob.mona@example.org
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
address:
|
|
custom: []
|
|
name: address
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: xbajwbpilpmufinllwloa
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
branchOpeningBalance:
|
|
custom: []
|
|
name: branchOpeningBalance
|
|
description: 'Must be at least 0.'
|
|
required: false
|
|
example: 72
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
description:
|
|
custom: []
|
|
name: description
|
|
description: 'Must not be greater than 1000 characters.'
|
|
required: false
|
|
example: 'Qui ducimus nihil laudantium nihil autem omnis cum molestiae.'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
phone: amniihfqcoynlazgh
|
|
email: roob.mona@example.org
|
|
address: xbajwbpilpmufinllwloa
|
|
branchOpeningBalance: 72
|
|
description: 'Qui ducimus nihil laudantium nihil autem omnis cum molestiae.'
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/branches/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Update the specified resource in storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the branch.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
phone:
|
|
custom: []
|
|
name: phone
|
|
description: 'Must not be greater than 20 characters.'
|
|
required: false
|
|
example: amniihfqcoynlazgh
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address. Must not be greater than 255 characters.'
|
|
required: false
|
|
example: roob.mona@example.org
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
address:
|
|
custom: []
|
|
name: address
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: false
|
|
example: xbajwbpilpmufinllwloa
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
branchOpeningBalance:
|
|
custom: []
|
|
name: branchOpeningBalance
|
|
description: 'Must be at least 0.'
|
|
required: false
|
|
example: 72
|
|
type: number
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
description:
|
|
custom: []
|
|
name: description
|
|
description: 'Must not be greater than 1000 characters.'
|
|
required: false
|
|
example: 'Qui ducimus nihil laudantium nihil autem omnis cum molestiae.'
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
phone: amniihfqcoynlazgh
|
|
email: roob.mona@example.org
|
|
address: xbajwbpilpmufinllwloa
|
|
branchOpeningBalance: 72
|
|
description: 'Qui ducimus nihil laudantium nihil autem omnis cum molestiae.'
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/branches/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: 'Remove the specified resource from storage.'
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the branch.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/switch-branch/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the switch branch.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: 'api/v1/exit-branch/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the exit branch.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- GET
|
|
uri: api/v1/warehouses
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses:
|
|
-
|
|
custom: []
|
|
status: 401
|
|
content: '{"message":"Unauthenticated."}'
|
|
headers:
|
|
cache-control: 'no-cache, private'
|
|
content-type: application/json
|
|
access-control-allow-origin: '*'
|
|
description: null
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- POST
|
|
uri: api/v1/warehouses
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters: []
|
|
cleanUrlParameters: []
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
phone:
|
|
custom: []
|
|
name: phone
|
|
description: 'Must not be greater than 20 characters.'
|
|
required: false
|
|
example: amniihfqcoynlazgh
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
address:
|
|
custom: []
|
|
name: address
|
|
description: 'Must not be greater than 500 characters.'
|
|
required: false
|
|
example: dtqtqxbajwbpilpmufinl
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address. Must not be greater than 255 characters.'
|
|
required: false
|
|
example: imogene.mante@example.com
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
phone: amniihfqcoynlazgh
|
|
address: dtqtqxbajwbpilpmufinl
|
|
email: imogene.mante@example.com
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- PUT
|
|
- PATCH
|
|
uri: 'api/v1/warehouses/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the warehouse.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters:
|
|
name:
|
|
custom: []
|
|
name: name
|
|
description: 'Must not be greater than 255 characters.'
|
|
required: true
|
|
example: vmqeopfuudtdsufvyvddq
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
phone:
|
|
custom: []
|
|
name: phone
|
|
description: 'Must not be greater than 20 characters.'
|
|
required: false
|
|
example: amniihfqcoynlazgh
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
address:
|
|
custom: []
|
|
name: address
|
|
description: 'Must not be greater than 500 characters.'
|
|
required: false
|
|
example: dtqtqxbajwbpilpmufinl
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
email:
|
|
custom: []
|
|
name: email
|
|
description: 'Must be a valid email address. Must not be greater than 255 characters.'
|
|
required: false
|
|
example: imogene.mante@example.com
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: true
|
|
deprecated: false
|
|
cleanBodyParameters:
|
|
name: vmqeopfuudtdsufvyvddq
|
|
phone: amniihfqcoynlazgh
|
|
address: dtqtqxbajwbpilpmufinl
|
|
email: imogene.mante@example.com
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|
|
-
|
|
custom: []
|
|
httpMethods:
|
|
- DELETE
|
|
uri: 'api/v1/warehouses/{id}'
|
|
metadata:
|
|
custom: []
|
|
groupName: Endpoints
|
|
groupDescription: ''
|
|
subgroup: ''
|
|
subgroupDescription: ''
|
|
title: ''
|
|
description: ''
|
|
authenticated: false
|
|
deprecated: false
|
|
headers:
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
urlParameters:
|
|
id:
|
|
custom: []
|
|
name: id
|
|
description: 'The ID of the warehouse.'
|
|
required: true
|
|
example: consequatur
|
|
type: string
|
|
enumValues: []
|
|
exampleWasSpecified: false
|
|
nullable: false
|
|
deprecated: false
|
|
cleanUrlParameters:
|
|
id: consequatur
|
|
queryParameters: []
|
|
cleanQueryParameters: []
|
|
bodyParameters: []
|
|
cleanBodyParameters: []
|
|
fileParameters: []
|
|
responses: []
|
|
responseFields: []
|
|
auth: []
|
|
controller: null
|
|
method: null
|
|
route: null
|