changelog: Liste gefixter Bugs für neues Release
[kivitendo-erp.git] / SL / DATEV.pm
index bfb48d0..86cb729 100644 (file)
@@ -1,5 +1,5 @@
 #=====================================================================
-# Lx-Office ERP
+# kivitendo ERP
 # Copyright (c) 2004
 #
 #  Author: Philip Reetz
 # GNU General Public License for more details.
 # You should have received a copy of the GNU General Public License
 # along with this program; if not, write to the Free Software
-# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA 02110-1335, USA.
 #======================================================================
 #
 # Datev export module
 #======================================================================
 
-package DATEV;
+package SL::DATEV;
 
 use utf8;
 use strict;
 
 use SL::DBUtils;
-use SL::DATEV::KNEFile;
-use SL::Taxkeys;
+use SL::DATEV::CSV;
+use SL::DB;
+use SL::HTML::Util ();
+use SL::Iconv;
+use SL::Locale::String qw(t8);
+use SL::VATIDNr;
 
 use Data::Dumper;
+use DateTime;
+use Exporter qw(import);
 use File::Path;
-use List::Util qw(max);
+use IO::File;
+use List::MoreUtils qw(any);
+use List::Util qw(min max sum);
+use List::UtilsBy qw(partition_by sort_by);
+use Text::CSV_XS;
 use Time::HiRes qw(gettimeofday);
 
