twinfieldrb 0.3.0

data/lib/twinfield/sales_invoice.rb

@@ -0,0 +1,409 @@
+module Twinfield
+  class SalesInvoice < Twinfield::AbstractModel
+    extend Twinfield::Helpers::Parsers
+
+    class Financials
+      attr_accessor :code, :number
+
+      def initialize(code:, number:)
+        @code = code
+        @number = number
+      end
+
+      def to_h
+        {
+          code: code,
+          number: number
+        }
+      end
+    end
+
+    class VatLine
+      attr_accessor :vatcode, :vatvalue, :performancetype, :performancedate, :vatname, :invoice
+
+      def initialize(vatcode:, vatvalue:, performancetype:, performancedate:, vatname:)
+        @vatcode = vatcode
+        @vatvalue = vatvalue
+        @performancetype = performancetype
+        @performancedate = performancedate
+        @vatname = vatname
+      end
+
+      def to_h
+        {
+          vatcode: vatcode,
+          vatvalue: vatvalue,
+          performancetype: performancetype,
+          performancedate: performancedate,
+          vatname: vatname
+        }
+      end
+    end
+
+    class Line < Twinfield::AbstractModel
+      attr_accessor :id, :article, :subarticle, :quantity, :units, :allowdiscountorpremium, :description, :unitspriceexcl, :unitspriceinc, :freetext1, :freetext2, :freetext3, :dim1, :vatcode, :performancetype, :performancedate, :valueexcl, :vatvalue, :valueinc, :invoice
+
+      def initialize(id: nil, article: "-", subarticle: nil, quantity: 1, units: nil, allowdiscountorpremium: true, description: nil, unitspriceexcl: nil, unitspriceinc: nil, freetext1: nil, freetext2: nil, freetext3: nil, dim1: nil, vatcode: nil, performancetype: nil, performancedate: nil, valueinc: nil, vatvalue: nil, valueexcl: nil)
+        @id = id
+        @article = article # article "-" is an article-less article in Twinfield
+        @subarticle = subarticle if subarticle.to_s != ""
+        @quantity = Float(quantity) unless article == "-"
+        @units = Integer(units) if units && units != ""
+        @allowdiscountorpremium = allowdiscountorpremium unless article == "-"
+        @description = description
+        @unitspriceexcl = Float(unitspriceexcl) if unitspriceexcl
+        @unitspriceinc = Float(unitspriceinc) if unitspriceinc
+        @freetext1 = freetext1 if freetext1.to_s != ""
+        @freetext2 = freetext2 if freetext2.to_s != ""
+        @freetext3 = freetext3 if freetext3.to_s != ""
+        @dim1 = dim1 if dim1.to_s != ""
+        @vatcode = vatcode if vatcode.to_s != ""
+        @performancetype = performancetype if performancetype.to_s != ""
+        @performancedate = performancedate if performancedate.to_s != ""
+        @valueinc = valueinc
+        @vatvalue = vatvalue
+        @valueexcl = valueexcl
+      end
+
+      def to_xml(lineid = id)
+        Nokogiri::XML::Builder.new do |xml|
+          xml.line(id: lineid) {
+            xml.article article
+            xml.subarticle subarticle if subarticle
+            xml.quantity quantity if quantity
+            xml.units units if units
+            xml.allowdiscountorpremium allowdiscountorpremium if allowdiscountorpremium
+            xml.description description if description
+            xml.unitspriceexcl unitspriceexcl if unitspriceexcl
+            xml.unitspriceinc unitspriceinc if unitspriceinc
+            xml.freetext1 freetext1 if freetext1
+            xml.freetext2 freetext2 if freetext2
+            xml.freetext3 freetext3 if freetext3
+            xml.dim1 dim1 if dim1
+            xml.vatcode vatcode if vatcode
+            xml.performancetype performancetype if performancetype
+            xml.performancedate performancedate.strftime("%Y%m%d") if performancedate
+          }
+        end.doc.root.to_xml
+      end
+
+      def to_h
+        {
+          id: id,
+          article: article,
+          subarticle: subarticle,
+          quantity: quantity,
+          units: units,
+          allowdiscountorpremium: allowdiscountorpremium,
+          description: description,
+          unitspriceexcl: unitspriceexcl,
+          unitspriceinc: unitspriceinc,
+          freetext1: freetext1,
+          freetext2: freetext2,
+          freetext3: freetext3,
+          dim1: dim1,
+          vatcode: vatcode,
+          performancetype: performancetype,
+          performancedate: performancedate,
+          valueexcl: valueexcl,
+          valueinc: valueinc,
+          vatvalue: vatvalue
+        }
+      end
+    end
+
+    class << self
+      def find(invoicenumber, invoicetype:)
+        options = {office: Twinfield.configuration.company, code: invoicetype, invoicenumber: invoicenumber}
+
+        invoice_xml = Twinfield::Api::Process.read(:salesinvoice, options)
+
+        invoice = Twinfield::SalesInvoice.new(
+          office: invoice_xml.css("header office").text,
+          invoicetype: invoice_xml.css("header invoicetype").text,
+          invoicedate: parse_date(invoice_xml.css("header invoicedate").text),
+          duedate: parse_date(invoice_xml.css("header duedate").text),
+          bank: invoice_xml.css("header bank").text,
+          deliveraddressnumber: invoice_xml.css("header deliveraddressnumber").text&.to_i,
+          invoiceaddressnumber: invoice_xml.css("header invoiceaddressnumber").text&.to_i,
+          customer: invoice_xml.css("header customer").text,
+          period: invoice_xml.css("header period").text,
+          currency: invoice_xml.css("header currency").text,
+          status: invoice_xml.css("header status").text,
+          paymentmethod: invoice_xml.css("header paymentmethod").text,
+          headertext: invoice_xml.css("header headertext").text,
+          footertext: invoice_xml.css("header footertext").text
+        )
+
+        invoice.invoicenumber = invoice_xml.css("header invoicenumber").text
+
+        return nil if invoice.invoicenumber.strip != invoicenumber.to_s
+
+        invoice.financials = Financials.new(code: invoice_xml.css("financials code").text, number: invoice_xml.css("financials number").text)
+
+        invoice_xml.css("lines line").each do |xml_line|
+          line = Line.new(
+            id: xml_line.attributes["id"].text,
+            article: xml_line.css("article").text,
+            subarticle: xml_line.css("subarticle").text,
+            quantity: parse_float(xml_line.css("quantity").text),
+            units: xml_line.css("units").text,
+            allowdiscountorpremium: xml_line.css("allowdiscountorpremium").text,
+            description: xml_line.css("description").text,
+            unitspriceexcl: parse_float(xml_line.css("unitspriceexcl").text),
+            freetext1: xml_line.css("freetext1").text,
+            freetext2: xml_line.css("freetext2").text,
+            freetext3: xml_line.css("freetext3").text,
+            dim1: xml_line.css("dim1").text,
+            vatcode: xml_line.css("vatcode").text
+          )
+          line.valueexcl = (xml_line.css("valueexcl").text == "") ? nil : xml_line.css("valueexcl").text.to_f
+          line.vatvalue = (xml_line.css("vatvalue").text == "") ? nil : xml_line.css("vatvalue").text.to_f
+          line.valueinc = (xml_line.css("valueinc").text == "") ? nil : xml_line.css("valueinc").text.to_f
+          invoice.lines << line
+        end
+
+        invoice_xml.css("vatlines vatline").each do |xml_line|
+          line = VatLine.new(
+            vatcode: xml_line.css("vatcode").text,
+            vatname: xml_line.css("vatcode")[0].attributes["name"].text,
+            vatvalue: parse_float(xml_line.css("vatvalue").text),
+            performancetype: xml_line.css("performancetype").text,
+            performancedate: xml_line.css("performancedate").text
+          )
+
+          invoice.vat_lines << line
+        end
+
+        invoice
+      end
+
+      def search(options = {})
+        Twinfield::Api::Process.request(:process_xml_string) do
+          %(
+            <columns code="000">
+             <sort>
+                <field>fin.trs.head.code</field>
+             </sort>
+             <column>
+                <field>fin.trs.head.yearperiod</field>
+                <label>Period</label>
+                <visible>true</visible>
+                <ask>true</ask>
+                <operator>between</operator>
+                <from>2021/01</from>
+                <to>2021/12</to>
+             </column>
+             <column>
+                <field>fin.trs.head.code</field>
+                <label>Transaction type</label>
+                <visible>true</visible>
+             </column>
+             <column>
+                <field>fin.trs.head.shortname</field>
+                <label>Name</label>
+                <visible>true</visible>
+             </column>
+             <column>
+                <field>fin.trs.head.number</field>
+                <label>Trans. no.</label>
+                <visible>true</visible>
+             </column>
+             <column>
+                <field>fin.trs.line.dim1</field>
+                <label>General ledger</label>
+                <visible>true</visible>
+                <ask>true</ask>
+                <operator>between</operator>
+                <from>1300</from>
+                <to>1300</to>
+             </column>
+             <column>
+                <field>fin.trs.head.curcode</field>
+                <label>Currency</label>
+                <visible>true</visible>
+             </column>
+             <column>
+                <field>fin.trs.line.valuesigned</field>
+                <label>Value</label>
+                <visible>true</visible>
+             </column>
+             <column>
+                <field>fin.trs.line.description</field>
+                <label>Description</label>
+                <visible>true</visible>
+             </column>
+
+           </columns>
+          )
+          # <column>
+          #   <field>fin.trs.line.dim2</field>
+          #   <label>Debtor</label><visible>true</visible><from>#{code}</from><to>#{code}</to><operator>between</operator>
+          # </column>
+        end
+      end
+    end
+
+    attr_accessor :invoicetype, :invoicedate, :duedate, :performancedate, :bank, :invoiceaddressnumber, :deliveraddressnumber, :customer_code, :period, :currency, :status, :paymentmethod, :headertext, :footertext, :lines, :office, :invoicenumber, :vatvalue, :valueinc, :financials, :vat_lines
+
+    def initialize(invoicetype:, duedate: nil, invoicedate: nil, performancedate: nil, bank: nil, invoiceaddressnumber: nil, deliveraddressnumber: nil, customer: nil, customer_code: nil, period: nil, currency: nil, status: "concept", paymentmethod: nil, headertext: nil, footertext: nil, office: nil, invoicenumber: nil, financials: {}, lines: [], vat_lines: [])
+      self.lines = lines.collect { |a| SalesInvoice::Line.new(**a.to_h) }
+      self.vat_lines = vat_lines.collect { |a| SalesInvoice::VatLine.new(**a.to_h) }
+      self.financials = SalesInvoice::Financials.new(**financials.to_h) if financials && financials != {}
+      @invoicetype = invoicetype
+      @invoicedate = invoicedate.is_a?(String) ? Date.parse(invoicedate) : invoicedate
+      @duedate = duedate.is_a?(String) ? Date.parse(duedate) : duedate
+      @performancedate = performancedate.is_a?(String) ? Date.parse(performancedate) : performancedate
+      @bank = bank
+      @invoiceaddressnumber = invoiceaddressnumber
+      @deliveraddressnumber = deliveraddressnumber
+      self.customer = customer || customer_code
+      raise ArgumentError.new("missing keyword: :customer or :customer_code") unless self.customer_code
+      @period = period
+      @currency = currency
+      @status = status
+      @paymentmethod = paymentmethod
+      @headertext = headertext
+      @footertext = footertext
+      @office = office || Twinfield.configuration.company
+      @invoicenumber = invoicenumber
+    end
+
+    def associated_lines
+      lines.map { |a|
+        a.invoice = self
+        a
+      }
+    end
+
+    def raisewarning
+      @raisewarning || false
+    end
+
+    def autobalancevat
+      @autobalancevat || true
+    end
+
+    def generate_lines
+      line_id = 0
+      lines.map do |line|
+        line_id += 1
+        line.to_xml(line_id)
+      end
+    end
+
+    def final?
+      ["final", :final].include? status
+    end
+
+    def customer= customer
+      if customer.is_a?(String) || customer.is_a?(Numeric)
+        @customer_code = customer.to_i
+      elsif customer.is_a? Twinfield::Customer
+        @customer_code = customer.code
+        @customer = customer
+      end
+    end
+
+    def customer
+      @customer ||= Twinfield::Customer.find(customer_code)
+    end
+
+    def deliver_address
+      customer.addresses[deliveraddressnumber - 1] if deliveraddressnumber
+    end
+
+    def invoice_address
+      customer.addresses[invoiceaddressnumber - 1] if invoiceaddressnumber
+    end
+
+    def transaction
+      @transaction ||= financials&.number ? Twinfield::Browse::Transaction::Customer.find(number: financials.number, code: financials.code) : nil
+    end
+
+    # helper method to calculate a total price
+    def totalinc
+      lines.map(&:valueinc).compact.sum
+    end
+
+    alias_method :total, :totalinc
+
+    # helper method to calculate a total excl price
+    def totalexcl
+      lines.map(&:valueexcl).compact.sum
+    end
+
+    def to_xml
+      Nokogiri::XML::Builder.new do |xml|
+        xml.salesinvoice(raisewarning: raisewarning, autobalancevat: autobalancevat) {
+          xml.header do
+            xml.office office
+            xml.invoicenumber invoicenumber if invoicenumber
+            xml.invoicetype invoicetype
+            xml.invoicedate invoicedate&.strftime("%Y%m%d")
+            xml.duedate duedate&.strftime("%Y%m%d")
+            xml.performancedate performancedate.strftime("%Y%m%d") if performancedate
+            xml.bank bank
+            xml.invoiceaddressnumber invoiceaddressnumber if invoiceaddressnumber
+            xml.deliveraddressnumber deliveraddressnumber if deliveraddressnumber
+            xml.customer customer_code
+            xml.period period if period
+            xml.currency currency
+            xml.status status
+            xml.paymentmethod paymentmethod
+            xml.headertext headertext
+            xml.footertext footertext
+          end
+          xml.lines do
+            generate_lines.each do |line|
+              xml << line
+            end
+          end
+        }
+      end.doc.root.to_xml
+    end
+
+    def to_h
+      {
+        lines: lines.collect(&:to_h),
+        vat_lines: vat_lines.collect(&:to_h),
+        financials: financials&.to_h,
+        invoicetype: invoicetype,
+        invoicedate: invoicedate,
+        duedate: duedate,
+        performancedate: performancedate,
+        bank: bank,
+        invoiceaddressnumber: invoiceaddressnumber,
+        deliveraddressnumber: deliveraddressnumber,
+        customer_code: customer_code,
+        period: period,
+        currency: currency,
+        status: status,
+        paymentmethod: paymentmethod,
+        headertext: headertext,
+        footertext: footertext,
+        office: office || Twinfield.configuration.company,
+        invoicenumber: invoicenumber
+      }
+    end
+
+    def save
+      response = Twinfield::Api::Process.request do
+        to_xml
+      end
+
+      xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+      if xml.at_css("salesinvoice").attributes["result"].value == "1"
+        self.invoicenumber = xml.at_css("invoicenumber").content
+        self
+      elsif xml.css("header status").text == "final"
+        raise Twinfield::Create::Finalized.new(xml.css("[msg]").map { |x| x.attributes["msg"].value }.join(" "), object: self)
+      elsif lines.count == 0
+        raise Twinfield::Create::EmptyInvoice.new(xml.css("[msg]").map { |x| x.attributes["msg"].value }.join(" "), object: self)
+      else
+        raise Twinfield::Create::Error.new(xml.css("[msg]").map { |x| x.attributes["msg"].value }.join(" "), object: self)
+      end
+    end
+  end
+end

