:mod:`cam32`
============

.. automodule:: cam32

.. attribute:: __version__

   PyCAM32's version string.

.. attribute:: metadata

   ``sqlalchemy.MetaData`` instance, which presumably has been reflected from
   the CAM32 database.

.. autofunction:: get_table_names 

``Session``
-----------

.. autoclass:: Session
   :members:

Classes
-------

These represent various types of data found in the CAM32 database.

``AuthorizedUser``
^^^^^^^^^^^^^^^^^^

.. autoclass:: AuthorizedUser

   .. autoattribute:: activation_date
   .. autoattribute:: allow_check
   .. autoattribute:: allow_store_charge
   .. autoattribute:: customer_number
   .. autoattribute:: expiration_date
   .. autoattribute:: first_name
   .. autoattribute:: last_name
   .. autoattribute:: middle_name
   .. autoattribute:: name_suffix
   .. autoattribute:: user_id

``Customer``
^^^^^^^^^^^^

.. autoclass:: Customer

   .. autoattribute:: address1
   .. autoattribute:: address2
   .. attribute:: authorized_users

      A list of :class:`cam32.AuthorizedUser` instances attached to the
      customer.

   .. autoattribute:: birth_date
   .. autoattribute:: birth_day
   .. autoattribute:: birth_month
   .. autoattribute:: birth_year
   .. autoattribute:: charge_type
   .. autoattribute:: city
   .. autoattribute:: code
   .. attribute:: codes

      A list of :class:`cam32.CustomerCode` instances attached to the customer.

   .. autoattribute:: company_name
   .. autoattribute:: credit_balance
   .. autoattribute:: credit_limit
   .. autoattribute:: customer_number
   .. autoattribute:: discount_percent
   .. autoattribute:: effective_date
   .. autoattribute:: email_address
   .. automethod:: get_birth_date
   .. autoattribute:: last_purchase_date
   .. autoattribute:: late_percent
   .. autoattribute:: mail_code
   .. autoattribute:: name
   .. autoattribute:: note_lines
   .. autoattribute:: notes
   .. autoattribute:: phone_number
   .. autoattribute:: price_code
   .. autoattribute:: purchaser_name_required
   .. autoattribute:: recurring_amount
   .. autoattribute:: sex
   .. autoattribute:: state
   .. autoattribute:: tax_percent
   .. autoattribute:: terms
   .. autoattribute:: type
   .. autoattribute:: wholesale
   .. autoattribute:: zip_code

``CustomerCode``
^^^^^^^^^^^^^^^^

.. autoclass:: CustomerCode

   .. autoattribute:: customer_number
   .. autoattribute:: data
   .. autoattribute:: sequence_number

``CustomerNote``
^^^^^^^^^^^^^^^^

.. autoclass:: CustomerNote

   .. autoattribute:: customer_number
   .. autoattribute:: date
   .. autoattribute:: store_number
   .. autoattribute:: text
   .. autoattribute:: time

``CustomerNoteLine``
^^^^^^^^^^^^^^^^^^^^

.. autoclass:: CustomerNoteLine

   .. autoattribute:: customer_number
   .. autoattribute:: date
   .. autoattribute:: line_number
   .. autoattribute:: store_number
   .. autoattribute:: text
   .. autoattribute:: time

``Department``
^^^^^^^^^^^^^^

.. autoclass:: Department

   .. autoattribute:: department_number
   .. autoattribute:: name
   .. autoattribute:: store_number

``DepartmentClass``
^^^^^^^^^^^^^^^^^^^

.. autoclass:: DepartmentClass

   .. autoattribute:: class_number
   .. autoattribute:: department_number
   .. autoattribute:: description
   .. autoattribute:: subclasses

``DepartmentSubclass``
^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: DepartmentSubclass

   .. autoattribute:: class_
   .. autoattribute:: class_number
   .. autoattribute:: department_number
   .. autoattribute:: description
   .. autoattribute:: subclass_number

``InventoryCrossRef``
^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: InventoryCrossRef

   .. autoattribute:: data
   .. autoattribute:: item
   .. autoattribute:: item_number
   .. autoattribute:: sequence_number
   .. autoattribute:: type
   .. autoattribute:: vendor_number

``InventoryItem``
^^^^^^^^^^^^^^^^^

