# -*- coding: utf-8; -*- ################################################################################ # # pyCOREPOS -- Python Interface to CORE POS # Copyright © 2018-2023 Lance Edgar # # This file is part of pyCOREPOS. # # pyCOREPOS is free software: you can redistribute it and/or modify it under # the terms of the GNU General Public License as published by the Free # Software Foundation, either version 3 of the License, or (at your option) # any later version. # # pyCOREPOS is distributed in the hope that it will be useful, but WITHOUT ANY # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more # details. # # You should have received a copy of the GNU General Public License along with # pyCOREPOS. If not, see . # ################################################################################ """ CORE POS Transaction Data Model """ import sqlalchemy as sa from sqlalchemy import orm Base = orm.declarative_base() # TODO: not sure what primary key should be for this? am trying a # composite one so far, we'll see...cf. also andy's comments in # https://github.com/CORE-POS/IS4C/pull/1189#issuecomment-1597481138 class StockPurchase(Base): """ Represents a member equity payment. """ __tablename__ = 'stockpurchases' card_number = sa.Column('card_no', sa.Integer(), nullable=False, primary_key=True, autoincrement=False) amount = sa.Column('stockPurchase', sa.Numeric(precision=10, scale=2), nullable=True) datetime = sa.Column('tdate', sa.DateTime(), nullable=True, primary_key=True, autoincrement=False) transaction_number = sa.Column('trans_num', sa.String(length=50), nullable=True, primary_key=True) transaction_id = sa.Column('trans_id', sa.Integer(), nullable=True) department_number = sa.Column('dept', sa.Integer(), nullable=True, primary_key=True, autoincrement=False) def __str__(self): return f"#{self.card_number} for ${self.amount}" class EquityLiveBalance(Base): __tablename__ = 'equity_live_balance' member_number = sa.Column('memnum', sa.Integer(), nullable=False, primary_key=True, autoincrement=False) payments = sa.Column(sa.Numeric(precision=10, scale=2), nullable=True) start_date = sa.Column('startdate', sa.DateTime(), nullable=True) class TransactionDetailBase(object): """ Represents a POS transaction detail record. """ # store store_row_id = sa.Column(sa.Integer(), primary_key=True, nullable=False) store_id = sa.Column(sa.Integer(), nullable=True, default=0) # register register_number = sa.Column('register_no', sa.Integer(), nullable=True) pos_row_id = sa.Column(sa.Integer(), nullable=True) # txn transaction_id = sa.Column('trans_id', sa.Integer(), nullable=True) transaction_number = sa.Column('trans_no', sa.Integer(), nullable=True) transaction_type = sa.Column('trans_type', sa.String(length=1), nullable=True) transaction_subtype = sa.Column('trans_subtype', sa.String(length=2), nullable=True) transaction_status = sa.Column('trans_status', sa.String(length=1), nullable=True) # timestamps date_time = sa.Column('datetime', sa.DateTime(), nullable=True) # cashier employee_number = sa.Column('emp_no', sa.Integer(), nullable=True) # customer card_number = sa.Column('card_no', sa.Integer(), nullable=True) member_type = sa.Column('memType', sa.Integer(), nullable=True) staff = sa.Column(sa.Boolean(), nullable=True) ############################## # remainder is "line item" ... ############################## upc = sa.Column(sa.String(length=13), nullable=True) department_number = sa.Column('department', sa.Integer(), nullable=True) description = sa.Column(sa.String(length=30), nullable=True) quantity = sa.Column(sa.Float(), nullable=True) scale = sa.Column(sa.Boolean(), nullable=True, default=False) cost = sa.Column(sa.Numeric(precision=10, scale=2), nullable=True) unit_price = sa.Column('unitPrice', sa.Numeric(precision=10, scale=2), nullable=True) total = sa.Column(sa.Numeric(precision=10, scale=2), nullable=True) reg_price = sa.Column('regPrice', sa.Numeric(precision=10, scale=2), nullable=True) tax = sa.Column(sa.Boolean(), nullable=True) food_stamp = sa.Column('foodstamp', sa.Boolean(), nullable=True) discount = sa.Column(sa.Numeric(precision=10, scale=2), nullable=True) member_discount = sa.Column('memDiscount', sa.Numeric(precision=10, scale=2), nullable=True) discountable = sa.Column(sa.Boolean(), nullable=True) discount_type = sa.Column('discounttype', sa.Integer(), nullable=True) voided = sa.Column(sa.Boolean(), nullable=True) percent_discount = sa.Column('percentDiscount', sa.Integer(), nullable=True) item_quantity = sa.Column('ItemQtty', sa.Float(), nullable=True) volume_discount_type = sa.Column('volDiscType', sa.Integer(), nullable=True) volume = sa.Column(sa.Integer(), nullable=True) volume_special = sa.Column('VolSpecial', sa.Numeric(precision=10, scale=2), nullable=True) mix_match = sa.Column('mixMatch', sa.String(length=13), nullable=True) matched = sa.Column(sa.Boolean(), nullable=True) num_flag = sa.Column('numflag', sa.Integer(), nullable=True, default=0) char_flag = sa.Column('charflag', sa.String(length=2), nullable=True) def __str__(self): return self.description or '' class TransactionDetail(TransactionDetailBase, Base): """ Represents a POS transaction detail record. """ __tablename__ = 'dtransactions'