data/lib/twinfield/transaction.rb

@@ -0,0 +1,112 @@
+module Twinfield
+  class Transaction < Twinfield::AbstractModel
+    extend Twinfield::Helpers::Parsers
+    include Twinfield::Helpers::TransactionMatch
+
+    class Line
+      attr_accessor :dim1, :dim2, :value, :debitcredit, :description, :invoicenumber, :vatcode, :type
+
+      def initialize(dim1: nil, dim2: nil, value: nil, debitcredit: nil, description: nil, invoicenumber: nil, vatcode: nil, customer_code: nil, balance_code: nil, type: :detail)
+        self.dim1 = dim1 || balance_code
+        self.dim2 = dim2 || customer_code
+        self.value = value.to_f
+        self.debitcredit = debitcredit
+        self.description = description
+        self.invoicenumber = invoicenumber
+        self.vatcode = vatcode
+        self.type = type.to_sym
+      end
+
+      def balance_code
+        dim1
+      end
+
+      def customer_code
+        dim2
+      end
+
+      def to_xml
+        Nokogiri::XML::Builder.new do |xml|
+          xml.line(type: type) {
+            xml.dim1 dim1 if dim1
+            xml.dim2 dim2 if dim2
+            xml.value value if value
+            xml.description description if description && type != :total
+            xml.debitcredit debitcredit if debitcredit
+            xml.invoicenumber invoicenumber if invoicenumber
+            xml.vatcode vatcode if vatcode
+            xml.currencydate Date.today.strftime("%Y%m%d")
+          }
+        end.doc.root.to_xml
+      end
+
+      def detail?
+        type == :detail
+      end
+
+      def total?
+        type == :total
+      end
+
+      def credit?
+        debitcredit == :credit
+      end
+    end
+
+    attr_accessor :office, :code, :currency, :date, :period, :lines, :destiny, :number
+
+    def initialize(code:, office: nil, currency: "EUR", date: Date.today, period: nil, destiny: :final, lines: [], number: nil)
+      self.office = office || Twinfield.configuration.company
+      self.code = code
+      self.currency = currency
+      self.date = date
+      self.period = period || "#{date.year}/#{"%02d" % date.month}"
+      self.lines = lines.collect { |a| a.is_a?(Line) ? a : Line.new(**a) }
+      self.destiny = destiny
+      self.number = number
+    end
+
+    def value
+      0.0 - lines.select { |l| l.credit? && l.detail? }.map(&:value).sum
+    end
+
+    def save
+      response = Twinfield::Api::Process.request do
+        to_xml
+      end
+
+      xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+      if xml.at_css("transaction").attributes["result"].value == "1"
+        self.number = xml.at_css("header number").content
+        self
+      else
+        raise Twinfield::Create::Error.new(xml.css("[msg]").map { |x| x.attributes["msg"].value }.join(" "), object: self)
+      end
+    end
+
+    def to_xml
+      Nokogiri::XML::Builder.new do |xml|
+        xml.transaction(destiny: "final") do
+          xml.header do
+            xml.office office
+            xml.code code
+            xml.number number if number
+            xml.currency currency
+            xml.date date.strftime("%Y%m%d")
+            xml.period period
+          end
+          xml.lines do
+            lines.select(&:total?).each do |line|
+              xml << line.to_xml
+            end
+
+            lines.select(&:detail?).each do |line|
+              xml << line.to_xml
+            end
+          end
+        end
+      end.doc.root.to_xml
+    end
+  end
+end