.. autoclass:: InventoryItem

   .. autoattribute:: append
   .. autoattribute:: append_number
   .. autoattribute:: base_item_number
   .. autoattribute:: calculate_quantity
   .. autoattribute:: case_quantity
   .. autoattribute:: class_number
   .. autoattribute:: code
   .. autoattribute:: comments_attached
   .. autoattribute:: comments
   .. autoattribute:: commission
   .. autoattribute:: composite
   .. autoattribute:: cost
   .. autoattribute:: date_added
   .. autoattribute:: delete
   .. autoattribute:: department_number
   .. autoattribute:: description
   .. autoattribute:: discountable
   .. autoattribute:: flex_plan
   .. autoattribute:: food_stampable
   .. autoattribute:: has_long_description
   .. autoattribute:: history_flag
   .. autoattribute:: inventoried
   .. autoattribute:: item_label_format
   .. autoattribute:: item_number
   .. autoattribute:: is_kit
   .. autoattribute:: is_kit_part
   .. autoattribute:: kit
   .. autoattribute:: kit_parents
   .. autoattribute:: last_receipt
   .. autoattribute:: last_sold
   .. autoattribute:: legal_purchase_age
   .. autoattribute:: location
   .. autoattribute:: max_stocking_level
   .. autoattribute:: mfr_part_number
   .. autoattribute:: mtd_cog_sold
   .. autoattribute:: mtd_quantity_sold
   .. autoattribute:: mtd_value_sold
   .. attribute:: multi_vendor

      A dictionary of :class:`cam32.MultiVendor` instances for the item, keyed
      by vendor number.

   .. autoattribute:: on_hand
   .. autoattribute:: on_order
   .. autoattribute:: on_sale
   .. autoattribute:: open_plu
   .. autoattribute:: price1
   .. autoattribute:: price2
   .. autoattribute:: price3
   .. autoattribute:: price4
   .. autoattribute:: price5
   .. autoattribute:: price6
   .. autoattribute:: promo_start_date
   .. autoattribute:: promo_stop_date
   .. autoattribute:: protect_reorder_point
   .. autoattribute:: rental
   .. autoattribute:: reorder_point
   .. autoattribute:: requested
   .. autoattribute:: scale_compulsion
   .. attribute:: scancodes

      A list of scancodes for the item, as strings.

   .. autoattribute:: secondary_code
   .. autoattribute:: stocked
   .. autoattribute:: subclass_number
   .. autoattribute:: tax_flag
   .. autoattribute:: unit_control
   .. autoattribute:: unit_of_sale
   .. autoattribute:: vendor
   .. autoattribute:: vendor_number
   .. autoattribute:: ytd_cog_sold
   .. autoattribute:: ytd_quantity_scrapped
   .. autoattribute:: ytd_quantity_sold
   .. autoattribute:: ytd_value_scrapped
   .. autoattribute:: ytd_value_sold

``ItemComment``
^^^^^^^^^^^^^^^

.. autoclass:: ItemComment

   .. autoattribute:: item_number
   .. autoattribute:: ordinal
   .. autoattribute:: print_flag
   .. autoattribute:: text

``Kit``
^^^^^^^

.. autoclass:: Kit

   .. attribute:: item

      References the :class:`cam32.InventoryItem` instance with which the kit is
      associated.

   .. autoattribute:: item_number
   .. attribute:: parts

      References a list of :class:`cam32.KitPart` instances which belong to the
      kit.

   .. attribute:: replacement_cost

      The replacement cost for the kit.

``KitData``
^^^^^^^^^^^

.. autoclass:: KitData

   .. autoattribute:: item_number
   .. attribute:: itemXX_item_number

      There are 30 such attributes for each ``KIT_DATA`` record.  The above
      attribute name is not actually valid; the real attributes include:

      * ``item1_item_number``
      * ``item2_item_number``
      * ...
      * ``item30_item_number``

      Each attribute returns the item number for the kit part.

   .. attribute:: itemXX_quantity

      Same scenario as for :attr:`cam32.KitData.itemXX_item_number`, except
      returns the kit part's quantity value.

   .. attribute:: itemXX_star

      Same scenario as for :attr:`cam32.KitData.itemXX_item_number`, except
      returns the kit part's "star" value (whatever that is).
   
   .. autoattribute:: record_number
   .. autoattribute:: replacement_cost

``KitPart``
^^^^^^^^^^^

.. autoclass:: KitPart

   .. autoattribute:: item
   .. attribute:: item_number

      The part's item number.

   .. attribute:: kit

      References the :class:`cam32.Kit` instance to which the part belongs.

   .. attribute:: ordinal

      Returns the "ordinal" (or "index") value from the part's ``KIT_DATA``
      record's field names, i.e. a number between 1 and 30.

   .. attribute:: quantity

      Returns the part's quantity value.

   .. attribute:: record_number

      Returns the record number value from the ``KIT_DATA`` record from whence
      this part came.

   .. attribute:: star

      Returns the part's "star" value (whatever that is).

``MultiVendor``
^^^^^^^^^^^^^^^

.. autoclass:: MultiVendor

   .. autoattribute:: item_number
   .. autoattribute:: last_cost
   .. autoattribute:: price_break1
   .. autoattribute:: price_break2
   .. autoattribute:: price_break3
   .. autoattribute:: price_break4
   .. autoattribute:: price_break5
   .. autoattribute:: price_break6
   .. autoattribute:: price_break7
   .. autoattribute:: price_code
   .. autoattribute:: quantity_break1
   .. autoattribute:: quantity_break2
   .. autoattribute:: quantity_break3
   .. autoattribute:: quantity_break4
   .. autoattribute:: quantity_break5
   .. autoattribute:: quantity_break6
   .. autoattribute:: quantity_break7
   .. autoattribute:: quantity_last_received
   .. autoattribute:: stock_number
   .. autoattribute:: suggested_retail
   .. autoattribute:: vendor
   .. autoattribute:: vendor_number

