twinfieldrb 0.3.0

data/lib/twinfield/browse/transaction/cost_center.rb

@@ -0,0 +1,145 @@
+module Twinfield
+  module Browse
+    module Transaction
+      class CostCenter < Twinfield::AbstractModel
+        extend Twinfield::Helpers::Parsers
+        include Twinfield::Helpers::TransactionMatch
+
+        attr_accessor :number, :yearperiod, :currency, :value, :status, :dim1, :dim2, :key, :code
+
+        class << self
+          def initialize_from_columns_response_row(transaction_xml)
+            new(
+              number: transaction_xml.css("td[field='fin.trs.head.number']").text,
+              yearperiod: transaction_xml.css("td[field='fin.trs.head.yearperiod']").text,
+              currency: transaction_xml.css("td[field='fin.trs.head.curcode']").text,
+              value: transaction_xml.css("td[field='fin.trs.line.valuesigned']").text&.to_f,
+              status: transaction_xml.css("td[field='fin.trs.head.status']").text,
+              dim1: transaction_xml.css("td[field='fin.trs.line.dim1']").text,
+              dim2: transaction_xml.css("td[field='fin.trs.line.dim2']").text,
+              key: transaction_xml.css("key").text.gsub(/\s/, ""),
+              code: transaction_xml.css("td[field='fin.trs.head.code']").text
+            )
+          end
+
+          def find(customer_code: nil, invoice_number: nil, code: nil, number: nil)
+            where(customer_code: customer_code, invoice_number: invoice_number, code: code, number: number).first
+          end
+
+          # @param years: range
+          #
+          def where(years: ((Date.today.year - 30)..Date.today.year), dim1: nil, dim2: nil)
+            build_request = %(
+              <column>
+                  <field>fin.trs.head.yearperiod</field>
+                  <label>Periode</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from>#{years.first}/01</from>
+                  <to>#{years.last}/12</to>
+                  <finderparam/>
+              </column>
+              <column>
+                  <field>fin.trs.line.dim1</field>
+                  <label>Grootboek</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from>#{dim1}</from>
+                  <to>#{dim1}</to>
+                  <finderparam/>
+              </column>
+              <column>
+                  <field>fin.trs.line.dim2</field>
+                  <label>Kostenplaats</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from>#{dim2}</from>
+                  <to>#{dim2}</to>
+                  <finderparam>dimtype=KPL</finderparam>
+                </column>
+                <column>
+                  <field>fin.trs.head.code</field>
+                  <label>Dagboek</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>equal</operator>
+                  <from/>
+                  <to/>
+                  <finderparam>hidden=1</finderparam>
+                </column>
+                <column>
+                  <field>fin.trs.head.number</field>
+                  <label>Boekst.nr.</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from/>
+                  <to/>
+                  <finderparam/>
+                </column>
+                <column>
+                  <field>fin.trs.head.curcode</field>
+                  <label>Valuta</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>none</operator>
+                  <from/>
+                  <to/>
+                  <finderparam/>
+                </column>
+                <column>
+                  <field>fin.trs.line.valuesigned</field>
+                  <label>Bedrag</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from/>
+                  <to/>
+                  <finderparam/>
+                </column>
+                <column>
+                  <field>fin.trs.head.status</field>
+                  <label>Status</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>equal</operator>
+                  <from>normal</from>
+                  <to/>
+                  <finderparam/>
+                </column>
+                )
+
+            response = Twinfield::Api::Process.request(:process_xml_string) do
+              %(
+                <columns code="900">
+                  #{build_request}
+                </columns>
+              )
+            end
+
+            xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+            xml.css("tr").map do |transaction_xml|
+              Twinfield::Browse::Transaction::CostCenter.initialize_from_columns_response_row(transaction_xml)
+            end
+          end
+        end
+
+        def initialize(number: nil, yearperiod: nil, currency: "EUR", value: nil, status: nil, dim1: nil, dim2: nil, key: nil, code: nil)
+          self.number = number
+          self.yearperiod = yearperiod
+          self.currency = currency
+          self.value = value
+          self.status = status
+          self.dim1 = dim1
+          self.dim2 = dim2
+          self.key = key
+          self.code = code
+        end
+      end
+    end
+  end
+end