+{
+  my $i = 0;
+  use constant {
+    DATEV_ET_BUCHUNGEN => $i++,
+    DATEV_ET_STAMM     => $i++,
+    DATEV_ET_CSV       => $i++,
+
+    DATEV_FORMAT_KNE   => $i++,
+    DATEV_FORMAT_OBE   => $i++,
+    DATEV_FORMAT_CSV   => $i++,
+  };
+}
+
+my @export_constants = qw(DATEV_ET_BUCHUNGEN DATEV_ET_STAMM DATEV_ET_CSV DATEV_FORMAT_KNE DATEV_FORMAT_OBE DATEV_FORMAT_CSV);
+our @EXPORT_OK = (@export_constants);
+our %EXPORT_TAGS = (CONSTANTS => [ @export_constants ]);
+
+
+sub new {
+  my $class = shift;
+  my %data  = @_;
+
+  my $obj = bless {}, $class;
+
+  $obj->$_($data{$_}) for keys %data;
+
+  $obj;
+}
+
+sub exporttype {
+  my $self = shift;
+  $self->{exporttype} = $_[0] if @_;
+  return $self->{exporttype};
+}
+
+sub has_exporttype {
+  defined $_[0]->{exporttype};
+}
+
+sub format {
+  my $self = shift;
+  $self->{format} = $_[0] if @_;
+  return $self->{format};
+}
+
+sub has_format {
+  defined $_[0]->{format};
+}
+
 sub _get_export_path {
   $main::lxdebug->enter_sub();
 
   my ($a, $b) = gettimeofday();
-  my $path    = get_path_for_download_token("${a}-${b}-${$}");
+  my $path    = _get_path_for_download_token("${a}-${b}-${$}");
 
   mkpath($path) unless (-d $path);
 
@@ -51,14 +111,14 @@ sub _get_export_path {
   return $path;
 }
 
-sub get_path_for_download_token {
+sub _get_path_for_download_token {
   $main::lxdebug->enter_sub();
 
-  my $token = shift;
+  my $token = shift || '';
   my $path;
 
   if ($token =~ m|^(\d+)-(\d+)-(\d+)$|) {
-    $path = $::lx_office_conf{paths}->{userspath} . "/datev-export-${1}-${2}-${3}";
+    $path = $::lx_office_conf{paths}->{userspath} . "/datev-export-${1}-${2}-${3}/";
   }
 
   $main::lxdebug->leave_sub();
@@ -66,7 +126,7 @@ sub get_path_for_download_token {
   return $path;
 }
 
-sub get_download_token_for_path {
+sub _get_download_token_for_path {
   $main::lxdebug->enter_sub();
 
   my $path = shift;
@@ -81,333 +141,478 @@ sub get_download_token_for_path {
   return $token;
 }
 
-sub clean_temporary_directories {
-  $main::lxdebug->enter_sub();
+sub download_token {
+  my $self = shift;
+  $self->{download_token} = $_[0] if @_;
+  return $self->{download_token} ||= _get_download_token_for_path($self->export_path);
+}
 
-  foreach my $path (glob($::lx_office_conf{paths}->{userspath} . "/datev-export-*")) {
-    next unless (-d $path);
+sub export_path {
+  my ($self) = @_;
 
-    my $mtime = (stat($path))[9];
-    next if ((time() - $mtime) < 8 * 60 * 60);
+  return  $self->{export_path} ||= _get_path_for_download_token($self->{download_token}) || _get_export_path();
+}
 
-    rmtree $path;
-  }
+sub add_filenames {
+  my $self = shift;
+  push @{ $self->{filenames} ||= [] }, @_;
+}
 
-  $main::lxdebug->leave_sub();
+sub filenames {
+  return @{ $_[0]{filenames} || [] };
 }
 
-sub _fill {
-  $main::lxdebug->enter_sub();
+sub add_error {
+  my $self = shift;
+  push @{ $self->{errors} ||= [] }, @_;
+}
+
+sub errors {
+  return @{ $_[0]{errors} || [] };
+}
+
+sub add_net_gross_differences {
+  my $self = shift;
+  push @{ $self->{net_gross_differences} ||= [] }, @_;
+}
+
+sub net_gross_differences {
+  return @{ $_[0]{net_gross_differences} || [] };
+}
 
-  my $text      = shift;
-  my $field_len = shift;
-  my $fill_char = shift;
-  my $alignment = shift || 'right';
+sub sum_net_gross_differences {
+  return sum $_[0]->net_gross_differences;
+}
+
+sub from {
+ my $self = shift;
+
+ if (@_) {
+   $self->{from} = $_[0];
+ }
+
+ return $self->{from};
+}
 
-  my $text_len  = length $text;
+sub to {
+ my $self = shift;
 
-  if ($field_len < $text_len) {
-    $text = substr $text, 0, $field_len;
+ if (@_) {
+   $self->{to} = $_[0];
+ }
 
-  } elsif ($field_len > $text_len) {
-    my $filler = ($fill_char) x ($field_len - $text_len);
-    $text      = $alignment eq 'right' ? $filler . $text : $text . $filler;
+ return $self->{to};
+}
+
+sub trans_id {
+  my $self = shift;
+
+  if (@_) {
+    $self->{trans_id} = $_[0];
   }
 
-  $main::lxdebug->leave_sub();
+  die "illegal trans_id passed for DATEV export: " . $self->{trans_id} . "\n" unless $self->{trans_id} =~ m/^\d+$/;
 
-  return $text;
+  return $self->{trans_id};
 }
 
-sub get_datev_stamm {
-  $main::lxdebug->enter_sub();
+sub warnings {
+  my $self = shift;
+
+  if (@_) {
+    $self->{warnings} = [@_];
+  } else {
+   return $self->{warnings};
+  }
+}
 
-  my ($self, $myconfig, $form) = @_;
+sub use_pk {
+ my $self = shift;
 
-  # connect to database
-  my $dbh = $form->dbconnect($myconfig);
+ if (@_) {
+   $self->{use_pk} = $_[0];
+ }
 
-  my $query = qq|SELECT * FROM datev|;
-  my $sth   = $dbh->prepare($query);
-  $sth->execute || $form->dberror($query);
+ return $self->{use_pk};
+}
 
-  my $ref = $sth->fetchrow_hashref("NAME_lc");
+sub accnofrom {
+ my $self = shift;
 
-  map { $form->{$_} = $ref->{$_} } keys %$ref;
+ if (@_) {
+   $self->{accnofrom} = $_[0];
+ }
 
-  $sth->finish;
-  $dbh->disconnect;
-  $main::lxdebug->leave_sub();
+ return $self->{accnofrom};
 }
 
-sub save_datev_stamm {
 $main::lxdebug->enter_sub();
+sub accnoto {
my $self = shift;
 
-  my ($self, $myconfig, $form) = @_;
-
-  # connect to database
-  my $dbh = $form->dbconnect_noauto($myconfig);
-
-  my $query = qq|DELETE FROM datev|;
-  $dbh->do($query) || $form->dberror($query);
-
-  $query = qq|INSERT INTO datev
-              (beraternr, beratername, dfvkz, mandantennr, datentraegernr, abrechnungsnr) VALUES
-              (|
-    . $dbh->quote($form->{beraternr}) . qq|,|
-    . $dbh->quote($form->{beratername}) . qq|,|
-    . $dbh->quote($form->{dfvkz}) . qq|,
-              |
-    . $dbh->quote($form->{mandantennr}) . qq|,|
-    . $dbh->quote($form->{datentraegernr}) . qq|,|
-    . $dbh->quote($form->{abrechnungsnr}) . qq|)|;
-  my $sth = $dbh->prepare($query);
-  $sth->execute || $form->dberror($query);
-  $sth->finish;
-
-  $dbh->commit;
-  $dbh->disconnect;
-  $main::lxdebug->leave_sub();
+ if (@_) {
+   $self->{accnoto} = $_[0];
+ }
+
+ return $self->{accnoto};
 }
 
-sub kne_export {
-  $main::lxdebug->enter_sub();
 
-  my ($self, $myconfig, $form) = @_;
-  my $result;
+sub dbh {
+  my $self = shift;
 
-  if ($form->{exporttype} == 0) {
-    $result = kne_buchungsexport($myconfig, $form);
-  } else {
-    $result = kne_stammdatenexport($myconfig, $form);
+  if (@_) {
+    $self->{dbh} = $_[0];
+    $self->{provided_dbh} = 1;
   }
 
-  $main::lxdebug->leave_sub();
+  $self->{dbh} ||= SL::DB->client->dbh;
+}
 
-  return $result;
+sub provided_dbh {
+  $_[0]{provided_dbh};
 }
 
-sub obe_export {
-  $main::lxdebug->enter_sub();
+sub clean_temporary_directories {
+  $::lxdebug->enter_sub;
+
+  foreach my $path (glob($::lx_office_conf{paths}->{userspath} . "/datev-export-*")) {
+    next unless -d $path;
 
-  my ($self, $myconfig, $form) = @_;
+    my $mtime = (stat($path))[9];
+    next if ((time() - $mtime) < 8 * 60 * 60);
 
-  # connect to database
-  my $dbh = $form->dbconnect_noauto($myconfig);
-  $dbh->commit;
-  $dbh->disconnect;
-  $main::lxdebug->leave_sub();
+    rmtree $path;
+  }
+
+  $::lxdebug->leave_sub;
 }
 
-sub get_dates {
-  $main::lxdebug->enter_sub();
+sub get_datev_stamm {
+  return $_[0]{stamm} ||= selectfirst_hashref_query($::form, $_[0]->dbh, 'SELECT * FROM datev');
+}
 
-  my ($zeitraum, $monat, $quartal, $transdatefrom, $transdateto) = @_;
-  my ($fromto, $jahr, $leap);
+sub save_datev_stamm {
+  my ($self, $data) = @_;
 
-  my $form = $main::form;
+  SL::DB->client->with_transaction(sub {
+    do_query($::form, $self->dbh, 'DELETE FROM datev');
 
-  $fromto = "transdate >= ";
+    my @columns = qw(beraternr beratername dfvkz mandantennr datentraegernr abrechnungsnr);
 
-  my @a = localtime;
-  $a[5] += 1900;
-  $jahr = $a[5];
-  if ($zeitraum eq "monat") {
-  SWITCH: {
-      $monat eq "1" && do {
-        $form->{fromdate} = "1.1.$jahr";
-        $form->{todate}   = "31.1.$jahr";
-        last SWITCH;
-      };
-      $monat eq "2" && do {
-        $form->{fromdate} = "1.2.$jahr";
+    my $query = "INSERT INTO datev (" . join(', ', @columns) . ") VALUES (" . join(', ', ('?') x @columns) . ")";
+    do_query($::form, $self->dbh, $query, map { $data->{$_} } @columns);
+    1;
+  }) or do { die SL::DB->client->error };
+}
 
-        #this works from 1901 to 2099, 1900 and 2100 fail.
-        $leap = ($jahr % 4 == 0) ? "29" : "28";
-        $form->{todate} = "$leap.2.$jahr";
-        last SWITCH;
-      };
-      $monat eq "3" && do {
-        $form->{fromdate} = "1.3.$jahr";
-        $form->{todate}   = "31.3.$jahr";
-        last SWITCH;
-      };
-      $monat eq "4" && do {
-        $form->{fromdate} = "1.4.$jahr";
-        $form->{todate}   = "30.4.$jahr";
-        last SWITCH;
-      };
-      $monat eq "5" && do {
-        $form->{fromdate} = "1.5.$jahr";
-        $form->{todate}   = "31.5.$jahr";
-        last SWITCH;
-      };
-      $monat eq "6" && do {
-        $form->{fromdate} = "1.6.$jahr";
-        $form->{todate}   = "30.6.$jahr";
-        last SWITCH;
-      };
-      $monat eq "7" && do {
-        $form->{fromdate} = "1.7.$jahr";
-        $form->{todate}   = "31.7.$jahr";
-        last SWITCH;
-      };
-      $monat eq "8" && do {
-        $form->{fromdate} = "1.8.$jahr";
-        $form->{todate}   = "31.8.$jahr";
-        last SWITCH;
-      };
-      $monat eq "9" && do {
-        $form->{fromdate} = "1.9.$jahr";
-        $form->{todate}   = "30.9.$jahr";
-        last SWITCH;
-      };
-      $monat eq "10" && do {
-        $form->{fromdate} = "1.10.$jahr";
-        $form->{todate}   = "31.10.$jahr";
-        last SWITCH;
-      };
-      $monat eq "11" && do {
-        $form->{fromdate} = "1.11.$jahr";
-        $form->{todate}   = "30.11.$jahr";
-        last SWITCH;
-      };
-      $monat eq "12" && do {
-        $form->{fromdate} = "1.12.$jahr";
-        $form->{todate}   = "31.12.$jahr";
-        last SWITCH;
-      };
-    }
-    $fromto .=
-      "'" . $form->{fromdate} . "' and transdate <= '" . $form->{todate} . "'";
-  }
+sub export {
+  my ($self) = @_;
+
+  return $self->csv_export;
+}
+
+sub csv_export {
+  my ($self) = @_;
+  my $result;
+
+  die 'no exporttype set!' unless $self->has_exporttype;
+
+  if ($self->exporttype == DATEV_ET_BUCHUNGEN) {
+
+    $self->generate_datev_data(from_to => $self->fromto);
+    return if $self->errors;
+
+    my $datev_csv = SL::DATEV::CSV->new(
+      datev_lines  => $self->generate_datev_lines,
+      from         => $self->from,
+      to           => $self->to,
+      locked       => $self->locked,
+    );
+
+
+    my $filename = "EXTF_DATEV_kivitendo" . $self->from->ymd() . '-' . $self->to->ymd() . ".csv";
 
-  elsif ($zeitraum eq "quartal") {
-    if ($quartal == 1) {
-      $fromto .=
-        "'01.01." . $jahr . "' and transdate <= '31.03." . $jahr . "'";
-    } elsif ($quartal == 2) {
-      $fromto .=
-        "'01.04." . $jahr . "' and transdate <= '30.06." . $jahr . "'";
-    } elsif ($quartal == 3) {
-      $fromto .=
-        "'01.07." . $jahr . "' and transdate <= '30.09." . $jahr . "'";
-    } elsif ($quartal == 4) {
-      $fromto .=
-        "'01.10." . $jahr . "' and transdate <= '31.12." . $jahr . "'";
+    my $csv = Text::CSV_XS->new({
+                binary       => 1,
+                sep_char     => ";",
+                always_quote => 1,
+                eol          => "\r\n",
+              }) or die "Cannot use CSV: ".Text::CSV_XS->error_diag();
+
+    # get encoding from defaults - use cp1252 if DATEV strict export is used
+    my $enc = ($::instance_conf->get_datev_export_format eq 'cp1252') ? 'cp1252' : 'utf-8';
+    my $csv_file = IO::File->new($self->export_path . '/' . $filename, ">:encoding($enc)") or die "Can't open: $!";
+
+    $csv->print($csv_file, $_) for @{ $datev_csv->header };
+    $csv->print($csv_file, $_) for @{ $datev_csv->lines  };
+    $csv_file->close;
+    $self->{warnings} = $datev_csv->warnings;
+
+    # convert utf-8 to cp1252//translit if set
+    if ($::instance_conf->get_datev_export_format eq 'cp1252-translit') {
+
+      my $filename_translit = "EXTF_DATEV_kivitendo_translit" . $self->from->ymd() . '-' . $self->to->ymd() . ".csv";
+      open my $fh_in,  '<:encoding(UTF-8)',  $self->export_path . '/' . $filename or die "could not open $filename for reading: $!";
+      open my $fh_out, '>', $self->export_path . '/' . $filename_translit         or die "could not open $filename_translit for writing: $!";
+
+      my $converter = SL::Iconv->new("utf-8", "cp1252//translit");
+
+      print $fh_out $converter->convert($_) while <$fh_in>;
+      close $fh_in;
+      close $fh_out;
+
+      unlink $self->export_path . '/' . $filename or warn "Could not unlink $filename: $!";
+      $filename = $filename_translit;
     }
-  }
 
-  elsif ($zeitraum eq "zeit") {
-    $fromto            .= "'" . $transdatefrom . "' and transdate <= '" . $transdateto . "'";
-    my ($yy, $mm, $dd)  = $main::locale->parse_date(\%main::myconfig, $transdatefrom);
-    $jahr               = $yy;
+    return { download_token => $self->download_token, filenames => $filename };
+
+  } else {
+    die 'unrecognized exporttype';
   }
 
-  $main::lxdebug->leave_sub();
+  return $result;
+}
+
+sub fromto {
+  my ($self) = @_;
+
+  return unless $self->from && $self->to;
 
-  return ($fromto, $jahr);
+  return "transdate >= '" . $self->from->to_lxoffice . "' and transdate <= '" . $self->to->to_lxoffice . "'";
 }
 
 sub _sign {
-  my $value = shift;
+  $_[0] <=> 0;
+}
+
+sub locked {
+ my $self = shift;
 
-  return $value < 0 ? -1
-    :    $value > 0 ?  1
-    :                  0;
+ if (@_) {
+   $self->{locked} = $_[0];
+ }
+ return $self->{locked};
 }
+sub imported {
+ my $self = shift;
 
-sub _get_transactions {
+ if (@_) {
+   $self->{imported} = $_[0];
+ }
+ return $self->{imported};
+}
+
+sub generate_datev_data {
   $main::lxdebug->enter_sub();
 
-  my $fromto   =  shift;
+  my ($self, %params)   = @_;
+  my $fromto            = $params{from_to} // '';
+  my $progress_callback = $params{progress_callback} || sub {};
 
-  my $myconfig =  \%main::myconfig;
   my $form     =  $main::form;
 
-  my $dbh      =  $form->get_standard_dbh($myconfig);
+  my $trans_id_filter = '';
+  my $ar_department_id_filter = '';
+  my $ap_department_id_filter = '';
+  my $gl_department_id_filter = '';
+  if ( $form->{department_id} ) {
+    $ar_department_id_filter = " AND ar.department_id = ? ";
+    $ap_department_id_filter = " AND ap.department_id = ? ";
+    $gl_department_id_filter = " AND gl.department_id = ? ";
+  }
 
-  my ($notsplitindex);
-  my @errors   = ();
+  my ($gl_itime_filter, $ar_itime_filter, $ap_itime_filter);
+  if ( $form->{gldatefrom} ) {
+    $gl_itime_filter = " AND gl.itime >= ? ";
+    $ar_itime_filter = " AND ar.itime >= ? ";
+    $ap_itime_filter = " AND ap.itime >= ? ";
+  } else {
+    $gl_itime_filter = "";
+    $ar_itime_filter = "";
+    $ap_itime_filter = "";
+  }
 
-  $form->{net_gross_differences}     = [];
-  $form->{sum_net_gross_differences} = 0;
+  if ( $self->{trans_id} ) {
+    # ignore dates when trans_id is passed so that the entire transaction is
+    # checked, not just either the initial bookings or the subsequent payments
+    # (the transdates will likely differ)
+    $fromto = '';
+    $trans_id_filter = 'ac.trans_id = ' . $self->trans_id;
+  } else {
+    $fromto      =~ s/transdate/ac\.transdate/g;
+  };
 
-  $fromto      =~ s/transdate/ac\.transdate/g;
+  my ($notsplitindex);
 
-  my $taxkeys  = Taxkeys->new();
   my $filter   = '';            # Useful for debugging purposes
 
-  my %all_taxchart_ids = selectall_as_map($form, $dbh, qq|SELECT DISTINCT chart_id, TRUE AS is_set FROM tax|, 'chart_id', 'is_set');
+  my %all_taxchart_ids = selectall_as_map($form, $self->dbh, qq|SELECT DISTINCT chart_id, TRUE AS is_set FROM tax|, 'chart_id', 'is_set');
+
+  my $ar_accno = "c.accno";
+  my $ap_accno = "c.accno";
+  if ( $self->use_pk ) {
+    $ar_accno = "CASE WHEN ac.chart_link = 'AR' THEN ct.customernumber ELSE c.accno END as accno";
+    $ap_accno = "CASE WHEN ac.chart_link = 'AP' THEN ct.vendornumber   ELSE c.accno END as accno";
+  }
+  my $gl_imported;
+  if ( !$self->imported ) {
+    $gl_imported = " AND NOT imported";
+  }
 
   my $query    =
-    qq|SELECT ac.acc_trans_id, ac.transdate, ac.trans_id,ar.id, ac.amount, ac.taxkey,
-         ar.invnumber, ar.duedate, ar.amount as umsatz,
-         ct.name,
-         c.accno, c.taxkey_id as charttax, c.datevautomatik, c.id, c.link,
-         ar.invoice
+    qq|SELECT ac.acc_trans_id, ac.transdate, ac.gldate, ac.trans_id,ar.id, ac.amount, ac.taxkey, ac.memo,
+         ar.invnumber, ar.duedate, ar.amount as umsatz, COALESCE(ar.tax_point, ar.deliverydate) AS deliverydate, ar.itime::date,
+         ct.name, ct.ustid, ct.customernumber AS vcnumber, ct.id AS customer_id, NULL AS vendor_id,
+         $ar_accno, c.description AS accname, c.taxkey_id as charttax, c.datevautomatik, c.id, ac.chart_link AS link,
+         ar.invoice,
+         t.rate AS taxrate, t.taxdescription,
+         'ar' as table,
+         tc.accno AS tax_accno, tc.description AS tax_accname,
+         ar.department_id,
+         ar.notes,
+         project.projectnumber as projectnumber, project.description as projectdescription,
+         department.description as departmentdescription
        FROM acc_trans ac
        LEFT JOIN ar          ON (ac.trans_id    = ar.id)
        LEFT JOIN customer ct ON (ar.customer_id = ct.id)
        LEFT JOIN chart c     ON (ac.chart_id    = c.id)
+       LEFT JOIN tax t       ON (ac.tax_id      = t.id)
+       LEFT JOIN chart tc    ON (t.chart_id     = tc.id)
+       LEFT JOIN department  ON (department.id  = ar.department_id)
+       LEFT JOIN project     ON (project.id     = ar.globalproject_id)
        WHERE (ar.id IS NOT NULL)
          AND $fromto
+         $trans_id_filter
+         $ar_itime_filter
+         $ar_department_id_filter
          $filter
 
        UNION ALL
 
-       SELECT ac.acc_trans_id, ac.transdate, ac.trans_id,ap.id, ac.amount, ac.taxkey,
-         ap.invnumber, ap.duedate, ap.amount as umsatz,
-         ct.name,
-         c.accno, c.taxkey_id as charttax, c.datevautomatik, c.id, c.link,
-         ap.invoice
+       SELECT ac.acc_trans_id, ac.transdate, ac.gldate, ac.trans_id,ap.id, ac.amount, ac.taxkey, ac.memo,
+         ap.invnumber, ap.duedate, ap.amount as umsatz, COALESCE(ap.tax_point, ap.deliverydate) AS deliverydate, ap.itime::date,
+         ct.name, ct.ustid, ct.vendornumber AS vcnumber, NULL AS customer_id, ct.id AS vendor_id,
+         $ap_accno, c.description AS accname, c.taxkey_id as charttax, c.datevautomatik, c.id, ac.chart_link AS link,
+         ap.invoice,
+         t.rate AS taxrate, t.taxdescription,
+         'ap' as table,
+         tc.accno AS tax_accno, tc.description AS tax_accname,
+         ap.department_id,
+         ap.notes,
+         project.projectnumber as projectnumber, project.description as projectdescription,
+         department.description as departmentdescription
        FROM acc_trans ac
        LEFT JOIN ap        ON (ac.trans_id  = ap.id)
        LEFT JOIN vendor ct ON (ap.vendor_id = ct.id)
        LEFT JOIN chart c   ON (ac.chart_id  = c.id)
+       LEFT JOIN tax t     ON (ac.tax_id    = t.id)
+       LEFT JOIN chart tc    ON (t.chart_id     = tc.id)
+       LEFT JOIN department  ON (department.id  = ap.department_id)
+       LEFT JOIN project     ON (project.id     = ap.globalproject_id)
        WHERE (ap.id IS NOT NULL)
          AND $fromto
+         $trans_id_filter
+         $ap_itime_filter
+         $ap_department_id_filter
          $filter
 
        UNION ALL
 
-       SELECT ac.acc_trans_id, ac.transdate, ac.trans_id,gl.id, ac.amount, ac.taxkey,
-         gl.reference AS invnumber, gl.transdate AS duedate, ac.amount as umsatz,
-         gl.description AS name,
-         c.accno, c.taxkey_id as charttax, c.datevautomatik, c.id, c.link,
-         FALSE AS invoice
+       SELECT ac.acc_trans_id, ac.transdate, ac.gldate, ac.trans_id,gl.id, ac.amount, ac.taxkey, ac.memo,
+         gl.reference AS invnumber, NULL AS duedate, ac.amount as umsatz, COALESCE(gl.tax_point, gl.deliverydate) AS deliverydate, gl.itime::date,
+         gl.description AS name, NULL as ustid, '' AS vcname, NULL AS customer_id, NULL AS vendor_id,
+         c.accno, c.description AS accname, c.taxkey_id as charttax, c.datevautomatik, c.id, ac.chart_link AS link,
+         FALSE AS invoice,
+         t.rate AS taxrate, t.taxdescription,
+         'gl' as table,
+         tc.accno AS tax_accno, tc.description AS tax_accname,
+         gl.department_id,
+         gl.notes,
+         '' as projectnumber, '' as projectdescription,
+         department.description as departmentdescription
        FROM acc_trans ac
        LEFT JOIN gl      ON (ac.trans_id  = gl.id)
        LEFT JOIN chart c ON (ac.chart_id  = c.id)
+       LEFT JOIN tax t   ON (ac.tax_id    = t.id)
+       LEFT JOIN chart tc    ON (t.chart_id     = tc.id)
+       LEFT JOIN department  ON (department.id  = gl.department_id)
        WHERE (gl.id IS NOT NULL)
          AND $fromto
+         $trans_id_filter
+         $gl_itime_filter
+         $gl_department_id_filter
+         $gl_imported
+         AND NOT EXISTS (SELECT gl_id from ap_gl where gl_id = gl.id)
          $filter
 
        ORDER BY trans_id, acc_trans_id|;
 
-  my $sth = prepare_execute_query($form, $dbh, $query);
-  $form->{DATEV} = [];
+  my @query_args;
+  if ( $form->{gldatefrom} or $form->{department_id} ) {
+
+    for ( 1 .. 3 ) {
+      if ( $form->{gldatefrom} ) {
+        my $glfromdate = $::locale->parse_date_to_object($form->{gldatefrom});
+        die "illegal data" unless ref($glfromdate) eq 'DateTime';
+        push(@query_args, $glfromdate);
+      }
+      if ( $form->{department_id} ) {
+        push(@query_args, $form->{department_id});
+      }
+    }
+  }
+
+  my $sth = prepare_execute_query($form, $self->dbh, $query, @query_args);
+  $self->{DATEV} = [];
 
   my $counter = 0;
-  while (my $ref = $sth->fetchrow_hashref("NAME_lc")) {
+  my $continue = 1; #
+  my $name;
+  while ( $continue && (my $ref = $sth->fetchrow_hashref("NAME_lc")) ) {
+    last unless $ref;  # for single transactions
     $counter++;
     if (($counter % 500) == 0) {
-      print("$counter ");
+      $progress_callback->($counter);
     }
 
     my $trans    = [ $ref ];
 
     my $count    = $ref->{amount};
     my $firstrun = 1;
+
+    # if the amount of a booking in a group is smaller than 0.02, any tax
+    # amounts will likely be smaller than 1 cent, so go into subcent mode
     my $subcent  = abs($count) < 0.02;
 
+    # records from acc_trans are ordered by trans_id and acc_trans_id
+    # first check for unbalanced ledger inside one trans_id
+    # there may be several groups inside a trans_id, e.g. the original booking and the payment
+    # each group individually should be exactly balanced and each group
+    # individually needs its own datev lines
+
+    # keep fetching new acc_trans lines until the end of a balanced group is reached
     while (abs($count) > 0.01 || $firstrun || ($subcent && abs($count) > 0.005)) {
       my $ref2 = $sth->fetchrow_hashref("NAME_lc");
-      last unless ($ref2);
+      unless ( $ref2 ) {
+        $continue = 0;
+        last;
+      };
+
+      # check if trans_id of current acc_trans line is still the same as the
+      # trans_id of the first line in group, i.e. we haven't finished a 0-group
+      # before moving on to the next trans_id, error will likely be in the old
+      # trans_id.
 
       if ($ref2->{trans_id} != $trans->[0]->{trans_id}) {
-        $form->error("Unbalanced ledger! old trans_id " . $trans->[0]->{trans_id} . " new trans_id " . $ref2->{trans_id} . " count $count");
-        ::end_of_request();
+        require SL::DB::Manager::AccTransaction;
+        if ( $trans->[0]->{trans_id} ) {
+          my $acc_trans_obj  = SL::DB::Manager::AccTransaction->get_first(where => [ trans_id => $trans->[0]->{trans_id} ]);
+          $self->add_error(t8("Export error in transaction #1: Unbalanced ledger before next transaction (#2)",
+                              $acc_trans_obj->transaction_name, $ref2->{trans_id})
+          );
+        };
+        return;
       }
 
       push @{ $trans }, $ref2;
@@ -434,14 +639,29 @@ sub _get_transactions {
       }
     }
 
-    my %taxid_taxkeys = ();
     my $absumsatz     = 0;
     if (scalar(@{$trans}) <= 2) {
-      push @{ $form->{DATEV} }, $trans;
+      push @{ $self->{DATEV} }, $trans;
       next;
     }
 
+    # determine at which array position the reference value (called absumsatz) is
+    # and which amount it has
+
     for my $j (0 .. (scalar(@{$trans}) - 1)) {
+
+      # Three cases:
+      # 1: gl transaction (Dialogbuchung), invoice is false, no double split booking allowed
+
+      # 2: sales or vendor invoice (Verkaufs- und Einkaufsrechnung): invoice is
+      # true, instead of absumsatz use link AR/AP (there should only be one
+      # entry)
+
+      # 3. AR/AP transaction (Kreditoren- und Debitorenbuchung): invoice is false,
+      # instead of absumsatz use link AR/AP (there should only be one, so jump
+      # out of search as soon as you find it )
+
+      # case 1 and 2
       # for gl-bookings no split is allowed and there is no AR/AP account, so we always use the maximum value as a reference
       # for ap/ar bookings we can always search for AR/AP in link and use that
       if ( ( not $trans->[$j]->{'invoice'} and abs($trans->[$j]->{'amount'}) > abs($absumsatz) )
@@ -449,12 +669,28 @@ sub _get_transactions {
         $absumsatz     = $trans->[$j]->{'amount'};
         $notsplitindex = $j;
       }
+
+      # case 3
+      # Problem: we can't distinguish between AR and AP and normal invoices via boolean "invoice"
+      # for AR and AP transaction exit the loop as soon as an AR or AP account is found
+      # there must be only one AR or AP chart in the booking
+      # since it is possible to do this kind of things with GL too, make sure those don't get aborted in case someone
+      # manually pays an invoice in GL.
+      if ($trans->[$j]->{table} ne 'gl' and ($trans->[$j]->{'link'} eq 'AR' or $trans->[$j]->{'link'} eq 'AP')) {
+        $notsplitindex = $j;   # position in booking with highest amount
+        $absumsatz     = $trans->[$j]->{'amount'};
+        last;
+      };
     }
 
     my $ml             = ($trans->[0]->{'umsatz'} > 0) ? 1 : -1;
     my $rounding_error = 0;
     my @taxed;
 
+    # go through each line and determine if it is a tax booking or not
+    # skip all tax lines and notsplitindex line
+    # push all other accounts (e.g. income or expense) with corresponding taxkey
+
     for my $j (0 .. (scalar(@{$trans}) - 1)) {
       if (   ($j != $notsplitindex)
           && !$trans->[$j]->{is_tax}
@@ -471,15 +707,14 @@ sub _get_transactions {
         $new_trans{'umsatz'}      = abs($trans->[$j]->{'amount'}) * $ml;
         $trans->[$j]->{'umsatz'}  = abs($trans->[$j]->{'amount'}) * $ml;
 
-        push @{ $form->{DATEV} }, [ \%new_trans, $trans->[$j] ];
+        push @{ $self->{DATEV} }, [ \%new_trans, $trans->[$j] ];
 
       } elsif (($j != $notsplitindex) && !$trans->[$j]->{is_tax}) {
-        my %tax_info = $taxkeys->get_full_tax_info('transdate' => $trans->[$j]->{transdate});
 
         my %new_trans = ();
         map { $new_trans{$_} = $trans->[$notsplitindex]->{$_}; } keys %{ $trans->[$notsplitindex] };
 
-        my $tax_rate              = $tax_info{taxkeys}->{ $trans->[$j]->{'taxkey'} }->{taxrate};
+        my $tax_rate              = $trans->[$j]->{'taxrate'};
         $new_trans{'net_amount'}  = $trans->[$j]->{'amount'} * -1;
         $new_trans{'tax_rate'}    = 1 + $tax_rate;
 
@@ -500,8 +735,8 @@ sub _get_transactions {
           $absumsatz               -= $rounded;
         }
 
-        push @{ $form->{DATEV} }, [ \%new_trans, $trans->[$j] ];
-        push @taxed, $form->{DATEV}->[-1];
+        push @{ $self->{DATEV} }, [ \%new_trans, $trans->[$j] ];
+        push @taxed, $self->{DATEV}->[-1];
       }
     }
 
@@ -545,485 +780,548 @@ sub _get_transactions {
 
     $absumsatz = $form->round_amount($absumsatz, 2);
     if (abs($absumsatz) >= (0.01 * (1 + scalar @taxed))) {
-      push @errors, "Datev-Export fehlgeschlagen! Bei Transaktion $trans->[0]->{trans_id} ($absumsatz)\n";
-
+      require SL::DB::Manager::AccTransaction;
+      my $acc_trans_obj  = SL::DB::Manager::AccTransaction->get_first(where => [ trans_id => $trans->[0]->{trans_id} ]);
+      $self->add_error(t8("Export error in transaction #1: Rounding error too large #2",
+                          $acc_trans_obj->transaction_name, $absumsatz)
+      );
     } elsif (abs($absumsatz) >= 0.01) {
-      push @{ $form->{net_gross_differences} }, $absumsatz;
-      $form->{sum_net_gross_differences} += $absumsatz;
+      $self->add_net_gross_differences($absumsatz);
     }
   }
 
   $sth->finish();
 
-  $form->error(join("<br>\n", @errors)) if (@errors);
-
-  $main::lxdebug->leave_sub();
+  $::lxdebug->leave_sub;
 }
 
-sub make_kne_data_header {
-  $main::lxdebug->enter_sub();
+sub generate_datev_lines {
+  my ($self) = @_;
+
+  my @datev_lines = ();
+
+  foreach my $transaction ( @{ $self->{DATEV} } ) {
+
+    # each $transaction entry contains data from several acc_trans entries
+    # belonging to the same trans_id
+
+    my %datev_data = (); # data for one transaction
+    my $trans_lines = scalar(@{$transaction});
+
+    my $umsatz         = 0;
+    my $gegenkonto     = "";
+    my $konto          = "";
+    my $belegfeld1     = "";
+    my $datum          = "";
+    my $waehrung       = "";
+    my $buchungstext   = "";
+    my $belegfeld2     = "";
+    my $datevautomatik = 0;
+    my $taxkey         = 0;
+    my $charttax       = 0;
+    my $ustid          ="";
+    my ($haben, $soll);
+    for (my $i = 0; $i < $trans_lines; $i++) {
+      if ($trans_lines == 2) {
+        if (abs($transaction->[$i]->{'amount'}) > abs($umsatz)) {
+          $umsatz = $transaction->[$i]->{'amount'};
+        }
+      } else {
+        if (abs($transaction->[$i]->{'umsatz'}) > abs($umsatz)) {
+          $umsatz = $transaction->[$i]->{'umsatz'};
+        }
+      }
+      if ($transaction->[$i]->{'datevautomatik'}) {
+        $datevautomatik = 1;
+      }
+      if ($transaction->[$i]->{'taxkey'}) {
+        $taxkey = $transaction->[$i]->{'taxkey'};
+        # $taxkey = 0 if $taxkey == 94; # taxbookings are in gl
+      }
+      if ($transaction->[$i]->{'charttax'}) {
+        $charttax = $transaction->[$i]->{'charttax'};
+      }
+      if ($transaction->[$i]->{'amount'} > 0) {
+        $haben = $i;
+      } else {
+        $soll = $i;
+      }
+    }
 
-  my ($myconfig, $form, $fromto, $start_jahr) = @_;
-  my ($primanota);
+    if ($trans_lines >= 2) {
 
-  my $jahr = $start_jahr;
-  if (!$jahr) {
-    my @a = localtime;
-    $jahr = $a[5];
-  }
+      # Personenkontenerweiterung: accno has already been replaced if use_pk was set
+      $datev_data{'gegenkonto'} = $transaction->[$haben]->{'accno'};
+      $datev_data{'konto'}      = $transaction->[$soll]->{'accno'};
+      if ($transaction->[$haben]->{'invnumber'} ne "") {
+        $datev_data{belegfeld1} = $transaction->[$haben]->{'invnumber'};
+      }
+      $datev_data{datum} = $transaction->[$haben]->{'transdate'};
+      $datev_data{waehrung} = 'EUR';
+      $datev_data{kost1} = $transaction->[$haben]->{'departmentdescription'};
+      $datev_data{kost2} = $transaction->[$haben]->{'projectdescription'};
 
-  #Header
-  my $header  = "\x1D\x181";
-  $header    .= _fill($form->{datentraegernr}, 3, ' ', 'left');
-  $header    .= ($fromto) ? "11" : "13"; # Anwendungsnummer
-  $header    .= _fill($form->{dfvkz}, 2, '0');
-  $header    .= _fill($form->{beraternr}, 7, '0');
-  $header    .= _fill($form->{mandantennr}, 5, '0');
-  $header    .= _fill($form->{abrechnungsnr} . $jahr, 6, '0');
-
-  $fromto         =~ s/transdate|>=|and|\'|<=//g;
-  my ($from, $to) =  split /   /, $fromto;
-  $from           =~ s/ //g;
-  $to             =~ s/ //g;
-
-  if ($from ne "") {
-    my ($fday, $fmonth, $fyear) = split(/\./, $from);
-    if (length($fmonth) < 2) {
-      $fmonth = "0" . $fmonth;
+      if ($transaction->[$haben]->{'name'} ne "") {
+        $datev_data{buchungstext} = $transaction->[$haben]->{'name'};
+      }
+      if (($transaction->[$haben]->{'ustid'} // '') ne "") {
+        $datev_data{ustid} = SL::VATIDNr->normalize($transaction->[$haben]->{'ustid'});
+      }
+      if (($transaction->[$haben]->{'duedate'} // '') ne "") {
+        $datev_data{belegfeld2} = $transaction->[$haben]->{'duedate'};
+      }
+
+      # if deliverydate exists, add it to datev export if it is
+      # * an ar/ap booking that is not a payment
+      # * a gl booking
+      if (    ($transaction->[$haben]->{'deliverydate'} // '') ne ''
+           && (
+                (    $transaction->[$haben]->{'table'} =~ /^(ar|ap)$/
+                  && $transaction->[$haben]->{'link'}  !~ m/_paid/
+                  && $transaction->[$soll]->{'link'}   !~ m/_paid/
+                )
+                || $transaction->[$haben]->{'table'} eq 'gl'
+              )
+         ) {
+        $datev_data{leistungsdatum} = $transaction->[$haben]->{'deliverydate'};
+      }
     }
-    if (length($fday) < 2) {
-      $fday = "0" . $fday;
+    $datev_data{umsatz} = abs($umsatz); # sales invoices without tax have a different sign???
+
+    # Dies ist die einzige Stelle die datevautomatik auswertet. Was soll gesagt werden?
+    # Im Prinzip hat jeder acc_trans Eintrag einen Steuerschlüssel, außer, bei gewissen Fällen
+    # wie: Kreditorenbuchung mit negativen Vorzeichen, SEPA-Export oder Rechnungen die per
+    # Skript angelegt werden.
+    # Also falls ein Steuerschlüssel da ist und NICHT datevautomatik diesen Block hinzufügen.
+    # Oder aber datevautomatik ist WAHR, aber der Steuerschlüssel in der acc_trans weicht
+    # von dem in der Chart ab: Also wahrscheinlich Programmfehler (NULL übergeben, statt
+    # DATEV-Steuerschlüssel) oder der Steuerschlüssel des Kontos weicht WIRKLICH von dem Eintrag in der
+    # acc_trans ab. Gibt es für diesen Fall eine plausiblen Grund?
+    #
+
+    # only set buchungsschluessel if the following conditions are met:
+    if (   ( $datevautomatik || $taxkey)
+        && (!$datevautomatik || ($datevautomatik && ($charttax ne $taxkey)))) {
+      # $datev_data{buchungsschluessel} = !$datevautomatik ? $taxkey : "4";
+      $datev_data{buchungsschluessel} = $taxkey;
     }
-    $from = $fday . $fmonth . substr($fyear, -2, 2);
-  } else {
-    $from = "";
+    # set lock for each transaction
+    $datev_data{locked} = $self->locked;
+
+    push(@datev_lines, \%datev_data) if $datev_data{umsatz};
   }
 
-  $header .= $from;
+  # example of modifying export data:
+  # foreach my $datev_line ( @datev_lines ) {
+  #   if ( $datev_line{"konto"} eq '1234' ) {
+  #     $datev_line{"konto"} = '9999';
+  #   }
+  # }
+  #
 
-  if ($to ne "") {
-    my ($tday, $tmonth, $tyear) = split(/\./, $to);
-    if (length($tmonth) < 2) {
-      $tmonth = "0" . $tmonth;
-    }
-    if (length($tday) < 2) {
-      $tday = "0" . $tday;
-    }
-    $to = $tday . $tmonth . substr($tyear, -2, 2);
-  } else {
-    $to = "";
-  }
-  $header .= $to;
+  return \@datev_lines;
+}
+
+sub check_vcnumbers_are_valid_pk_numbers {
+  my ($self) = @_;
+
+  # better use a class variable and set this in sub new (also needed in DATEV::CSV)
+  # calculation is also a bit more sane in sub check_valid_length_of_accounts
+  my $length_of_accounts = length(SL::DB::Manager::Chart->get_first(where => [charttype => 'A'])->accno) // 4;
+  my $pk_length = $length_of_accounts + 1;
+  my $query = <<"SQL";
+   SELECT customernumber AS vcnumber FROM customer WHERE customernumber !~ '^[[:digit:]]{$pk_length}\$'
+   UNION
+   SELECT vendornumber   AS vcnumber FROM vendor   WHERE vendornumber   !~ '^[[:digit:]]{$pk_length}\$'
+   LIMIT 1;
+SQL
+  my ($has_non_pk_accounts)  = selectrow_query($::form, SL::DB->client->dbh, $query);
+  return defined $has_non_pk_accounts ? 0 : 1;
+}
+
+
+sub check_valid_length_of_accounts {
+  my ($self) = @_;
 
-  if ($fromto ne "") {
-    $primanota = "001";
-    $header .= $primanota;
+  my $query = <<"SQL";
+  SELECT DISTINCT char_length (accno) FROM chart WHERE charttype='A' AND id in (select chart_id from acc_trans);
+SQL
+
+  my $accno_length = selectall_hashref_query($::form, SL::DB->client->dbh, $query);
+  if (1 < scalar @$accno_length) {
+    $::form->error(t8("Invalid combination of ledger account number length." .
+                      " Mismatch length of #1 with length of #2. Please check your account settings. ",
+                      $accno_length->[0]->{char_length}, $accno_length->[1]->{char_length}));
   }
+  return 1;
+}
 
-  $header .= _fill($form->{passwort}, 4, '0');
-  $header .= " " x 16;       # Anwendungsinfo
-  $header .= " " x 16;       # Inputinfo
-  $header .= "\x79";
+sub DESTROY {
+  clean_temporary_directories();
+}
 
-  #Versionssatz
-  my $versionssatz  = $form->{exporttype} == 0 ? "\xB5" . "1," : "\xB6" . "1,";
+1;
 
-  my $dbh           = $form->get_standard_dbh($myconfig);
-  my $query         = qq|SELECT accno FROM chart LIMIT 1|;
-  my $ref           = selectfirst_hashref_query($form, $dbh, $query);
+__END__
 
-  $versionssatz    .= length $ref->{accno};
-  $versionssatz    .= ",";
-  $versionssatz    .= length $ref->{accno};
-  $versionssatz    .= ",SELF" . "\x1C\x79";
+=encoding utf-8
 
-  $header          .= $versionssatz;
+=head1 NAME
 
-  $main::lxdebug->leave_sub();
+SL::DATEV - kivitendo DATEV Export module
 
-  return $header;
-}
+=head1 SYNOPSIS
 
-sub datetofour {
-  $main::lxdebug->enter_sub();
+  use SL::DATEV qw(:CONSTANTS);
 
-  my ($date, $six) = @_;
+  my $startdate = DateTime->new(year => 2014, month => 9, day => 1);
+  my $enddate   = DateTime->new(year => 2014, month => 9, day => 31);
+  my $datev = SL::DATEV->new(
+    exporttype => DATEV_ET_BUCHUNGEN,
+    format     => DATEV_FORMAT_KNE,
+    from       => $startdate,
+    to         => $enddate,
+  );
 
-  my ($day, $month, $year) = split(/\./, $date);
+  # To only export transactions from a specific trans_id: (from and to are ignored)
+  my $invoice = SL::DB::Manager::Invoice->find_by( invnumber => '216' );
+  my $datev = SL::DATEV->new(
+    exporttype => DATEV_ET_BUCHUNGEN,
+    format     => DATEV_FORMAT_KNE,
+    trans_id   => $invoice->trans_id,
+  );
 
-  if ($day =~ /^0/) {
-    $day = substr($day, 1, 1);
-  }
-  if (length($month) < 2) {
-    $month = "0" . $month;
-  }
-  if (length($year) > 2) {
-    $year = substr($year, -2, 2);
-  }
+  my $datev = SL::DATEV->new(
+    exporttype => DATEV_ET_STAMM,
+    format     => DATEV_FORMAT_KNE,
+    accnofrom  => $start_account_number,
+    accnoto    => $end_account_number,
+  );
 
-  if ($six) {
-    $date = $day . $month . $year;
-  } else {
-    $date = $day . $month;
+  # get or set datev stamm
+  my $hashref = $datev->get_datev_stamm;
+  $datev->save_datev_stamm($hashref);
+
+  # manually clean up temporary directories older than 8 hours
+  $datev->clean_temporary_directories;
+
+  # export
+  $datev->export;
+
+  if ($datev->errors) {
+    die join "\n", $datev->error;
   }
 
-  $main::lxdebug->leave_sub();
+  # get relevant data for saving the export:
+  my $dl_token = $datev->download_token;
+  my $path     = $datev->export_path;
+  my @files    = $datev->filenames;
 
-  return $date;
-}
+  # retrieving an export at a later time
+  my $datev = SL::DATEV->new(
+    download_token => $dl_token_from_user,
+  );
 
-sub trim_leading_zeroes {
-  my $str = shift;
+  my $path     = $datev->export_path;
+  my @files    = glob("$path/*");
 
-  $str =~ s/^0+//g;
+  # Only test the datev data of a specific trans_id, without generating an
+  # export file, but filling $datev->errors if errors exist
 
-  return $str;
-}
+  my $datev = SL::DATEV->new(
+    trans_id   => $invoice->trans_id,
+  );
+  $datev->generate_datev_data;
+  # if ($datev->errors) { ...
 
-sub make_ed_versionset {
-  $main::lxdebug->enter_sub();
 
-  my ($header, $filename, $blockcount, $fromto) = @_;
+=head1 DESCRIPTION
 
-  my $versionset  = "V" . substr($filename, 2, 5);
-  $versionset    .= substr($header, 6, 22);
+This module implements the DATEV export standard. For usage see above.
 
-  if ($fromto ne "") {
-    $versionset .= "0000" . substr($header, 28, 19);
-  } else {
-    my $datum = " " x 16;
-    $versionset .= $datum . "001" . substr($header, 28, 4);
-  }
+=head1 FUNCTIONS
 
-  $versionset .= _fill($blockcount, 5, '0');
-  $versionset .= "001";
-  $versionset .= " 1";
-  $versionset .= substr($header, -12, 10) . "    ";
-  $versionset .= " " x 53;
+=over 4
 
-  $main::lxdebug->leave_sub();
+=item new PARAMS
 
-  return $versionset;
-}
+Generic constructor. See section attributes for information about what to pass.
 
-sub make_ev_header {
-  $main::lxdebug->enter_sub();
+=item generate_datev_data
 
-  my ($form, $fileno) = @_;
+Fetches all transactions from the database (via a trans_id or a date range),
+and does an initial transformation (e.g. filters out tax, determines
+the brutto amount, checks split transactions ...) and stores this data in
+$self->{DATEV}.
 
-  my $ev_header  = _fill($form->{datentraegernr}, 3, ' ', 'left');
-  $ev_header    .= "   ";
-  $ev_header    .= _fill($form->{beraternr}, 7, ' ', 'left');
-  $ev_header    .= _fill($form->{beratername}, 9, ' ', 'left');
-  $ev_header    .= " ";
-  $ev_header    .= (_fill($fileno, 5, '0')) x 2;
-  $ev_header    .= " " x 95;
+If any errors are found these are collected in $self->errors.
 
-  $main::lxdebug->leave_sub();
+This function is needed for all the exports, but can be also called
+independently in order to check transactions for DATEV compatibility.
 
-  return $ev_header;
-}
+=item generate_datev_lines
 
-sub kne_buchungsexport {
-  $main::lxdebug->enter_sub();
+Parse the data in $self->{DATEV} and transform it into a format that can be
+used by DATEV, e.g. determines Konto and Gegenkonto, the taxkey, ...
 
-  my ($myconfig, $form) = @_;
+The transformed data is returned as an arrayref, which is ready to be converted
+to a DATEV data format, e.g. KNE, OBE, CSV, ...
 
-  my @filenames;
+At this stage the "DATEV rule" has already been applied to the taxkeys, i.e.
+entries with datevautomatik have an empty taxkey, as the taxkey is already
+determined by the chart.
 
-  my $export_path = _get_export_path() . "/";
-  my $filename    = "ED00000";
-  my $evfile      = "EV01";
-  my @ed_versionset;
-  my $fileno = 0;
+=item get_datev_stamm
 
-  $form->header;
-  print qq|
-  <html>
-  <body>Export in Bearbeitung<br>
-  Buchungss&auml;tze verarbeitet:
-|;
+Loads DATEV Stammdaten and returns as hashref.
 
-  my ($fromto, $start_jahr) =
-    &get_dates($form->{zeitraum}, $form->{monat},
-               $form->{quartal},  $form->{transdatefrom},
-               $form->{transdateto});
-  _get_transactions($fromto);
-  my $counter = 0;
-  print qq|<br>2. Durchlauf:|;
-  while (scalar(@{ $form->{DATEV} })) {
-    my $umsatzsumme = 0;
-    $filename++;
-    my $ed_filename = $export_path . $filename;
-    push(@filenames, $filename);
-    my $header = &make_kne_data_header($myconfig, $form, $fromto, $start_jahr);
-
-    my $kne_file = SL::DATEV::KNEFile->new();
-    $kne_file->add_block($header);
-
-    while (scalar(@{ $form->{DATEV} }) > 0) {
-      my $transaction = shift @{ $form->{DATEV} };
-      my $trans_lines = scalar(@{$transaction});
-      $counter++;
-      if (($counter % 500) == 0) {
-        print("$counter ");
-      }
+=item save_datev_stamm HASHREF
 
-      my $umsatz         = 0;
-      my $gegenkonto     = "";
-      my $konto          = "";
-      my $belegfeld1     = "";
-      my $datum          = "";
-      my $waehrung       = "";
-      my $buchungstext   = "";
-      my $belegfeld2     = "";
-      my $datevautomatik = 0;
-      my $taxkey         = 0;
-      my $charttax       = 0;
-      my ($haben, $soll);
-      my $iconv          = $::locale->{iconv_utf8};
-      my %umlaute = ($iconv->convert('ä') => 'ae',
-                     $iconv->convert('ö') => 'oe',
-                     $iconv->convert('ü') => 'ue',
-                     $iconv->convert('Ä') => 'Ae',
-                     $iconv->convert('Ö') => 'Oe',
-                     $iconv->convert('Ü') => 'Ue',
-                     $iconv->convert('ß') => 'sz');
-      for (my $i = 0; $i < $trans_lines; $i++) {
-        if ($trans_lines == 2) {
-          if (abs($transaction->[$i]->{'amount'}) > abs($umsatz)) {
-            $umsatz = $transaction->[$i]->{'amount'};
-          }
-        } else {
-          if (abs($transaction->[$i]->{'umsatz'}) > abs($umsatz)) {
-            $umsatz = $transaction->[$i]->{'umsatz'};
-          }
-        }
-        if ($transaction->[$i]->{'datevautomatik'}) {
-          $datevautomatik = 1;
-        }
-        if ($transaction->[$i]->{'taxkey'}) {
-          $taxkey = $transaction->[$i]->{'taxkey'};
-        }
-        if ($transaction->[$i]->{'charttax'}) {
-          $charttax = $transaction->[$i]->{'charttax'};
-        }
-        if ($transaction->[$i]->{'amount'} > 0) {
-          $haben = $i;
-        } else {
-          $soll = $i;
-        }
-      }
+Saves DATEV Stammdaten from provided hashref.
 
-      # Umwandlung von Umlauten und Sonderzeichen in erlaubte Zeichen bei Textfeldern
-      foreach my $umlaut (keys(%umlaute)) {
-        $transaction->[$haben]->{'invnumber'} =~ s/${umlaut}/${umlaute{$umlaut}}/g;
-        $transaction->[$haben]->{'name'}      =~ s/${umlaut}/${umlaute{$umlaut}}/g;
-      }
+=item exporttype
 
-      $transaction->[$haben]->{'invnumber'} =~ s/[^0-9A-Za-z\$\%\&\*\+\-\/]//g;
-      $transaction->[$haben]->{'name'}      =~ s/[^0-9A-Za-z\$\%\&\*\+\-\ \/]//g;
+See L<CONSTANTS> for possible values
 
-      $transaction->[$haben]->{'invnumber'} =  substr($transaction->[$haben]->{'invnumber'}, 0, 12);
-      $transaction->[$haben]->{'name'}      =  substr($transaction->[$haben]->{'name'}, 0, 30);
-      $transaction->[$haben]->{'invnumber'} =~ s/\ *$//;
-      $transaction->[$haben]->{'name'}      =~ s/\ *$//;
+=item has_exporttype
 
-      if ($trans_lines >= 2) {
+Returns true if an exporttype has been set. Without exporttype most report functions won't work.
 
-        $gegenkonto = "a" . trim_leading_zeroes($transaction->[$haben]->{'accno'});
-        $konto      = "e" . trim_leading_zeroes($transaction->[$soll]->{'accno'});
-        if ($transaction->[$haben]->{'invnumber'} ne "") {
-          $belegfeld1 = "\xBD" . $transaction->[$haben]->{'invnumber'} . "\x1C";
-        }
-        $datum = "d";
-        $datum .= &datetofour($transaction->[$haben]->{'transdate'}, 0);
-        $waehrung = "\xB3" . "EUR" . "\x1C";
-        if ($transaction->[$haben]->{'name'} ne "") {
-          $buchungstext = "\x1E" . $transaction->[$haben]->{'name'} . "\x1C";
-        }
-        if ($transaction->[$haben]->{'duedate'} ne "") {
-          $belegfeld2 = "\xBE" . &datetofour($transaction->[$haben]->{'duedate'}, 1) . "\x1C";
-        }
-      }
+=item format
 
-      $umsatz       = $kne_file->format_amount(abs($umsatz), 0);
-      $umsatzsumme += $umsatz;
-      $kne_file->add_block("+" . $umsatz);
-
-      # Dies ist die einzige Stelle die datevautomatik auswertet. Was soll gesagt werden?
-      # Im Prinzip hat jeder acc_trans Eintrag einen Steuerschlüssel, außer, bei gewissen Fällen
-      # wie: Kreditorenbuchung mit negativen Vorzeichen, SEPA-Export oder Rechnungen die per
-      # Skript angelegt werden.
-      # Also falls ein Steuerschlüssel da ist und NICHT datevautomatik diesen Block hinzufügen.
-      # Oder aber datevautomatik ist WAHR, aber der Steuerschlüssel in der acc_trans weicht
-      # von dem in der Chart ab: Also wahrscheinlich Programmfehler (NULL übergeben, statt
-      # DATEV-Steuerschlüssel) oder der Steuerschlüssel des Kontos weicht WIRKLICH von dem Eintrag in der
-      # acc_trans ab. Gibt es für diesen Fall eine plausiblen Grund?
-      #
-      if (   ( $datevautomatik || $taxkey)
-          && (!$datevautomatik || ($datevautomatik && ($charttax ne $taxkey)))) {
-#         $kne_file->add_block("\x6C" . (!$datevautomatik ? $taxkey : "4"));
-        $kne_file->add_block("\x6C${taxkey}");
-      }
+Specifies the designated format of the export. Currently only KNE export is implemented.
 
-      $kne_file->add_block($gegenkonto);
-      $kne_file->add_block($belegfeld1);
-      $kne_file->add_block($belegfeld2);
-      $kne_file->add_block($datum);
-      $kne_file->add_block($konto);
-      $kne_file->add_block($buchungstext);
-      $kne_file->add_block($waehrung . "\x79");
-    }
+See L<CONSTANTS> for possible values
 
-    my $mandantenendsumme = "x" . $kne_file->format_amount($umsatzsumme / 100.0, 14) . "\x79\x7a";
+=item has_format
 
-    $kne_file->add_block($mandantenendsumme);
-    $kne_file->flush();
+Returns true if a format has been set. Without format most report functions won't work.
 
-    open(ED, ">", $ed_filename) or die "can't open outputfile: $!\n";
-    print(ED $kne_file->get_data());
-    close(ED);
+=item download_token
 
-    $ed_versionset[$fileno] = &make_ed_versionset($header, $filename, $kne_file->get_block_count(), $fromto);
-    $fileno++;
-  }
+Returns a download token for this DATEV object.
 
-  #Make EV Verwaltungsdatei
-  my $ev_header = &make_ev_header($form, $fileno);
-  my $ev_filename = $export_path . $evfile;
-  push(@filenames, $evfile);
-  open(EV, ">", $ev_filename) or die "can't open outputfile: EV01\n";
-  print(EV $ev_header);
+Note: If either a download_token or export_path were set at the creation these are infered, otherwise randomly generated.
 
-  foreach my $file (@ed_versionset) {
-    print(EV $ed_versionset[$file]);
-  }
-  close(EV);
-  print qq|<br>Done. <br>
-|;
-  ###
-  $main::lxdebug->leave_sub();
+=item export_path
 
-  return { 'download_token' => get_download_token_for_path($export_path), 'filenames' => \@filenames };
-}
+Returns an export_path for this DATEV object.
 
-sub kne_stammdatenexport {
-  $main::lxdebug->enter_sub();
+Note: If either a download_token or export_path were set at the creation these are infered, otherwise randomly generated.
 
-  my ($myconfig, $form) = @_;
-  $form->{abrechnungsnr} = "99";
-
-  $form->header;
-  print qq|
-  <html>
-  <body>Export in Bearbeitung<br>
-|;
-
-  my @filenames;
-
-  my $export_path = _get_export_path() . "/";
-  my $filename    = "ED00000";
-  my $evfile      = "EV01";
-  my @ed_versionset;
-  my $fileno          = 1;
-  my $i               = 0;
-  my $blockcount      = 1;
-  my $remaining_bytes = 256;
-  my $total_bytes     = 256;
-  my $buchungssatz    = "";
-  $filename++;
-  my $ed_filename = $export_path . $filename;
-  push(@filenames, $filename);
-  open(ED, ">", $ed_filename) or die "can't open outputfile: $!\n";
-  my $header = &make_kne_data_header($myconfig, $form, "");
-  $remaining_bytes -= length($header);
-
-  my $fuellzeichen;
-  our $fromto;
-
-  # connect to database
-  my $dbh = $form->dbconnect($myconfig);
-
-  my (@where, @values) = ((), ());
-  if ($form->{accnofrom}) {
-    push @where, 'c.accno >= ?';
-    push @values, $form->{accnofrom};
-  }
-  if ($form->{accnoto}) {
-    push @where, 'c.accno <= ?';
-    push @values, $form->{accnoto};
-  }
+=item filenames
 
-  my $where_str = @where ? ' WHERE ' . join(' AND ', map { "($_)" } @where) : '';
+Returns a list of filenames generated by this DATEV object. This only works if the files were generated during its lifetime, not if the object was created from a download_token.
 
-  my $query     = qq|SELECT c.accno, c.description
-                     FROM chart c
-                     $where_str
-                     ORDER BY c.accno|;
+=item net_gross_differences
 
-  my $sth = $dbh->prepare($query);
-  $sth->execute(@values) || $form->dberror($query);
+If there were any net gross differences during calculation they will be collected here.
 
-  while (my $ref = $sth->fetchrow_hashref("NAME_lc")) {
-    if (($remaining_bytes - length("t" . $ref->{'accno'})) <= 6) {
-      $fuellzeichen = ($blockcount * 256 - length($buchungssatz . $header));
-      $buchungssatz .= "\x00" x $fuellzeichen;
-      $blockcount++;
-      $total_bytes = ($blockcount) * 256;
-    }
-    $buchungssatz .= "t" . $ref->{'accno'};
-    $remaining_bytes = $total_bytes - length($buchungssatz . $header);
-    $ref->{'description'} =~ s/[^0-9A-Za-z\$\%\&\*\+\-\/]//g;
-    $ref->{'description'} = substr($ref->{'description'}, 0, 40);
-    $ref->{'description'} =~ s/\ *$//;
-
-    if (
-        ($remaining_bytes - length("\x1E" . $ref->{'description'} . "\x1C\x79")
-        ) <= 6
-      ) {
-      $fuellzeichen = ($blockcount * 256 - length($buchungssatz . $header));
-      $buchungssatz .= "\x00" x $fuellzeichen;
-      $blockcount++;
-      $total_bytes = ($blockcount) * 256;
-    }
-    $buchungssatz .= "\x1E" . $ref->{'description'} . "\x1C\x79";
-    $remaining_bytes = $total_bytes - length($buchungssatz . $header);
-  }
+=item sum_net_gross_differences
 
-  $sth->finish;
-  print(ED $header);
-  print(ED $buchungssatz);
-  $fuellzeichen = 256 - (length($header . $buchungssatz . "z") % 256);
-  my $dateiende = "\x00" x $fuellzeichen;
-  print(ED "z");
-  print(ED $dateiende);
-  close(ED);
-
-  #Make EV Verwaltungsdatei
-  $ed_versionset[0] =
-    &make_ed_versionset($header, $filename, $blockcount, $fromto);
-
-  my $ev_header = &make_ev_header($form, $fileno);
-  my $ev_filename = $export_path . $evfile;
-  push(@filenames, $evfile);
-  open(EV, ">", $ev_filename) or die "can't open outputfile: EV01\n";
-  print(EV $ev_header);
-
-  foreach my $file (@ed_versionset) {
-    print(EV $ed_versionset[$file]);
-  }
-  close(EV);
+Sum of all differences.
 
-  $dbh->disconnect;
-  ###
+=item clean_temporary_directories
 
-  print qq|<br>Done. <br>
-|;
+Forces a garbage collection on previous exports which will delete all exports that are older than 8 hours. It will be automatically called on destruction of the object, but is advised to be called manually before delivering results of an export to the user.
 
-  $main::lxdebug->leave_sub();
+=item errors
 
-  return { 'download_token' => get_download_token_for_path($export_path), 'filenames' => \@filenames };
-}
+Returns a list of errors that occurred. If no errors occurred, the export was a success.
 
-1;
+=item export
+
+Exports data. You have to have set L<exporttype> and L<format> or an error will
+occur. OBE exports are currently not implemented.
+
+=item csv_export_for_tax_accountant
+
+Generates up to four downloadable csv files containing data about sales and
+purchase invoices, and their respective payments:
+
+Example:
+  my $startdate = DateTime->new(year => 2012, month =>  1, day =>  1);
+  my $enddate   = DateTime->new(year => 2012, month => 12, day => 31);
+  SL::DATEV->new(from => $startdate, to => $enddate)->csv_export_for_tax_accountant;
+  # {
+  #   'download_token' => '1488551625-815654-22430',
+  #   'filenames' => [
+  #                    'Zahlungen Kreditorenbuchungen 2012-01-01 - 2012-12-31.csv',
+  #                    'Kreditorenbuchungen 2012-01-01 - 2012-12-31.csv',
+  #                    'Zahlungen Debitorenbuchungen 2012-01-01 - 2012-12-31.csv',
+  #                    'Debitorenbuchungen 2012-01-01 - 2012-12-31.csv'
+  #                  ]
+  # };
+
+
+=item check_vcnumbers_are_valid_pk_numbers
+
+Returns 1 if all vcnumbers are suitable for the DATEV export, 0 if not.
+
+Finds the default length of charts (e.g. 4), adds 1 for the pk chart length
+(e.g. 5), and checks the database for any customers or vendors whose customer-
+or vendornumber doesn't consist of only numbers with exactly that length. E.g.
+for a chart length of four "10001" would be ok, but not "10001b" or "1000".
+
+All vcnumbers are checked, obsolete customers or vendors aren't exempt.
+
+There is also no check for the typical customer range 10000-69999 and the
+typical vendor range 70000-99999.
+
+=item check_valid_length_of_accounts
+
+Returns 1 if all currently booked accounts have only one common number length domain (e.g. 4 or 6).
+Will throw an error if more than one distinct size is detected.
+The error message gives a short hint with the value of the (at least)
+two mismatching number length domains.
+
+=back
+
+=head1 ATTRIBUTES
+
+This is a list of attributes set in either the C<new> or a method of the same name.
+
+=over 4
+
+=item dbh
+
+Set a database handle to use in the process. This allows for an export to be
+done on a transaction in progress without committing first.
+
+Note: If you don't want this code to commit, simply providing a dbh is not
+enough enymore. You'll have to wrap the call into a transaction yourself, so
+that the internal transaction does not commit.
+
+=item exporttype
+
+See L<CONSTANTS> for possible values. This MUST be set before export is called.
+
+=item format
+
+See L<CONSTANTS> for possible values. This MUST be set before export is called.
+
+=item download_token
+
+Can be set on creation to retrieve a prior export for download.
+
+=item from
+
+=item to
+
+Set boundary dates for the export. Unless a trans_id is passed these MUST be
+set for the export to work.
+
+=item trans_id
+
+To check only one gl/ar/ap transaction, pass the trans_id. The attributes
+L<from> and L<to> are currently still needed for the query to be assembled
+correctly.
+
+=item accnofrom
+
+=item accnoto
+
+Set boundary account numbers for the export. Only useful for a stammdaten export.
+
+=item locked
+
+Boolean if the transactions are locked (read-only in kivitenod) or not.
+Default value is false
+
+=back
+
+=head1 CONSTANTS
+
+=head2 Supplied to L<exporttype>
+
+=over 4
+
+=item DATEV_ET_BUCHUNGEN
+
+=item DATEV_ET_STAMM
+
+=back
+
+=head2 Supplied to L<format>.
+
+=over 4
+
+=item DATEV_FORMAT_KNE
+
+=item DATEV_FORMAT_OBE
+
+=back
+
+=head1 ERROR HANDLING
+
+This module will die in the following cases:
+
+=over 4
+
+=item *
+
+No or unrecognized exporttype or format was provided for an export
+
+=item *
+
+OBE export was called, which is not yet implemented.
+
+=item *
+
+general I/O errors
+
+=back
+
+Errors that occur during th actual export will be collected in L<errors>. The following types can occur at the moment:
+
+=over 4
+
+=item *
+
+C<Unbalanced Ledger!>. Exactly that, your ledger is unbalanced. Should never occur.
+
+=item *
+
+C<Datev-Export fehlgeschlagen! Bei Transaktion %d (%f).>  This error occurs if a
+transaction could not be reliably sorted out, or had rounding errors above the acceptable threshold.
+
+=back
+
+=head1 BUGS AND CAVEATS
+
+=over 4
+
+=item *
+
+Handling of Vollvorlauf is currently not fully implemented. You must provide both from and to in order to get a working export.
+
+=item *
+
+OBE export is currently not implemented.
+
+=back
+
+=head1 TODO
+
+- handling of export_path and download token is a bit dodgy, clean that up.
+
+=head1 SEE ALSO
+
+L<SL::DATEV::KNEFile>
+L<SL::DATEV::CSV>
+
+=head1 AUTHORS
+
+Philip Reetz E<lt>p.reetz@linet-services.deE<gt>,
+
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
+
+Jan Büren E<lt>jan@lx-office-hosting.deE<gt>,
+
+Geoffrey Richardson E<lt>information@lx-office-hosting.deE<gt>,
+
+Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>,
+
+Stephan Köhler
+
+=cut