``PDTAdjustment``
^^^^^^^^^^^^^^^^^

.. autoclass:: PDTAdjustment

   .. autoattribute:: cost
   .. autoattribute:: counted_balance
   .. autoattribute:: counted_flag
   .. autoattribute:: item_number
   .. autoattribute:: posted_flag
   .. autoattribute:: price
   .. autoattribute:: starting_balance
   .. autoattribute:: store_number

``PurchaseOrder``
^^^^^^^^^^^^^^^^^

.. autoclass:: PurchaseOrder

   .. autoattribute:: buyer_name
   .. autoattribute:: confirmation_name
   .. autoattribute:: date_ordered
   .. autoattribute:: date_required
   .. autoattribute:: invoice_number
   .. autoattribute:: order_number
   .. autoattribute:: status
   .. autoattribute:: store_number
   .. autoattribute:: vendor
   .. autoattribute:: vendor_number

``PurchaseOrderDetail``
^^^^^^^^^^^^^^^^^^^^^^^

.. autoclass:: PurchaseOrderDetail

   .. autoattribute:: case_multiplier
   .. autoattribute:: case_quantity
   .. autoattribute:: description
   .. autoattribute:: except_quantity_received
   .. autoattribute:: item_cost
   .. autoattribute:: item_number
   .. autoattribute:: order_number
   .. autoattribute:: original_cost
   .. autoattribute:: original_retail
   .. autoattribute:: quantity_ordered
   .. autoattribute:: quantity_received
   .. autoattribute:: reference_number
   .. autoattribute:: retail_price
   .. autoattribute:: store_number
   .. autoattribute:: total_quantity_ordered
   .. autoattribute:: total_quantity_received
   .. autoattribute:: unit_of_measure

``SalesLogHeader``
^^^^^^^^^^^^^^^^^^

.. autoclass:: SalesLogHeader

   .. autoattribute:: bank_cards_amount
   .. autoattribute:: cash_amount
   .. autoattribute:: charge_amount
   .. autoattribute:: check_amount
   .. autoattribute:: clerk_name
   .. autoattribute:: cost_of_sales
   .. autoattribute:: coupon_amount
   .. autoattribute:: customer
   .. autoattribute:: customer_first_name
   .. autoattribute:: customer_last_name
   .. autoattribute:: customer_number
   .. autoattribute:: date_time
   .. autoattribute:: invoice_number
   .. autoattribute:: non_tax_amount
   .. autoattribute:: register_number
   .. attribute:: resale_number

      The resale number for the invoice.

   .. autoattribute:: sales_clerk_id
   .. autoattribute:: sales_total
   .. autoattribute:: store_number
   .. autoattribute:: subtotal
   .. autoattribute:: tax_amount
   .. autoattribute:: taxable_amount
   .. autoattribute:: tender_amount
   .. autoattribute:: total_lines

``SalesLogDetail``
^^^^^^^^^^^^^^^^^^

.. autoclass:: SalesLogDetail

   .. autoattribute:: class_number
   .. autoattribute:: department_number
   .. autoattribute:: description
   .. autoattribute:: extended_price
   .. autoattribute:: invoice_number
   .. autoattribute:: item
   .. autoattribute:: item_number
   .. autoattribute:: price_paid
   .. autoattribute:: quantity
   .. autoattribute:: reference_number
   .. autoattribute:: retail_price
   .. autoattribute:: store_number
   .. autoattribute:: subclass_number
   .. autoattribute:: suggested_price
   .. autoattribute:: tax_category
   .. autoattribute:: unit_cost
   .. autoattribute:: vendor_number

``Store``
^^^^^^^^^

.. autoclass:: Store

   .. autoattribute:: address
   .. autoattribute:: city
   .. autoattribute:: email_address
   .. autoattribute:: fax_number
   .. autoattribute:: name
   .. autoattribute:: notes
   .. autoattribute:: phone_number
   .. autoattribute:: price_level
   .. autoattribute:: state
   .. autoattribute:: store_number
   .. autoattribute:: zip_code

``Vendor``
^^^^^^^^^^

.. autoclass:: Vendor

   .. autoattribute:: account_number
   .. autoattribute:: address
   .. autoattribute:: city
   .. autoattribute:: contact
   .. autoattribute:: name
   .. autoattribute:: phone_number
   .. autoattribute:: purchase_contact
   .. autoattribute:: sales_address
   .. autoattribute:: sales_city
   .. autoattribute:: sales_name
   .. autoattribute:: sales_phone_number
   .. autoattribute:: sales_state
   .. autoattribute:: sales_zip_code
   .. autoattribute:: state
   .. autoattribute:: vendor_number
   .. autoattribute:: zip_code