API Documentaion


This is the API documentation for the API END-POINTS.

import this file to postman and test all following end points.

Setup

                
                

# path to your project folder
> npm install
> npm start

Installed dependencies

                
                

"dependencies": {
    "@hapi/joi": "^17.1.1",
    "body-parser": "^1.19.2",
    "express": "^4.17.3",
    "knex": "^1.0.4",
    "morgan": "^1.10.0",
    "dotenv": "^16.0.0",
    "mysql": "^2.18.1",
    "mysql2": "^2.3.3"
},

Routes

/accounts
account_id int✅
account_name varchar
currency_id int
user_id int
created_at datetime
/categories
category_id int✅
category_name varchar
user_id int
created_at datetime
/currencies
currency_id int✅
currency_code enum
user_id int
created_at datetime
/currency_exchanges
exchange_id int✅
from_account_id int
to_account_id int
from_amount decimal
to_amount decimal
exchange_rate decimal
notes text
user_id int
created_at datetime
/event_items
event_item_id int✅
event_id int
item_id int
quantity int
status enum
consumed_quantity int
returned_quantity int
user_id int
created_at datetime
/event_payments
event_payment_id int✅
event_id int
account_id int
payment_amount decimal
payment_currency_id int
converted_amount decimal
payment_method enum
notes text
user_id int
created_at datetime
/events
event_id int✅
event_name varchar
event_type enum
start_date date
end_date date
total_price decimal
currency_id int
payment_status enum
user_id int
created_at datetime
/expense_types
expense_type_id int✅
type_name varchar
user_id int
created_at datetime
/expenses
expense_id int✅
expense_type_id int
account_id int
amount decimal
description text
expense_date date
user_id int
created_at datetime
/financial_transactions
transaction_id int✅
account_id int
transaction_type enum
reference_id int
amount decimal
direction enum
notes text
user_id int
created_at datetime
/inventories
inventory_id int✅
inventory_name enum
user_id int
created_at datetime
/inventory_stock
stock_id int✅
inventory_id int
item_id int
quantity int
user_id int
created_at datetime
/inventory_transfers
transfer_id int✅
item_id int
from_inventory_id int
to_inventory_id int
quantity int
user_id int
transfer_date datetime
/item_losses
loss_id int✅
event_id int
item_id int
quantity int
loss_type enum
notes text
user_id int
recorded_at datetime
/items
item_id int✅
item_name varchar
item_type enum
usage_type enum
item_photo varchar
color varchar
category_id int
user_id int
created_at datetime
/manager_withdrawals
withdrawal_id int✅
account_id int
amount decimal
reason text
user_id int
withdrawal_date datetime
/roles
role_id int✅
role_name enum
/sale_item_prices
item_id int✅
buy_price decimal
retail_price decimal
user_id int
created_at datetime
/sale_items
sale_item_id int✅
sale_id int
item_id int
quantity int
buy_price decimal
retail_price decimal
user_id int
created_at datetime
/sales
sale_id int✅
customer_name varchar
customer_phone varchar
user_id int
sale_date datetime
/users
user_id int✅
full_name varchar
phone varchar
role_id int
created_at datetime