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

/admins
admin_id int✅
admin_firebase_uid varchar
admin_full_name varchar
admin_phone varchar
admin_role varchar
admin_is_active tinyint
admin_created_at timestamp
/audit_log
audit_log_id bigint✅
admin_id int
audit_log_action varchar
audit_log_table_name varchar
audit_log_record_id int
audit_log_details json
audit_log_created_at timestamp
/balance_collections
balance_collection_id int✅
admin_id int
balance_collection_amount decimal
balance_collection_date timestamp
balance_collection_collected_by int
balance_collection_notes text
balance_collection_created_at timestamp
/invoice_items
invoice_item_id int✅
invoice_id int
item_id int
purchase_item_id int
invoice_item_quantity int
invoice_item_unit_price decimal
invoice_item_cost_price decimal
invoice_item_discount_amount decimal
invoice_item_line_total decimal
invoice_item_created_at timestamp
/invoices
invoice_id int✅
invoice_number varchar
invoice_customer_name varchar
invoice_customer_phone varchar
invoice_date timestamp
invoice_subtotal decimal
invoice_discount_total decimal
invoice_net_total decimal
invoice_notes text
invoice_created_by int
invoice_created_at timestamp
/item_types
item_type_id int✅
item_type_name varchar
/items
item_id int✅
item_scientific_name varchar
item_generic_name varchar
item_commercial_name varchar
item_brand varchar
item_type_id int
item_barcode varchar
item_notes text
item_created_by int
item_created_at timestamp
item_updated_at timestamp
/purchase_items
purchase_item_id int✅
purchase_id int
item_id int
purchase_item_quantity int
purchase_item_remaining_quantity int
purchase_item_cost_price decimal
purchase_item_sell_price decimal
purchase_item_expiry_date date
purchase_item_is_active tinyint
purchase_item_created_at timestamp
/purchases
purchase_id int✅
supplier_id int
purchase_date date
purchase_total_amount decimal
purchase_notes text
purchase_created_by int
purchase_created_at timestamp
/return_items
return_item_id int✅
return_id int
invoice_item_id int
purchase_item_id int
return_item_quantity int
return_item_unit_price decimal
return_item_line_total decimal
return_item_created_at timestamp
/returns
return_id int✅
invoice_id int
return_date timestamp
return_total_amount decimal
return_reason text
return_created_by int
return_created_at timestamp
/supplier_payments
supplier_payment_id int✅
supplier_id int
purchase_id int
supplier_payment_amount decimal
supplier_payment_date date
supplier_payment_method varchar
supplier_payment_notes text
supplier_payment_created_by int
supplier_payment_created_at timestamp
/suppliers
supplier_id int✅
supplier_name varchar
supplier_phone varchar
supplier_email varchar
supplier_address text
supplier_notes text
supplier_created_by int
supplier_created_at timestamp
/v_admin_balance
admin_id int
admin_full_name varchar
total_sales decimal
total_refunds decimal
total_collected decimal
current_balance decimal
/v_batch_profit
batch_id int
item_id int
item_scientific_name varchar
cost_price decimal
sell_price decimal
total_purchased int
qty_sold decimal
qty_returned decimal
net_sold decimal
gross_revenue decimal
total_refunded decimal
net_revenue decimal
total_cost decimal
profit decimal
/v_batch_stock
batch_id int
item_id int
item_scientific_name varchar
item_generic_name varchar
item_commercial_name varchar
purchase_id int
total_purchased int
remaining_quantity int
cost_price decimal
sell_price decimal
expiry_date date
is_active tinyint
total_sold decimal
total_returned decimal
/v_expiring_soon
batch_id int
item_id int
item_scientific_name varchar
item_commercial_name varchar
expiry_date date
remaining_quantity int
days_until_expiry int
/v_supplier_ledger
supplier_id int
supplier_name varchar
total_purchased decimal
total_paid decimal
balance_due decimal