data/lib/twinfield/version.rb

@@ -0,0 +1,5 @@
+module Twinfield
+  module Version
+    VERSION = "0.3.0"
+  end
+end

data/lib/twinfield.rb

@@ -0,0 +1,89 @@
+require "savon"
+
+module Twinfield
+  WSDLS = {
+    :session => File.join(__dir__, "..", "wsdls", "session.wsdl"),
+    "accounting" => {
+      session: File.join(__dir__, "..", "wsdls", "session.wsdl"),
+      process: File.join(__dir__, "..", "wsdls", "accounting", "process.wsdl"),
+      finder: File.join(__dir__, "..", "wsdls", "accounting", "finder.wsdl")
+    },
+    "accounting2" => {
+      process: File.join(__dir__, "..", "wsdls", "accounting2", "process.wsdl"),
+      finder: File.join(__dir__, "..", "wsdls", "accounting2", "finder.wsdl")
+    },
+    "api.accounting" => {
+      process: File.join(__dir__, "..", "wsdls", "api.accounting", "process.wsdl"),
+      finder: File.join(__dir__, "..", "wsdls", "api.accounting", "finder.wsdl")
+    }
+
+  }
+
+  ERRORS = {
+    100 => "Unexpected exception.",
+    101 => "Session header is missing.",
+    102 => "Access is denied.",
+    103 => "The log-on credentials are not valid anymore.",
+    104 => "The log-on has been deleted.",
+    105 => "The log-on has been disabled.",
+    106 => "The organisation is no longer active.",
+    107 => "SMS failed to send.",
+    108 => "Access to this server is not allowed because the cluster is invalid.",
+    109 => "You need access to at least one company to log on.",
+    110 => "Login is not allowed on this server"
+  }
+
+  class << self
+    # Holds the configuration for easy access to settings
+    attr_accessor :configuration
+
+    # Configures gem options
+    def configure
+      self.configuration ||= Twinfield::Configuration.new
+      reset_sessions!
+      yield(configuration)
+    end
+
+    def reset_sessions!
+      Twinfield::Api::Process.session = nil
+      Twinfield::Api::Finder.session = nil
+    end
+  end
+end
+
+# Helpers
+require "twinfield/helpers/parsers"
+require "twinfield/helpers/transaction_match"
+
+require "twinfield/configuration"
+require "twinfield/abstract_model"
+require "twinfield/version"
+
+# API Helpers
+require "twinfield/api/base_api"
+
+require "twinfield/api/o_auth_session"
+require "twinfield/api/session"
+require "twinfield/api/process"
+require "twinfield/api/finder"
+
+# New style models
+require "twinfield/browse/transaction/customer"
+require "twinfield/browse/transaction/cost_center"
+require "twinfield/browse/transaction/general_ledger"
+require "twinfield/sales_invoice"
+require "twinfield/transaction"
+require "twinfield/customer"
+
+# Create services (old style)
+require "twinfield/create/cost_center"
+require "twinfield/create/general_ledger"
+require "twinfield/create/debtor"
+require "twinfield/create/creditor"
+require "twinfield/create/error"
+require "twinfield/create/transaction"
+
+# Requests services (old style)
+require "twinfield/request/find"
+require "twinfield/request/list"
+require "twinfield/request/read"

