rconomic 0.3 → 0.4

data/README.md

@@ -5,6 +5,7 @@ Ruby wrapper for the [e-conomic](http://www.e-conomic.co.uk) SOAP API, that aims
 
 E-conomic is a web-based accounting system. For their marketing speak, see [http://www.e-conomic.co.uk/about/](). More details about their API at [http://www.e-conomic.co.uk/integration/integration-partner/]().
 
+[![Build Status](https://secure.travis-ci.org/lokalebasen/rconomic.png?branch=master)](http://travis-ci.org/lokalebasen/rconomic)
 
 Usage example
 -------------
@@ -60,7 +61,6 @@ Usage example
     # without specifying the voucher number, the API will complain. This way, E-Conomics will assign a voucher number for us.
 
     cash_book_entry = cash_book.entries.create_debtor_payment(:debtor_handle => debtor.handle, :contra_account_handle => { :number => '1920' })
-    cash_book_entry.cash_book_entry_type = "DebtorPayment" # For some reason, we need to specify this.
     cash_book_entry.amount = -123.45
     cash_book_entry.currency_handle = { "Code" => "DKK" }
     cash_book_entry.debtor_invoice_number = invoice.number
@@ -91,6 +91,7 @@ Not even remotely... For now, limited to a small subset of all the [available op
     CurrentInvoiceLine | X      | X    | X      | X
     Debtor             | X      | X    | X      | X
     DebtorContact      | X      | X    | X      | X
+    Entry              | X      | X    | X      | X
     Invoice            | X      | X    |        |
 
 

data/lib/economic/cash_book_entry.rb

@@ -33,50 +33,23 @@ module Economic
                    :project_handle,
                    :start_date,
                    :text,
-                   :cash_book_entry_type,
+                   :type,
                    :vat_account_handle,
                    :voucher_number
 
-    def initialize_defaults
-      self.account_handle = nil
-      self.amount = 0
-      self.amount_default_currency = 0
-      self.bank_payment_creditor_id = 0
-      self.bank_payment_creditor_invoice_id = 0
-      self.bank_payment_type_handle = nil
-      self.capitalise_handle = nil
-      self.cash_book_handle = nil
-      self.contra_account_handle = nil
-      self.contra_vat_account_handle = nil
-      self.cost_type_handle = nil
-      self.creditor_handle = nil
-      self.creditor_invoice_number = nil
-      self.currency_handle = nil
-      self.date = Time.now
-      self.debtor_handle = nil
-      self.debtor_invoice_number = nil
-      self.department_handle = nil
-      self.distribution_key_handle = nil
-      self.due_date = nil
-      self.employee_handle = nil
-      self.end_date = nil
-      self.project_handle = nil
-      self.start_date = Time.now
-      self.text = ""
-      self.cash_book_entry_type = ""
-      self.vat_account_handle = nil
-      self.voucher_number = 0
-    end
-
     def handle
       Handle.new(:id1 => @id1, :id2 => @id2)
     end
 
+    protected
+
     def build_soap_data
       data = ActiveSupport::OrderedHash.new
 
-      data['Handle'] = handle.to_hash
-      data['Type'] = cash_book_entry_type unless cash_book_entry_type.blank?
+      data['Handle'] = handle.to_hash unless handle.to_hash.empty?
+      data['Id1'] = id1 unless id1.blank?
+      data['Id2'] = id2 unless id2.blank?
+      data['Type'] = type unless type.blank?
       data['CashBookHandle'] = { 'Number' => cash_book_handle[:number] } unless cash_book_handle.blank?
       data['DebtorHandle'] = { 'Number' => debtor_handle[:number] } unless debtor_handle.blank?
       data['CreditorHandle'] = { 'Number' => creditor_handle[:number] } unless creditor_handle.blank?
@@ -98,8 +71,8 @@ module Economic
       data['ProjectHandle'] = { 'Number' => project_handle[:number] } unless project_handle.blank?
       data['CostTypeHandle'] = { 'Number' => cost_type_handle[:number] } unless cost_type_handle.blank?
       data['BankPaymentTypeHandle'] = { 'Number' => bank_payment_type_handle[:number] } unless bank_payment_type_handle.blank?
-      data['BankPaymentCreditorId'] = bank_payment_creditor_id
-      data['BankPaymentCreditorInvoiceId'] = bank_payment_creditor_invoice_id
+      data['BankPaymentCreditorId'] = bank_payment_creditor_id unless bank_payment_creditor_id.blank?
+      data['BankPaymentCreditorInvoiceId'] = bank_payment_creditor_invoice_id unless bank_payment_creditor_invoice_id.blank?
       data['CapitaliseHandle'] = { 'Number' => capitalise_handle[:number] } unless capitalise_handle.blank?
       data['StartDate'] = start_date
       data['EndDate'] = end_date
@@ -107,5 +80,38 @@ module Economic
 
       return data
     end
+
+    def initialize_defaults
+      self.account_handle = nil
+      self.amount = 0
+      self.amount_default_currency = 0
+      self.bank_payment_creditor_id = nil
+      self.bank_payment_creditor_invoice_id = nil
+      self.bank_payment_type_handle = nil
+      self.capitalise_handle = nil
+      self.cash_book_handle = nil
+      self.contra_account_handle = nil
+      self.contra_vat_account_handle = nil
+      self.cost_type_handle = nil
+      self.creditor_handle = nil
+      self.creditor_invoice_number = nil
+      self.currency_handle = nil
+      self.date = Time.now
+      self.debtor_handle = nil
+      self.debtor_invoice_number = nil
+      self.department_handle = nil
+      self.distribution_key_handle = nil
+      self.due_date = nil
+      self.employee_handle = nil
+      self.end_date = nil
+      self.project_handle = nil
+      self.start_date = Time.now
+      self.text = ""
+      self.type = ""
+      self.vat_account_handle = nil
+      self.voucher_number = 0
+    end
+
+
   end
 end

data/lib/economic/creditor.rb

@@ -0,0 +1,67 @@
+require 'economic/entity'
+
+module Economic
+
+  # Represents a creditor in E-conomic.
+  #
+  # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICreditor.html
+  #
+  # Examples
+  #
+  #   # Find a creditor:
+  #   creditor = economic.creditors.find(558)
+  #
+  #   # Creating a creditor:
+  #   creditor = economic.creditors.build
+  #   creditor.number = economic.creditors.next_available_number
+  #   creditor.creditor_group_handle = { :number => 1 }
+  #   creditor.name = 'Apple Inc'
+  #   creditor.vat_zone = 'HomeCountry' # HomeCountry, EU, Abroad
+  #   creditor.is_accessible = true
+  #   creditor.ci_number = '12345678'
+  #   creditor.term_of_payment = 1
+  #   creditor.save
+  class Creditor < Entity
+    has_properties :handle, :number, :creditor_group_handle, :name, :vat_zone, :currency_handle, :term_of_payment_handle, :is_accessible, :ci_number, :email, :address, :postal_code, :city, :country, :bank_account, :attention_handle, :your_reference_handle, :our_reference_handle, :default_payment_type_handle, :default_payment_creditor_id, :county, :auto_contra_account_handle
+
+    def handle
+      Handle.new({:number => @number})
+    end
+
+    # Returns the Creditors contacts
+    def contacts
+      @contacts ||= CreditorContactProxy.new(self)
+    end
+
+    protected
+
+    def build_soap_data
+      data = ActiveSupport::OrderedHash.new
+
+      data['Handle'] = handle.to_hash
+      data['Number'] = handle.number
+      data['CreditorGroupHandle'] = { 'Number' => creditor_group_handle[:number] } unless creditor_group_handle.blank?
+      data['Name'] = name unless name.blank?
+      data['VatZone'] = vat_zone unless vat_zone.blank?
+      data['CurrencyHandle'] = { 'Code' => currency_handle[:code] } unless currency_handle.blank?
+      data['TermOfPaymentHandle'] = { 'Id' => term_of_payment_handle[:id] } unless term_of_payment_handle.blank?
+      data['IsAccessible'] = is_accessible unless is_accessible.blank?
+      data['CINumber'] = ci_number unless ci_number.blank?
+      data['Email'] = email unless email.blank?
+      data['Address'] = address unless address.blank?
+      data['PostalCode'] = postal_code unless postal_code.blank?
+      data['City'] = city unless city.blank?
+      data['Country'] = country unless country.blank?
+      data['BankAccount'] = bank_account unless bank_account.blank?
+      data['AttentionHandle'] = { 'Id' => attention_handle[:id] } unless attention_handle.blank?
+      data['YourReferenceHandle'] = { 'Id' => your_reference_handle[:id] } unless your_reference_handle.blank?
+      data['OurReferenceHandle'] = { 'Number' => our_reference_handle[:number] } unless our_reference_handle.blank?
+      data['DefaultPaymentTypeHandle'] = { 'Number' => default_payment_type_handle[:number] } unless default_payment_type_handle.blank?
+      data['DefaultPaymentCreditorId'] = default_payment_creditor_id unless default_payment_creditor_id.blank?
+      data['County'] = county unless county.blank?
+      data['AutoContraAccountHandle'] = { 'Number' => auto_contra_account_handle[:number] } unless auto_contra_account_handle.blank?
+
+      data
+    end
+  end
+end

data/lib/economic/creditor_contact.rb

@@ -0,0 +1,62 @@
+require 'economic/entity'
+
+module Economic
+
+  # Represents a creditor contact.
+  #
+  # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICreditorContact.html
+  #
+  # Examples
+  #
+  #   # Find contact
+  #   contact = economic.contacts.find(5)
+  #
+  #   # Creating a contact
+  #   contact = creditor.contacts.build
+  #   contact.id = 0
+  #   contact.number = 0
+  #   contact.name = 'John Appleseed'
+  #   contact.save
+  class CreditorContact < Entity
+    has_properties :handle, :id, :creditor_handle, :name, :number, :telephone_number, :email, :comments, :external_id
+
+    def creditor
+      return nil if creditor_handle.blank?
+      @creditor ||= session.creditors.find(creditor_handle[:number])
+    end
+
+    def creditor=(creditor)
+      self.creditor_handle = creditor.handle
+      @creditor = creditor
+    end
+
+    def creditor_handle=(handle)
+      @creditor = nil unless handle == @creditor_handle
+      @creditor_handle = handle
+    end
+
+    def handle
+      Handle.new({:id => @id})
+    end
+
+    protected
+
+    def build_soap_data
+      data = ActiveSupport::OrderedHash.new
+
+      data['Handle'] = handle.to_hash
+      data['Id'] = id unless id.blank?
+      data['CreditorHandle'] = { 'Number' => creditor_handle[:number] } unless creditor_handle.blank?
+      data['Name'] = name unless name.blank?
+      data['Number'] = handle.number
+      data['TelephoneNumber'] = telephone_number unless telephone_number.blank?
+      data['Email'] = email unless email.blank?
+      data['Comments'] = comments unless comments.blank?
+      data['ExternalId'] = external_id unless external_id.blank?
+
+      return data
+    end
+
+  end
+
+end

data/lib/economic/creditor_entry.rb

@@ -0,0 +1,26 @@
+require 'economic/entity'
+
+module Economic
+
+  # Represents a creditor entry in E-conomic.
+  #
+  # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_ICreditorEntry.html
+
+  class CreditorEntry < Entity
+    has_properties :account,
+      :amount,
+      :amount_default_currency,
+      :creditor,
+      :currency,
+      :date,
+      :due_date,
+      :invoice_number,
+      :remainder,
+      :remainder_default_currency,
+      :serial_number,
+      :text,
+      :type,
+      :voucher_number
+  end
+
+end

data/lib/economic/current_invoice.rb

@@ -60,6 +60,23 @@ module Economic
       session.invoices.find(response[:number])
     end
 
+    # Books a current invoice. The given number will be assigned to the
+    # resulting Economic::Invoice.
+    #
+    # Returns the resulting Economic::Invoice object
+    def book_with_number(number)
+      response = session.request soap_action(:book_with_number) do
+        soap.body = {
+          "currentInvoiceHandle" => handle.to_hash,
+          "number" => number,
+          :order! => ["currentInvoiceHandle", "number"]
+        }
+      end
+
+      # Find the created Invoice
+      session.invoices.find(response[:number])
+    end
+
     def debtor
       return nil if debtor_handle.blank?
       @debtor ||= session.debtors.find(debtor_handle)
@@ -84,6 +101,19 @@ module Economic
       @lines ||= CurrentInvoiceLineProxy.new(self)
     end
 
+    def save
+      result = super
+      id = result[:id]
+
+      self.lines.each do |invoice_line|
+        invoice_line.session = session
+        invoice_line.invoice = self
+        invoice_line.save
+      end
+    end
+
+    protected
+
     def initialize_defaults
       self.id = 0
       self.date = Time.now
@@ -133,16 +163,6 @@ module Economic
       return data
     end
 
-    def save
-      result = super
-      id = result[:id]
-
-      self.lines.each do |invoice_line|
-        invoice_line.session = session
-        invoice_line.invoice = self
-        invoice_line.save
-      end
-    end
   end
 
 end

data/lib/economic/current_invoice_line.rb

@@ -30,6 +30,8 @@ module Economic
       @invoice_handle = handle
     end
 
+    protected
+
     def initialize_defaults
       self.invoice_handle = nil
       self.description = nil

data/lib/economic/debtor_entry.rb

@@ -0,0 +1,27 @@
+require 'economic/entity'
+
+module Economic
+
+  # Represents a debtor entry in E-conomic.
+  #
+  # API documentation: http://www.e-conomic.com/apidocs/Documentation/T_Economic_Api_IDebtorEntry.html
+
+  class DebtorEntry < Entity
+    has_properties :handle,
+      :serial_number,
+      :type,
+      :date,
+      :debtor_handle,
+      :account_handle,
+      :voucher_number,
+      :text,
+      :amount_default_currency,
+      :currency_handle,
+      :amount,
+      :invoice_number,
+      :due_date,
+      :remainder,
+      :remainder_default_currency
+  end
+
+end