Module: QBFC

Defined in:
lib/qbfc.rb,
lib/qbfc/base.rb,
lib/qbfc/info.rb,
lib/qbfc/item.rb,
lib/qbfc/list.rb,
lib/qbfc/terms.rb,
lib/qbfc/entity.rb,
lib/qbfc/report.rb,
lib/qbfc/report.rb,
lib/qbfc/element.rb,
lib/qbfc/request.rb,
lib/qbfc/session.rb,
lib/qbfc/qb_types.rb,
lib/qbfc/voidable.rb,
lib/qbfc/modifiable.rb,
lib/qbfc/ole_wrapper.rb,
lib/qbfc/reports/job.rb,
lib/qbfc/transaction.rb,
lib/qbfc/reports/rows.rb,
lib/qbfc/reports/time.rb,
lib/qbfc/lists/account.rb,
lib/qbfc/qb_collection.rb,
lib/qbfc/reports/aging.rb,
lib/qbfc/lists/qb_class.rb,
lib/qbfc/infos/generated.rb,
lib/qbfc/items/generated.rb,
lib/qbfc/lists/generated.rb,
lib/qbfc/terms/generated.rb,
lib/qbfc/entities/generated.rb,
lib/qbfc/reports/custom_detail.rb,
lib/qbfc/reports/budget_summary.rb,
lib/qbfc/reports/custom_summary.rb,
lib/qbfc/reports/general_detail.rb,
lib/qbfc/reports/payroll_detail.rb,
lib/qbfc/transactions/generated.rb,
lib/qbfc/reports/general_summary.rb,
lib/qbfc/reports/payroll_summary.rb

Defined Under Namespace

Modules: Modifiable, Reports, Voidable Classes: Account, Base, BaseClassNewError, Element, Entity, Info, Item, List, NotSavableError, OLEWrapper, QBClass, QBCollection, QBXMLVersionError, QuickbooksClosedError, Report, Request, Session, SetValueMissing, Terms, Transaction, UnknownRequestError

Constant Summary collapse

VERSION = 
'0.3.0'
INFO_TYPES =

Generated Info types

%w{Company CompanyActivity Host Preferences}
ITEM_TYPES =

Generated Item Types (Inherit from List)

%w{ItemService ItemNonInventory ItemOtherCharge ItemInventory ItemInventoryAssembly ItemFixedAsset
ItemSubtotal ItemDiscount ItemPayment ItemSalesTax ItemSalesTaxGroup ItemGroup}
LIST_TYPES =

Generated List types that will inherit directly from QBFC::List

%w{ BillingRate CustomerMsg CustomerType JobType  PaymentMethod
PayrollItemNonWage PayrollItemWage PriceLevel SalesRep SalesTaxCode
ShipMethod ToDo Vehicle VendorType}
LIST_MOD_TYPES =

Generated List types that do accept Mod Requests (most direct subclasses of List do not)

%w{ PriceLevel SalesRep Vehicle }
TERMS_TYPES =

Generated Terms Types (Inherit from List)

%w{DateDrivenTerms StandardTerms}
ENTITY_TYPES =

Generated Entity Types (Inherit from List)

%w{Customer Employee OtherName Vendor}
TXN_TYPES =

Generated Transaction types

%w{ARRefundCreditCard Bill BillPaymentCheck BillPaymentCreditCard
BuildAssembly Charge Check CreditCardCharge CreditCardCredit CreditMemo
Deposit Estimate InventoryAdjustment Invoice ItemReceipt JournalEntry
PurchaseOrder ReceivePayment SalesOrder SalesReceipt SalesTaxPaymentCheck 
TimeTracking VehicleMileage VendorCredit}
TXN_VOIDABLE_TYPES =

Generated Transaction types that support TxnVoid Request

%w{ARRefundCreditCard Bill BillPaymentCheck
BillPaymentCreditCard Charge Check CreditCardCharge CreditCardCredit
CreditMemo Deposit InventoryAdjustment Invoice ItemReceipt JournalEntry
SalesReceipt VendorCredit}
TXN_NO_MOD_TYPES =

Generated Transaction types that don’t support Mod Requests

%w{ARRefundCreditCard BillPaymentCreditCard Deposit
InventoryAdjustment VehicleMileage VendorCredit }

Class Method Summary collapse

Class Method Details

.generate(names, superclass, include_modules = {}) ⇒ Object

Generate classes.

  • names: Array of class names.

  • superclass: Superclass of classes to be generated.

  • includes: hash of Module => names of classes to include this module.



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/qbfc.rb', line 24

def generate(names, superclass, include_modules = {})
  names.each do | class_name |
    const_set(class_name, Class.new(superclass))
  end
  
  include_modules.each do | mod, classes |
    classes.each do | class_name |
      const_get(class_name).__send__(:include, mod)
    end
  end
end

.session(*args, &block) ⇒ Object

Opens and yields a QBFC::Session



16
17
18
 
# File 'lib/qbfc.rb', line 16

def session(*args, &block)
  QBFC::Session::open(*args, &block)
end