data/lib/twinfield/browse/transaction/customer.rb

@@ -0,0 +1,413 @@
+# These models are the result of a browse response; and sadly do not map 1 on 1 on a e.g. Transaction; and reconstruction isn't possible with just the results from the browse response.
+
+module Twinfield
+  module Browse
+    module Transaction
+      class Customer < Twinfield::AbstractModel
+        extend Twinfield::Helpers::Parsers
+        include Twinfield::Helpers::TransactionMatch
+
+        attr_accessor :invoice_number, :customer_code, :key, :currency, :value, :open_value, :available_for_payruns, :status, :number, :date, :code
+
+        class << self
+          def initialize_from_columns_response_row(transaction_xml)
+            # "<tr>
+            #    <td field=\"fin.trs.head.number\" hideforuser=\"false\" type=\"Decimal\">202000011</td>
+            #    <td field=\"fin.trs.line.invnumber\" hideforuser=\"false\" type=\"String\">20200198</td>
+            #    <td field=\"fin.trs.head.curcode\" hideforuser=\"false\" type=\"String\">EUR</td>
+            #    <td field=\"fin.trs.line.valuesigned\" hideforuser=\"false\" type=\"Value\">2200.00</td>
+            #    <td field=\"fin.trs.line.openvaluesigned\" hideforuser=\"false\" type=\"Value\">2200.00</td>
+            #    <td field=\"fin.trs.line.availableforpayruns\" hideforuser=\"false\" type=\"String\" name=\"Ja\">true</td>
+            #    <td field=\"fin.trs.line.matchstatus\" hideforuser=\"false\" type=\"String\" name=\"Beschikbaar\">available</td>
+            #    <td field=\"fin.trs.line.dim2\" hideforuser=\"false\" type=\"String\">1003</td>
+            #    <key> <office>NLA002058</office> <code>VRK</code> <number>202000011</number> <line>1</line> </key>
+            # </tr>"
+            # p
+            new(
+              number: transaction_xml.css("td[field='fin.trs.head.number']").text,
+              invoice_number: transaction_xml.css("td[field='fin.trs.line.invnumber']").text,
+              currency: transaction_xml.css("td[field='fin.trs.head.curcode']").text,
+              value: transaction_xml.css("td[field='fin.trs.line.valuesigned']").text&.to_f,
+              open_value: transaction_xml.css("td[field='fin.trs.line.openvaluesigned']").text&.to_f,
+              available_for_payruns: transaction_xml.css("td[field='fin.trs.line.availableforpayruns']").text&.to_f,
+              status: transaction_xml.css("td[field='fin.trs.line.matchstatus']").text,
+              customer_code: transaction_xml.css("td[field='fin.trs.line.dim2']").text,
+              key: transaction_xml.css("key").text.gsub(/\s/, ""),
+              date: parse_date(transaction_xml.css("td[field='fin.trs.head.date']").text),
+              code: transaction_xml.css("td[field='fin.trs.head.code']").text
+            )
+          end
+
+          def find(customer_code: nil, invoice_number: nil, code: nil, number: nil)
+            where(customer_code: customer_code, invoice_number: invoice_number, code: code, number: number).first
+          end
+
+          def where(customer_code: nil, invoice_number: nil, code: nil, number: nil, years: ((Date.today.year - 30)..Date.today.year))
+            # <?xml version="1.0"?>
+            # <browse result="1">
+            #   <office name="Heden" shortname="">NLA002058</office>
+            #   <code>100</code>
+            #   <name>Debiteurenkaart</name>
+            #   <shortname>Debiteurenkaart</shortname>
+            #   <visible>true</visible>
+            #   <columns code="100">
+            #     <column id="2">
+            #       <field>fin.trs.head.code</field>
+            #       <label>Dagboek</label>
+            #       <visible>true</visible>
+            #       <ask>true</ask>
+            #       <operator>equal</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam>hidden=1</finderparam>
+            #     </column>
+            #     <column id="3">
+            #       <field>fin.trs.head.shortname</field>
+            #       <label>Naam</label>
+            #       <visible>true</visible>
+            #       <ask>false</ask>
+            #       <operator>none</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="4">
+            #       <field>fin.trs.head.number</field>
+            #       <label>Boekst.nr.</label>
+            #       <visible>true</visible>
+            #       <ask>true</ask>
+            #       <operator>between</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="5">
+            #       <field>fin.trs.head.status</field>
+            #       <label>Status</label>
+            #       <visible>true</visible>
+            #       <ask>true</ask>
+            #       <operator>equal</operator>
+            #       <from>normal</from>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="6">
+            #       <field>fin.trs.head.date</field>
+            #       <label>Boekdatum</label>
+            #       <visible>true</visible>
+            #       <ask>false</ask>
+            #       <operator>none</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="7">
+            #       <field>fin.trs.line.dim2</field>
+            #       <label>Debiteur</label>
+            #       <visible>true</visible>
+            #       <ask>true</ask>
+            #       <operator>between</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam>dimtype=DEB</finderparam>
+            #     </column>
+            #     <column id="8">
+            #       <field>fin.trs.line.dim2name</field>
+            #       <label>Naam</label>
+            #       <visible>true</visible>
+            #       <ask>false</ask>
+            #       <operator>none</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="9">
+            #       <field>fin.trs.head.curcode</field>
+            #       <label>Valuta</label>
+            #       <visible>false</visible>
+            #       <ask>false</ask>
+            #       <operator>equal</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="10">
+            #       <field>fin.trs.line.valuesigned</field>
+            #       <label>Bedrag</label>
+            #       <visible>false</visible>
+            #       <ask>false</ask>
+            #       <operator>between</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="11">
+            #       <field>fin.trs.line.basevaluesigned</field>
+            #       <label>Euro</label>
+            #       <visible>true</visible>
+            #       <ask>true</ask>
+            #       <operator>between</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="12">
+            #       <field>fin.trs.line.repvaluesigned</field>
+            #       <label/>
+            #       <visible>false</visible>
+            #       <ask>false</ask>
+            #       <operator>between</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="13">
+            #       <field>fin.trs.line.openbasevaluesigned</field>
+            #       <label>Openstaand bedrag</label>
+            #       <visible>true</visible>
+            #       <ask>false</ask>
+            #       <operator>none</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="14">
+            #       <field>fin.trs.line.invnumber</field>
+            #       <label>Factuurnr.</label>
+            #       <visible>true</visible>
+            #       <ask>true</ask>
+            #       <operator>equal</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="15">
+            #       <field>fin.trs.line.datedue</field>
+            #       <label>Vervaldatum</label>
+            #       <visible>true</visible>
+            #       <ask>false</ask>
+            #       <operator>none</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="16">
+            #       <field>fin.trs.line.matchstatus</field>
+            #       <label>Betaalstatus</label>
+            #       <visible>true</visible>
+            #       <ask>true</ask>
+            #       <operator>equal</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="17">
+            #       <field>fin.trs.line.matchnumber</field>
+            #       <label>Betaalnr.</label>
+            #       <visible>true</visible>
+            #       <ask>false</ask>
+            #       <operator>none</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="18">
+            #       <field>fin.trs.line.matchdate</field>
+            #       <label>Betaaldatum</label>
+            #       <visible>true</visible>
+            #       <ask>true</ask>
+            #       <operator>between</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="19">
+            #       <field>fin.trs.line.openvaluesigned</field>
+            #       <label>Openstaand bedrag transactievaluta</label>
+            #       <visible>false</visible>
+            #       <ask>false</ask>
+            #       <operator>none</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="20">
+            #       <field>fin.trs.line.availableforpayruns</field>
+            #       <label>Beschikbaar voor betaalrun</label>
+            #       <visible>false</visible>
+            #       <ask>false</ask>
+            #       <operator>none</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #     <column id="21">
+            #       <field>fin.trs.line.modified</field>
+            #       <label>Wijzigingsdatum</label>
+            #       <visible>true</visible>
+            #       <ask>true</ask>
+            #       <operator>between</operator>
+            #       <from/>
+            #       <to/>
+            #       <finderparam/>
+            #     </column>
+            #   </columns>
+            # </browse>
+
+            build_request = %(
+              <sort>
+                 <field>fin.trs.head.code</field>
+              </sort>
+              <column>
+                  <field>fin.trs.head.yearperiod</field>
+                  <label>Periode</label>
+                  <visible>true</visible>
+                  <ask>false</ask>
+                  <operator>between</operator>
+                  <from>#{years.first}/01</from>
+                  <to>#{years.last}/12</to>
+                  <finderparam/>
+              </column>
+              <column>
+                <field>fin.trs.head.shortname</field>
+                <label>Naam</label>
+                <visible>true</visible>
+              </column>
+              <column>
+                <field>fin.trs.head.date</field>
+                <label>Boekdatum</label>
+                <visible>true</visible>
+              </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.openvaluesigned</field>
+                 <label>open_value</label>
+                 <visible>true</visible>
+              </column>
+              <column>
+                <field>fin.trs.line.availableforpayruns</field>
+                <label>available_for_payruns</label>
+                <visible>true</visible>
+              </column>
+              <column>
+                <field>fin.trs.line.matchstatus</field>
+                <label>status</label>
+                <visible>true</visible>
+              </column>
+              <column>
+                <field>fin.trs.line.dim2</field>
+                <label>customer_code</label>
+                <visible>true</visible>
+                <from>#{customer_code}</from>
+                <to>#{customer_code}</to>
+                <operator>between</operator>
+              </column>
+            )
+
+            build_request += if code
+              "<column>
+                  <field>fin.trs.head.code</field>
+                  <label>Code</label>
+                  <visible>true</visible>
+                  <ask>true</ask>
+                  <operator>equal</operator>
+                  <from>#{code}</from>
+                  <to>#{code}</to>
+
+                  <finderparam>#{code}</finderparam>
+                </column>
+              "
+            else
+              "<column>
+                <field>fin.trs.head.code</field>
+                <label>Code</label>
+                <visible>true</visible>
+              </column>"
+            end
+
+            build_request += if invoice_number
+              "<column>
+                  <field>fin.trs.line.invnumber</field>
+                  <label>invoice_number</label>
+                  <visible>true</visible>
+                  <ask>true</ask>
+                  <operator>equal</operator>
+                  <from>#{invoice_number}</from>
+                  <to>#{invoice_number}</to>
+                  <finderparam>#{invoice_number}</finderparam>
+                </column>
+              "
+            else
+              "<column>
+                 <field>fin.trs.line.invnumber</field>
+                 <label>invoice_number</label>
+                 <visible>true</visible>
+              </column>"
+            end
+
+            build_request += if number
+              "<column>
+                  <field>fin.trs.head.number</field>
+                  <label>Boekst.nr.</label>
+                  <visible>true</visible>
+                  <ask>true</ask>
+                  <operator>between</operator>
+                  <from>#{number}</from>
+                  <to>#{number}</to>
+                </column>
+              "
+            else
+              "<column>
+                <field>fin.trs.head.number</field>
+                <label>number</label>
+                <visible>true</visible>
+              </column>"
+            end
+
+            response = Twinfield::Api::Process.request(:process_xml_string) do
+              %(
+                <columns code="100">
+                  #{build_request}
+                </columns>
+              )
+            end
+
+            xml = Nokogiri::XML(response.body[:process_xml_string_response][:process_xml_string_result])
+
+            transactions_xml = xml.css("tr")
+
+            transactions = []
+            transactions_xml.each do |transaction_xml|
+              transactions << Twinfield::Browse::Transaction::Customer.initialize_from_columns_response_row(transaction_xml)
+            end
+
+            transactions
+          end
+        end
+
+        def initialize(code:, invoice_number: nil, customer_code: nil, key: nil, currency: "EUR", value: nil, open_value: nil, available_for_payruns: nil, status: nil, number: nil, date: nil)
+          self.invoice_number = invoice_number
+          self.customer_code = customer_code
+          self.key = key
+          self.currency = currency
+          self.value = value
+          self.open_value = open_value
+          self.available_for_payruns = available_for_payruns
+          self.status = status
+          self.number = number
+          self.date = date
+          self.code = code
+        end
+      end
+    end
+  end
+end