+
+__END__
+
+=encoding utf-8
+
+=head1 NAME
+
+SL::DATEV - kivitendo DATEV Export module
+
+=head1 SYNOPSIS
+
+ use SL::DATEV qw(:CONSTANTS);
+
+ 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,
+ );
+
+ # 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,
+ );
+
+ my $datev = SL::DATEV->new(
+ exporttype => DATEV_ET_STAMM,
+ format => DATEV_FORMAT_KNE,
+ accnofrom => $start_account_number,
+ accnoto => $end_account_number,
+ );
+
+ # 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;
+ }
+
+ # get relevant data for saving the export:
+ my $dl_token = $datev->download_token;
+ my $path = $datev->export_path;
+ my @files = $datev->filenames;
+
+ # retrieving an export at a later time
+ my $datev = SL::DATEV->new(
+ download_token => $dl_token_from_user,
+ );
+
+ my $path = $datev->export_path;
+ my @files = glob("$path/*");
+
+=head1 DESCRIPTION
+
+This module implements the DATEV export standard. For usage see above.
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item new PARAMS
+
+Generic constructor. See section attributes for information about what to pass.
+
+=item get_datev_stamm
+
+Loads DATEV Stammdaten and returns as hashref.
+
+=item save_datev_stamm HASHREF
+
+Saves DATEV Stammdaten from provided hashref.
+
+=item exporttype
+
+See L<CONSTANTS> for possible values
+
+=item has_exporttype
+
+Returns true if an exporttype has been set. Without exporttype most report functions won't work.
+
+=item format
+
+Specifies the designated format of the export. Currently only KNE export is implemented.
+
+See L<CONSTANTS> for possible values
+
+=item has_format
+
+Returns true if a format has been set. Without format most report functions won't work.
+
+=item download_token
+
+Returns a download token for this DATEV object.
+
+Note: If either a download_token or export_path were set at the creation these are infered, otherwise randomly generated.
+
+=item export_path
+
+Returns an export_path for this DATEV object.
+
+Note: If either a download_token or export_path were set at the creation these are infered, otherwise randomly generated.
+
+=item filenames
+
+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.
+
+=item net_gross_differences
+
+If there were any net gross differences during calculation they will be collected here.
+
+=item sum_net_gross_differences
+
+Sum of all differences.
+
+=item clean_temporary_directories
+
+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.
+
+=item errors
+
+Returns a list of errors that occured. If no errors occured, the export was a success.
+
+=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.
+
+=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.
+
+=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.
+
+=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>
+
+=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
projects / mfinanz.git / blobdiff