data/script/boot.rb

@@ -0,0 +1,58 @@
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "rubygems"
+require "twinfield"
+require File.expand_path("../config", __FILE__)
+#
+# @session = Twinfield::Api::Session.new
+# @session.logon
+#
+# @process = Twinfield::Api::Process.new(@session.session_id, @session.cluster)
+#
+# Twinfield::Request::List.browsefields
+#
+# @dimensions = Twinfield::Request::List.dimensions( { dimtype: "DEB", office: Twinfield.configuration.company } )
+#
+@invoice = Twinfield::SalesInvoice.new
+
+# Mandatory parameters:
+@invoice.code = "VRK"
+@invoice.currency = "EUR"
+@invoice.date = DateTime.now
+@invoice.duedate = DateTime.now + 30
+@invoice.invoicenumber = 110021
+
+# Obligatory parameters:
+@invoice.number = 201500016
+@invoice.destiny = "final"
+@invoice.raisewarning = false
+@invoice.autobalancevat = true
+
+@invoice.lines = [
+  {
+    type: "total",
+    id: 1,
+    dim1: 1300,
+    dim2: "D10000881",
+    value: 1000000,
+    debitcredit: "debit",
+    description: "Totaal regel"
+  },
+  {
+    # Mandatory parameters:
+    type: "detail",
+    id: 2,
+    dim1: 8000,
+    dim2: "A0000",
+    dim3: "M0000",
+    value: 1000000,
+    debitcredit: "credit",
+    description: "Rekening betaald",
+
+    # Obligatory parameters:
+    vatvalue: "0",
+    vatcode: "VL"
+  }
+]
+# @result = @invoice.save
+# puts @result

data/script/console

@@ -0,0 +1,2 @@
+#!/usr/bin/env ruby
+system "irb -r ./script/boot.rb"