Projekt

Allgemein

Profil

Herunterladen (31,1 KB) Statistiken
| Zweig: | Markierung: | Revision:

kivitendo/SL/DB/Helper/ZUGFeRD.pm @ 203f9e93

cf0455f5 Moritz Bunkus
package SL::DB::Helper::ZUGFeRD;

use strict;
use utf8;

use parent qw(Exporter);
edb6e61e Tamino Steinert
our @EXPORT_CREATE = qw(create_zugferd_data create_zugferd_xmp_data);
dec0e491 Tamino Steinert
our @EXPORT_IMPORT = qw(import_zugferd_data);
edb6e61e Tamino Steinert
our @EXPORT_OK = (@EXPORT_CREATE, @EXPORT_IMPORT);
our %EXPORT_TAGS = (
ALL => (@EXPORT_CREATE, @EXPORT_IMPORT),
CREATE => \@EXPORT_CREATE,
IMPORT => \@EXPORT_IMPORT,
);
cf0455f5 Moritz Bunkus
b24dfcbb Moritz Bunkus
use SL::DB::BankAccount;
e5f53eb5 Moritz Bunkus
use SL::DB::GenericTranslation;
dec0e491 Tamino Steinert
use SL::DB::Chart;
cf0455f5 Moritz Bunkus
use SL::DB::Tax;
use SL::DB::TaxKey;
edb6e61e Tamino Steinert
use SL::DB::RecordTemplate;
cf0455f5 Moritz Bunkus
use SL::Helper::ISO3166;
use SL::Helper::ISO4217;
use SL::Helper::UNECERecommendation20;
82fa9647 Moritz Bunkus
use SL::VATIDNr;
ba40069b Moritz Bunkus
use SL::ZUGFeRD qw(:PROFILES);
abc52ab5 Tamino Steinert
use SL::Locale::String qw(t8);
cf0455f5 Moritz Bunkus
231ea4d9 Tamino Steinert
use SL::Controller::ZUGFeRD;

cf0455f5 Moritz Bunkus
use Carp;
use Encode qw(encode);
333003d3 Moritz Bunkus
use List::MoreUtils qw(any pairwise);
e5f53eb5 Moritz Bunkus
use List::Util qw(first sum);
cf0455f5 Moritz Bunkus
use Template;
use XML::Writer;
ba8675f5 Tamino Steinert
use Params::Validate qw(:all);
cf0455f5 Moritz Bunkus
my @line_names = qw(LineOne LineTwo LineThree);

ba40069b Moritz Bunkus
my %standards_ids = (
PROFILE_FACTURX_EXTENDED() => 'urn:cen.eu:en16931:2017#conformant#urn:factur-x.eu:1p0:extended',
e2f0105f Moritz Bunkus
PROFILE_XRECHNUNG() => 'urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.0',
);

ba40069b Moritz Bunkus
sub _is_profile {
my ($self, @profiles) = @_;
return any { $self->{_zugferd}->{profile} == $_ } @profiles;
}

cf0455f5 Moritz Bunkus
sub _u8 {
my ($value) = @_;
return encode('UTF-8', $value // '');
}

sub _r2 {
my ($value) = @_;
return $::form->round_amount($value, 2);
}

sub _type_name {
my ($self) = @_;
my $type = $self->invoice_type;

no warnings 'once';
return $type eq 'ar_transaction' ? $::locale->text('Invoice') : $self->displayable_type;
}

sub _type_code {
my ($self) = @_;
my $type = $self->invoice_type;

# 326 (Partial invoice)
# 380 (Commercial invoice)
# 384 (Corrected Invoice)
# 381 (Credit note)
# 389 (Credit note, self billed invoice)

b7c38d99 Moritz Bunkus
return $type eq 'credit_note' ? 381
: $type eq 'invoice_storno' ? 457
: $type eq 'credit_note_storno' ? 458
: 380;
cf0455f5 Moritz Bunkus
}

sub _unit_code {
my ($unit) = @_;

# Mapping from kivitendo's units to UN/ECE Recommendation 20 & 21.
my $code = SL::Helper::UNECERecommendation20::map_name_to_code($unit);
return $code if $code;

$::lxdebug->message(LXDebug::WARN(), "ZUGFeRD unit name mapping: no UN/ECE Recommendation 20/21 unit known for kivitendo unit '$unit'; using 'C62'");

return 'C62';
}

sub _parse_our_address {
my @result;
my @street = grep { $_ } ($::instance_conf->get_address_street1, $::instance_conf->get_address_street2);

push @result, [ 'PostcodeCode', $::instance_conf->get_address_zipcode ] if $::instance_conf->get_address_zipcode;
push @result, grep { $_->[1] } pairwise { [ $a, $b] } @line_names, @street;
push @result, [ 'CityName', $::instance_conf->get_address_city ] if $::instance_conf->get_address_city;
push @result, [ 'CountryID', SL::Helper::ISO3166::map_name_to_alpha_2_code($::instance_conf->get_address_country) // 'DE' ];

return @result;
}

sub _customer_postal_trade_address {
my (%params) = @_;

# <ram:PostalTradeAddress>
$params{xml}->startTag("ram:PostalTradeAddress");

my @parts = grep { $_ } map { $params{customer}->$_ } qw(department_1 department_2 street);

$params{xml}->dataElement("ram:PostcodeCode", _u8($params{customer}->zipcode));
$params{xml}->dataElement("ram:" . $_->[0], _u8($_->[1])) for grep { $_->[1] } pairwise { [ $a, $b] } @line_names, @parts;
$params{xml}->dataElement("ram:CityName", _u8($params{customer}->city));
$params{xml}->dataElement("ram:CountryID", _u8(SL::Helper::ISO3166::map_name_to_alpha_2_code($params{customer}->country) // 'DE'));
$params{xml}->endTag;
# </ram:PostalTradeAddress>
}

sub _tax_rate_and_code {
my ($taxzone, $tax) = @_;

my ($tax_rate, $tax_code) = @_;

if ($taxzone->description =~ m{Au.*erhalb}) {
$tax_rate = 0;
$tax_code = 'G';

} elsif ($taxzone->description =~ m{EU mit}) {
$tax_rate = 0;
$tax_code = 'K';

} else {
$tax_rate = $tax->rate * 100;
$tax_code = !$tax_rate ? 'Z' : 'S';
}

return (rate => $tax_rate, code => $tax_code);
}

sub _line_item {
my ($self, %params) = @_;

my $item_ptc = $params{ptc_data}->{items}->[$params{line_number}];

my $taxkey = $item_ptc->{taxkey_id} ? SL::DB::TaxKey->load_cached($item_ptc->{taxkey_id}) : undef;
my $tax = $item_ptc->{taxkey_id} ? SL::DB::Tax->load_cached($taxkey->tax_id) : undef;
my %tax_info = _tax_rate_and_code($self->taxzone, $tax);

# <ram:IncludedSupplyChainTradeLineItem>
$params{xml}->startTag("ram:IncludedSupplyChainTradeLineItem");

# <ram:AssociatedDocumentLineDocument>
$params{xml}->startTag("ram:AssociatedDocumentLineDocument");
$params{xml}->dataElement("ram:LineID", $params{line_number} + 1);
$params{xml}->endTag;

$params{xml}->startTag("ram:SpecifiedTradeProduct");
$params{xml}->dataElement("ram:SellerAssignedID", _u8($params{item}->part->partnumber));
$params{xml}->dataElement("ram:Name", _u8($params{item}->description));
$params{xml}->endTag;

$params{xml}->startTag("ram:SpecifiedLineTradeAgreement");
$params{xml}->startTag("ram:NetPriceProductTradePrice");
$params{xml}->dataElement("ram:ChargeAmount", _r2($item_ptc->{sellprice}));
$params{xml}->endTag;
$params{xml}->endTag;
# </ram:SpecifiedLineTradeAgreement>

# <ram:SpecifiedLineTradeDelivery>
$params{xml}->startTag("ram:SpecifiedLineTradeDelivery");
59b1c4c2 Moritz Bunkus
$params{xml}->dataElement("ram:BilledQuantity", $params{item}->qty, unitCode => _unit_code($params{item}->unit));
cf0455f5 Moritz Bunkus
$params{xml}->endTag;
# </ram:SpecifiedLineTradeDelivery>

# <ram:SpecifiedLineTradeSettlement>
$params{xml}->startTag("ram:SpecifiedLineTradeSettlement");

# <ram:ApplicableTradeTax>
$params{xml}->startTag("ram:ApplicableTradeTax");
$params{xml}->dataElement("ram:TypeCode", "VAT");
$params{xml}->dataElement("ram:CategoryCode", $tax_info{code});
$params{xml}->dataElement("ram:RateApplicablePercent", _r2($tax_info{rate}));
$params{xml}->endTag;
# </ram:ApplicableTradeTax>

# <ram:SpecifiedTradeSettlementLineMonetarySummation>
$params{xml}->startTag("ram:SpecifiedTradeSettlementLineMonetarySummation");
$params{xml}->dataElement("ram:LineTotalAmount", _r2($item_ptc->{linetotal}));
$params{xml}->endTag;
# </ram:SpecifiedTradeSettlementLineMonetarySummation>

$params{xml}->endTag;
# </ram:SpecifiedLineTradeSettlement>

$params{xml}->endTag;
# <ram:IncludedSupplyChainTradeLineItem>
}

b24dfcbb Moritz Bunkus
sub _specified_trade_settlement_payment_means {
my ($self, %params) = @_;

# <ram:SpecifiedTradeSettlementPaymentMeans>
$params{xml}->startTag('ram:SpecifiedTradeSettlementPaymentMeans');
$params{xml}->dataElement('ram:TypeCode', $self->direct_debit ? 59 : 58); # 59 = SEPA direct debit, 58 = SEPA credit transfer

if ($self->direct_debit) {
$params{xml}->startTag('ram:PayerPartyDebtorFinancialAccount');
$params{xml}->dataElement('ram:IBANID', $self->customer->iban);
$params{xml}->endTag;

} else {
$params{xml}->startTag('ram:PayeePartyCreditorFinancialAccount');
$params{xml}->dataElement('ram:IBANID', $params{bank_account}->iban);
$params{xml}->endTag;
}

$params{xml}->endTag;
# </ram:SpecifiedTradeSettlementPaymentMeans>
}

cf0455f5 Moritz Bunkus
sub _taxes {
my ($self, %params) = @_;

my %taxkey_info;

foreach my $item (@{ $params{ptc_data}->{items} }) {
$taxkey_info{$item->{taxkey_id}} //= {
linetotal => 0,
tax_amount => 0,
};
my $info = $taxkey_info{$item->{taxkey_id}};
$info->{taxkey} //= SL::DB::TaxKey->load_cached($item->{taxkey_id});
$info->{tax} //= SL::DB::Tax->load_cached($info->{taxkey}->tax_id);
$info->{linetotal} += $item->{linetotal};
}

foreach my $taxkey_id (sort keys %taxkey_info) {
my $info = $taxkey_info{$taxkey_id};
my %tax_info = _tax_rate_and_code($self->taxzone, $info->{tax});

# <ram:ApplicableTradeTax>
$params{xml}->startTag("ram:ApplicableTradeTax");
b3089c09 Bernd Bleßmann
$params{xml}->dataElement("ram:CalculatedAmount", _r2($params{ptc_data}->{taxes_by_tax_id}->{$info->{taxkey}->tax_id}));
cf0455f5 Moritz Bunkus
$params{xml}->dataElement("ram:TypeCode", "VAT");
$params{xml}->dataElement("ram:BasisAmount", _r2($info->{linetotal}));
$params{xml}->dataElement("ram:CategoryCode", $tax_info{code});
$params{xml}->dataElement("ram:RateApplicablePercent", _r2($tax_info{rate}));
$params{xml}->endTag;
# </ram:ApplicableTradeTax>
}
}

34d54675 Moritz Bunkus
sub _calculate_payment_terms_values {
cf0455f5 Moritz Bunkus
my ($self) = @_;

my (%vars, %amounts, %formatted_amounts);

local $::myconfig{numberformat} = $::myconfig{numberformat};
local $::myconfig{dateformat} = $::myconfig{dateformat};

if ($self->language_id) {
my $language = SL::DB::Language->load_cached($self->language_id);
$::myconfig{dateformat} = $language->output_dateformat if $language->output_dateformat;
$::myconfig{numberformat} = $language->output_numberformat if $language->output_numberformat;
}

$vars{currency} = $self->currency->name if $self->currency;
$vars{$_} = $self->customer->$_ for qw(account_number bank bank_code bic iban mandate_date_of_signature mandator_id);
$vars{$_} = $self->payment_terms->$_ for qw(terms_netto terms_skonto percent_skonto);
$vars{payment_description} = $self->payment_terms->description;
$vars{netto_date} = $self->payment_terms->calc_date(reference_date => $self->transdate, due_date => $self->duedate, terms => 'net')->to_kivitendo;
$vars{skonto_date} = $self->payment_terms->calc_date(reference_date => $self->transdate, due_date => $self->duedate, terms => 'discount')->to_kivitendo;

$amounts{invtotal} = $self->amount;
$amounts{total} = $self->amount - $self->paid;

$amounts{skonto_in_percent} = 100.0 * $vars{percent_skonto};
$amounts{skonto_amount} = $amounts{invtotal} * $vars{percent_skonto};
$amounts{invtotal_wo_skonto} = $amounts{invtotal} * (1 - $vars{percent_skonto});
$amounts{total_wo_skonto} = $amounts{total} * (1 - $vars{percent_skonto});

foreach (keys %amounts) {
$amounts{$_} = $::form->round_amount($amounts{$_}, 2);
$formatted_amounts{$_} = $::form->format_amount(\%::myconfig, $amounts{$_}, 2);
}

34d54675 Moritz Bunkus
return (
vars => \%vars,
amounts => \%amounts,
formatted_amounts => \%formatted_amounts,
);
}

sub _format_payment_terms_description {
my ($self, %params) = @_;

cf0455f5 Moritz Bunkus
my $description = ($self->payment_terms->translated_attribute('description_long_invoice', $self->language_id) // '') || $self->payment_terms->description_long_invoice;
34d54675 Moritz Bunkus
$description =~ s{<\%$_\%>}{ $params{vars}->{$_} }ge for keys %{ $params{vars} };
$description =~ s{<\%$_\%>}{ $params{formatted_amounts}->{$_} }ge for keys %{ $params{formatted_amounts} };
cf0455f5 Moritz Bunkus
e2f0105f Moritz Bunkus
if (_is_profile($self, PROFILE_XRECHNUNG())) {
my @terms;

if ($self->payment_terms->terms_skonto && ($self->payment_terms->percent_skonto * 1)) {
push @terms, sprintf("#SKONTO#TAGE=\%d#PROZENT=\%.2f#\n", $self->payment_terms->terms_skonto, $self->payment_terms->percent_skonto * 100);
}

$description =~ s{#}{_}g;
$description = join('', @terms) . $description;
}

cf0455f5 Moritz Bunkus
return $description;
}

sub _payment_terms {
my ($self, %params) = @_;

return unless $self->payment_terms;

34d54675 Moritz Bunkus
my %payment_terms_vars = _calculate_payment_terms_values($self);

cf0455f5 Moritz Bunkus
# <ram:SpecifiedTradePaymentTerms>
$params{xml}->startTag("ram:SpecifiedTradePaymentTerms");

34d54675 Moritz Bunkus
$params{xml}->dataElement("ram:Description", _u8(_format_payment_terms_description($self, %payment_terms_vars)));
cf0455f5 Moritz Bunkus
# <ram:DueDateDateTime>
$params{xml}->startTag("ram:DueDateDateTime");
59b1c4c2 Moritz Bunkus
$params{xml}->dataElement("udt:DateTimeString", $self->duedate->strftime('%Y%m%d'), format => "102");
cf0455f5 Moritz Bunkus
$params{xml}->endTag;
# </ram:DueDateDateTime>

e2f0105f Moritz Bunkus
if ( _is_profile($self, PROFILE_FACTURX_EXTENDED())
&& $self->payment_terms->percent_skonto
&& $self->payment_terms->terms_skonto) {
34d54675 Moritz Bunkus
my $currency_id = _u8(SL::Helper::ISO4217::map_currency_name_to_code($self->currency->name) // 'EUR');

cf0455f5 Moritz Bunkus
# <ram:ApplicableTradePaymentDiscountTerms>
$params{xml}->startTag("ram:ApplicableTradePaymentDiscountTerms");
59b1c4c2 Moritz Bunkus
$params{xml}->dataElement("ram:BasisPeriodMeasure", $self->payment_terms->terms_skonto, unitCode => "DAY");
34d54675 Moritz Bunkus
$params{xml}->dataElement("ram:BasisAmount", _r2($payment_terms_vars{amounts}->{invtotal}), currencyID => $currency_id);
cf0455f5 Moritz Bunkus
$params{xml}->dataElement("ram:CalculationPercent", _r2($self->payment_terms->percent_skonto * 100));
$params{xml}->endTag;
# </ram:ApplicableTradePaymentDiscountTerms>
}

$params{xml}->endTag;
# </ram:SpecifiedTradePaymentTerms>
}

sub _totals {
my ($self, %params) = @_;

# <ram:SpecifiedTradeSettlementHeaderMonetarySummation>
$params{xml}->startTag("ram:SpecifiedTradeSettlementHeaderMonetarySummation");

$params{xml}->dataElement("ram:LineTotalAmount", _r2($self->netamount));
$params{xml}->dataElement("ram:TaxBasisTotalAmount", _r2($self->netamount));
5b6abfd0 Moritz Bunkus
$params{xml}->dataElement("ram:TaxTotalAmount", _r2(sum(values %{ $params{ptc_data}->{taxes_by_tax_id} })), currencyID => "EUR");
cf0455f5 Moritz Bunkus
$params{xml}->dataElement("ram:GrandTotalAmount", _r2($self->amount));
$params{xml}->dataElement("ram:TotalPrepaidAmount", _r2($self->paid));
$params{xml}->dataElement("ram:DuePayableAmount", _r2($self->amount - $self->paid));

$params{xml}->endTag;
# </ram:SpecifiedTradeSettlementHeaderMonetarySummation>
}

sub _exchanged_document_context {
my ($self, %params) = @_;

# <rsm:ExchangedDocumentContext>
$params{xml}->startTag("rsm:ExchangedDocumentContext");
53a350d9 Moritz Bunkus
ba40069b Moritz Bunkus
if ($self->{_zugferd}->{test_mode}) {
53a350d9 Moritz Bunkus
$params{xml}->startTag("ram:TestIndicator");
$params{xml}->dataElement("udt:Indicator", "true");
$params{xml}->endTag;
}
cf0455f5 Moritz Bunkus
$params{xml}->startTag("ram:GuidelineSpecifiedDocumentContextParameter");
ba40069b Moritz Bunkus
$params{xml}->dataElement("ram:ID", $standards_ids{ $self->{_zugferd}->{profile} });
cf0455f5 Moritz Bunkus
$params{xml}->endTag;
$params{xml}->endTag;
# </rsm:ExchangedDocumentContext>
}

e5f53eb5 Moritz Bunkus
sub _included_note {
my ($self, %params) = @_;

$params{xml}->startTag("ram:IncludedNote");
$params{xml}->dataElement("ram:Content", _u8($params{note}));
$params{xml}->endTag;
}

cf0455f5 Moritz Bunkus
sub _exchanged_document {
my ($self, %params) = @_;

# <rsm:ExchangedDocument>
$params{xml}->startTag("rsm:ExchangedDocument");

$params{xml}->dataElement("ram:ID", _u8($self->invnumber));
e2f0105f Moritz Bunkus
$params{xml}->dataElement("ram:Name", _u8(_type_name($self))) if _is_profile($self, PROFILE_FACTURX_EXTENDED());
cf0455f5 Moritz Bunkus
$params{xml}->dataElement("ram:TypeCode", _u8(_type_code($self)));

# <ram:IssueDateTime>
$params{xml}->startTag("ram:IssueDateTime");
59b1c4c2 Moritz Bunkus
$params{xml}->dataElement("udt:DateTimeString", $self->transdate->strftime('%Y%m%d'), format => "102");
cf0455f5 Moritz Bunkus
$params{xml}->endTag;
# </ram:IssueDateTime>

e2f0105f Moritz Bunkus
if ( _is_profile($self, PROFILE_FACTURX_EXTENDED())
&& $self->language
&& (($self->language->template_code // '') =~ m{^(de|en)}i)) {
cf0455f5 Moritz Bunkus
$params{xml}->dataElement("ram:LanguageID", uc($1));
}

e5f53eb5 Moritz Bunkus
my $std_notes = SL::DB::Manager::GenericTranslation->get_all(
where => [
translation_type => 'ZUGFeRD/notes',
or => [
language_id => undef,
language_id => $self->language_id,
],
'!translation' => undef,
'!translation' => '',
],
);

my $std_note = first { $_->language_id == $self->language_id } @{ $std_notes };
$std_note //= first { !defined $_->language_id } @{ $std_notes };
cf0455f5 Moritz Bunkus
my $notes = $self->notes_as_stripped_html;
e5f53eb5 Moritz Bunkus
_included_note($self, %params, note => $self->transaction_description) if $self->transaction_description;
_included_note($self, %params, note => $notes) if $notes;
_included_note($self, %params, note => $std_note->translation) if $std_note;
cf0455f5 Moritz Bunkus
$params{xml}->endTag;
# </rsm:ExchangedDocument>
}

27e9e34d Moritz Bunkus
sub _specified_tax_registration {
my ($ustid_nr, %params) = @_;

# <ram:SpecifiedTaxRegistration>
$params{xml}->startTag("ram:SpecifiedTaxRegistration");
82fa9647 Moritz Bunkus
$params{xml}->dataElement("ram:ID", _u8(SL::VATIDNr->normalize($ustid_nr)), schemeID => "VA");
27e9e34d Moritz Bunkus
$params{xml}->endTag;
# </ram:SpecifiedTaxRegistration>
}

cf0455f5 Moritz Bunkus
sub _seller_trade_party {
my ($self, %params) = @_;

my @our_address = _parse_our_address();

my $sales_person = $self->salesman;
my $sales_person_auth = SL::DB::Manager::AuthUser->find_by(login => $sales_person->login);
my %sales_person_cfg = $sales_person_auth ? %{ $sales_person_auth->config_values } : ();
$sales_person_cfg{email} ||= $sales_person->deleted_email;
$sales_person_cfg{tel} ||= $sales_person->deleted_tel;

# <ram:SellerTradeParty>
$params{xml}->startTag("ram:SellerTradeParty");
$params{xml}->dataElement("ram:ID", _u8($self->customer->c_vendor_id)) if ($self->customer->c_vendor_id // '') ne '';
$params{xml}->dataElement("ram:Name", _u8($::instance_conf->get_company));

# <ram:DefinedTradeContact>
$params{xml}->startTag("ram:DefinedTradeContact");

770cfea9 Moritz Bunkus
$params{xml}->dataElement("ram:PersonName", _u8($sales_person->safe_name));
cf0455f5 Moritz Bunkus
if ($sales_person_cfg{tel}) {
$params{xml}->startTag("ram:TelephoneUniversalCommunication");
$params{xml}->dataElement("ram:CompleteNumber", _u8($sales_person_cfg{tel}));
$params{xml}->endTag;
}

if ($sales_person_cfg{email}) {
$params{xml}->startTag("ram:EmailURIUniversalCommunication");
$params{xml}->dataElement("ram:URIID", _u8($sales_person_cfg{email}));
$params{xml}->endTag;
}

$params{xml}->endTag;
# </ram:DefinedTradeContact>

if (@our_address) {
# <ram:PostalTradeAddress>
$params{xml}->startTag("ram:PostalTradeAddress");
foreach my $element (@our_address) {
$params{xml}->dataElement("ram:" . $element->[0], _u8($element->[1]));
}
$params{xml}->endTag;
# </ram:PostalTradeAddress>
}

27e9e34d Moritz Bunkus
_specified_tax_registration($::instance_conf->get_co_ustid, %params);
cf0455f5 Moritz Bunkus
$params{xml}->endTag;
# </ram:SellerTradeParty>
}

sub _buyer_trade_party {
my ($self, %params) = @_;

# <ram:BuyerTradeParty>
$params{xml}->startTag("ram:BuyerTradeParty");
$params{xml}->dataElement("ram:ID", _u8($self->customer->customernumber));
$params{xml}->dataElement("ram:Name", _u8($self->customer->name));

_customer_postal_trade_address(%params, customer => $self->customer);
ec4cffa8 Moritz Bunkus
_specified_tax_registration($self->customer->ustid, %params) if $self->customer->ustid;
cf0455f5 Moritz Bunkus
$params{xml}->endTag;
# </ram:BuyerTradeParty>
}

sub _included_supply_chain_trade_line_item {
my ($self, %params) = @_;

my $line_number = 0;
foreach my $item (@{ $self->items }) {
_line_item($self, %params, item => $item, line_number => $line_number);
$line_number++;
}
}

sub _applicable_header_trade_agreement {
my ($self, %params) = @_;

# <ram:ApplicableHeaderTradeAgreement>
$params{xml}->startTag("ram:ApplicableHeaderTradeAgreement");

e2f0105f Moritz Bunkus
$params{xml}->dataElement("ram:BuyerReference", _u8($self->customer->c_vendor_routing_id)) if $self->customer->c_vendor_routing_id;

cf0455f5 Moritz Bunkus
_seller_trade_party($self, %params);
_buyer_trade_party($self, %params);

if ($self->cusordnumber) {
# <ram:BuyerOrderReferencedDocument>
$params{xml}->startTag("ram:BuyerOrderReferencedDocument");
$params{xml}->dataElement("ram:IssuerAssignedID", _u8($self->cusordnumber));
$params{xml}->endTag;
# </ram:BuyerOrderReferencedDocument>
}

$params{xml}->endTag;
# </ram:ApplicableHeaderTradeAgreement>
}

sub _applicable_header_trade_delivery {
my ($self, %params) = @_;

# <ram:ApplicableHeaderTradeDelivery>
$params{xml}->startTag("ram:ApplicableHeaderTradeDelivery");
# <ram:ActualDeliverySupplyChainEvent>
$params{xml}->startTag("ram:ActualDeliverySupplyChainEvent");

$params{xml}->startTag("ram:OccurrenceDateTime");
59b1c4c2 Moritz Bunkus
$params{xml}->dataElement("udt:DateTimeString", ($self->deliverydate // $self->transdate)->strftime('%Y%m%d'), format => "102");
cf0455f5 Moritz Bunkus
$params{xml}->endTag;

$params{xml}->endTag;
# </ram:ActualDeliverySupplyChainEvent>
$params{xml}->endTag;
# </ram:ApplicableHeaderTradeDelivery>
}

sub _applicable_header_trade_settlement {
my ($self, %params) = @_;

# <ram:ApplicableHeaderTradeSettlement>
$params{xml}->startTag("ram:ApplicableHeaderTradeSettlement");
$params{xml}->dataElement("ram:InvoiceCurrencyCode", _u8(SL::Helper::ISO4217::map_currency_name_to_code($self->currency->name) // 'EUR'));

b24dfcbb Moritz Bunkus
_specified_trade_settlement_payment_means($self, %params);
cf0455f5 Moritz Bunkus
_taxes($self, %params);
_payment_terms($self, %params);
_totals($self, %params);

$params{xml}->endTag;
# </ram:ApplicableHeaderTradeSettlement>
}

sub _supply_chain_trade_transaction {
my ($self, %params) = @_;

# <rsm:SupplyChainTradeTransaction>
$params{xml}->startTag("rsm:SupplyChainTradeTransaction");

_included_supply_chain_trade_line_item($self, %params);
_applicable_header_trade_agreement($self, %params);
_applicable_header_trade_delivery($self, %params);
_applicable_header_trade_settlement($self, %params);

$params{xml}->endTag;
# </rsm:SupplyChainTradeTransaction>
}

333003d3 Moritz Bunkus
sub _validate_data {
my ($self) = @_;

b24dfcbb Moritz Bunkus
my %result;
333003d3 Moritz Bunkus
my $prefix = $::locale->text('The ZUGFeRD invoice data cannot be generated because the data validation failed.') . ' ';

if (!$::instance_conf->get_co_ustid) {
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('The VAT registration number is missing in the client configuration.'));
}

82fa9647 Moritz Bunkus
if (!SL::VATIDNr->validate($::instance_conf->get_co_ustid)) {
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text("The VAT ID number in the client configuration is invalid."));
}

333003d3 Moritz Bunkus
if (!$::instance_conf->get_company || any { my $get = "get_address_$_"; !$::instance_conf->$get } qw(street1 zipcode city)) {
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('The company\'s address information is incomplete in the client configuration.'));
}

if ($::instance_conf->get_address_country && !SL::Helper::ISO3166::map_name_to_alpha_2_code($::instance_conf->get_address_country)) {
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('The country from the company\'s address in the client configuration cannot be mapped to an ISO 3166-1 alpha 2 code.'));
}

if ($self->customer->country && !SL::Helper::ISO3166::map_name_to_alpha_2_code($self->customer->country)) {
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('The country from the customer\'s address cannot be mapped to an ISO 3166-1 alpha 2 code.'));
}

if (!SL::Helper::ISO4217::map_currency_name_to_code($self->currency->name)) {
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('The currency "#1" cannot be mapped to an ISO 4217 currency code.', $self->currency->name));
}

my $failed_unit = first { !SL::Helper::UNECERecommendation20::map_name_to_code($_) } map { $_->unit } @{ $self->items };
if ($failed_unit) {
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('One of the units used (#1) cannot be mapped to a known unit code from the UN/ECE Recommendation 20 list.', $failed_unit));
}
b24dfcbb Moritz Bunkus
if ($self->direct_debit) {
if (!$self->customer->iban) {
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('The customer\'s bank account number (IBAN) is missing.'));
}

} else {
my $bank_accounts = SL::DB::Manager::BankAccount->get_all;
$result{bank_account} = scalar(@{ $bank_accounts }) == 1 ? $bank_accounts->[0] : first { $_->use_for_zugferd } @{ $bank_accounts };

if (!$result{bank_account}) {
ba40069b Moritz Bunkus
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('No bank account flagged for Factur-X/ZUGFeRD usage was found.'));
b24dfcbb Moritz Bunkus
}
}

e2f0105f Moritz Bunkus
if (_is_profile($self, PROFILE_XRECHNUNG())) {
if (!$self->customer->c_vendor_routing_id) {
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('The value \'our routing id at customer\' must be set in the customer\'s master data for profile #1.', 'XRechnung 2.0'));
}
}

b24dfcbb Moritz Bunkus
return %result;
333003d3 Moritz Bunkus
}

cf0455f5 Moritz Bunkus
sub create_zugferd_data {
b24dfcbb Moritz Bunkus
my ($self) = @_;
ba40069b Moritz Bunkus
$self->{_zugferd} = { SL::ZUGFeRD->convert_customer_setting($self->customer->create_zugferd_invoices_for_this_customer) };

if (!$standards_ids{ $self->{_zugferd}->{profile} }) {
croak "Profile '" . $self->{_zugferd}->{profile} . "' is not supported";
}
cf0455f5 Moritz Bunkus
b24dfcbb Moritz Bunkus
my $output = '';
333003d3 Moritz Bunkus
b24dfcbb Moritz Bunkus
my %params = _validate_data($self);
$params{ptc_data} = { $self->calculate_prices_and_taxes };
$params{xml} = XML::Writer->new(
OUTPUT => \$output,
DATA_MODE => 1,
DATA_INDENT => 2,
ENCODING => 'utf-8',
cf0455f5 Moritz Bunkus
);

b24dfcbb Moritz Bunkus
$params{xml}->xmlDecl();
cf0455f5 Moritz Bunkus
# <rsm:CrossIndustryInvoice>
b24dfcbb Moritz Bunkus
$params{xml}->startTag("rsm:CrossIndustryInvoice",
"xmlns:a" => "urn:un:unece:uncefact:data:standard:QualifiedDataType:100",
"xmlns:rsm" => "urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100",
"xmlns:qdt" => "urn:un:unece:uncefact:data:standard:QualifiedDataType:10",
"xmlns:ram" => "urn:un:unece:uncefact:data:standard:ReusableAggregateBusinessInformationEntity:100",
"xmlns:xs" => "http://www.w3.org/2001/XMLSchema",
"xmlns:udt" => "urn:un:unece:uncefact:data:standard:UnqualifiedDataType:100");
cf0455f5 Moritz Bunkus
_exchanged_document_context($self, %params);
_exchanged_document($self, %params);
_supply_chain_trade_transaction($self, %params);

b24dfcbb Moritz Bunkus
$params{xml}->endTag;
cf0455f5 Moritz Bunkus
# </rsm:CrossIndustryInvoice>

return $output;
}

sub create_zugferd_xmp_data {
my ($self) = @_;

return {
conformance_level => 'EXTENDED',
ba40069b Moritz Bunkus
document_file_name => 'factur-x.xml',
cf0455f5 Moritz Bunkus
document_type => 'INVOICE',
version => '1.0',
};
}

231ea4d9 Tamino Steinert
sub import_zugferd_data {
ba8675f5 Tamino Steinert
my ($self, $zugferd_parser) = @_;
validate_pos(@_,
{
isa => 'SL::DB::PurchaseInvoice',
},
{
# document class of SL::XMLInvoice
can => qw(metadata items)
}
);
231ea4d9 Tamino Steinert
ba8675f5 Tamino Steinert
my %metadata = %{$zugferd_parser->metadata};
my @items = @{$zugferd_parser->items};
231ea4d9 Tamino Steinert
dec0e491 Tamino Steinert
my $intnotes = t8("ZUGFeRD Import. Type: #1", $metadata{'type'})->translated;
231ea4d9 Tamino Steinert
my $iban = $metadata{'iban'};
my $invnumber = $metadata{'invnumber'};

if ( ! ($metadata{'ustid'} or $metadata{'taxnumber'}) ) {
die t8("Cannot process this invoice: neither VAT ID nor tax ID present.");
edb6e61e Tamino Steinert
}

231ea4d9 Tamino Steinert
my $vendor = SL::Controller::ZUGFeRD::find_vendor($metadata{'ustid'}, $metadata{'taxnumber'});
edb6e61e Tamino Steinert
231ea4d9 Tamino Steinert
die t8("Vendor with VAT ID (#1) and/or tax ID (#2) not found. Please check if the vendor " .
"#3 exists and whether it has the correct tax ID/VAT ID." ,
$metadata{'ustid'},
$metadata{'taxnumber'},
$metadata{'vendor_name'},
) unless $vendor;
edb6e61e Tamino Steinert

231ea4d9 Tamino Steinert
# Check IBAN specified on bill matches the one we've got in
# the database for this vendor.
dec0e491 Tamino Steinert
if ($iban) {
$intnotes .= "\nIBAN: ";
$intnotes .= $iban ne $vendor->iban ?
t8("Record IBAN #1 doesn't match vendor IBAN #2", $iban, $vendor->iban)
: $iban
}
edb6e61e Tamino Steinert
231ea4d9 Tamino Steinert
# Use invoice creation date as due date if there's no due date
$metadata{'duedate'} = $metadata{'transdate'} unless defined $metadata{'duedate'};
edb6e61e Tamino Steinert
# parse dates to kivi if set/valid
231ea4d9 Tamino Steinert
foreach my $key ( qw(transdate duedate) ) {
next unless defined $metadata{$key};
$metadata{$key} =~ s/^\s+|\s+$//g;

if ($metadata{$key} =~ /^([0-9]{4})-?([0-9]{2})-?([0-9]{2})$/) {
$metadata{$key} = DateTime->new(year => $1,
month => $2,
day => $3)->to_kivitendo;
edb6e61e Tamino Steinert
}
}

231ea4d9 Tamino Steinert
my $currency = SL::DB::Manager::Currency->find_by(
name => $metadata{'currency'},
);

my $default_ap_amount_chart = SL::DB::Manager::Chart->find_by(
id => $::instance_conf->get_expense_accno_id
);
# Fallback if there's no default AP amount chart configured
$default_ap_amount_chart ||= SL::DB::Manager::Chart->find_by(charttype => 'A');

dec0e491 Tamino Steinert
my $active_taxkey = $default_ap_amount_chart->get_active_taxkey;
231ea4d9 Tamino Steinert
my $taxes = SL::DB::Manager::Tax->get_all(
where => [ chart_categories => {
like => '%' . $default_ap_amount_chart->category . '%'
}],
sort_by => 'taxkey, rate',
);
die t8(
"No tax found for chart #1", $default_ap_amount_chart->displayable_name
) unless scalar @{$taxes};

dec0e491 Tamino Steinert
my %template_params;
my $template_ap = SL::DB::Manager::RecordTemplate->get_first(where => [vendor_id => $vendor->id]);
if ($template_ap) {
b8dfb10a Tamino Steinert
$template_params{globalproject_id} = $template_ap->project_id;
dec0e491 Tamino Steinert
$template_params{payment_id} = $template_ap->payment_id;
$template_params{department_id} = $template_ap->department_id;
$template_params{ordnumber} = $template_ap->ordnumber;
$template_params{transaction_description} = $template_ap->transaction_description;
6ac133a5 Tamino Steinert
$template_params{notes} = $template_ap->notes;
}

# Try to fill in AP account to book against
my $ap_chart_id = $template_ap ? $template_ap->ar_ap_chart_id
: $::instance_conf->get_ap_chart_id;
my $ap_chart;
if ( $ap_chart_id ne '' ) {
$ap_chart = SL::DB::Manager::Chart->find_by(id => $ap_chart_id);
} else {
# If no default account is configured, just use the first AP account found.
($ap_chart) = @{SL::DB::Manager::Chart->get_all(
where => [ link => 'AP' ],
sort_by => [ 'accno' ],
)};
dec0e491 Tamino Steinert
}
231ea4d9 Tamino Steinert
my $today = DateTime->today_local;
6ac133a5 Tamino Steinert
my $duedate =
$metadata{duedate} ?
$metadata{duedate}
: $vendor->payment ?
$vendor->payment->calc_date(reference_date => $today)->to_kivitendo
: $today->to_kivitendo;

edb6e61e Tamino Steinert
my %params = (
invoice => 0,
231ea4d9 Tamino Steinert
vendor_id => $vendor->id,
edb6e61e Tamino Steinert
taxzone_id => $vendor->taxzone_id,
231ea4d9 Tamino Steinert
currency_id => $currency->id,
direct_debit => $metadata{'direct_debit'},
b8dfb10a Tamino Steinert
invnumber => $invnumber,
transdate => $metadata{transdate} || $today->to_kivitendo,
duedate => $metadata{duedate} || $today->to_kivitendo,
taxincluded => 0,
intnotes => $intnotes,
edb6e61e Tamino Steinert
transactions => [],
dec0e491 Tamino Steinert
%template_params,
edb6e61e Tamino Steinert
);

$self->assign_attributes(%params);

231ea4d9 Tamino Steinert
# parse items
b8dfb10a Tamino Steinert
my $template_item;
if ($template_ap && scalar @{$template_ap->items}) {
6ac133a5 Tamino Steinert
$template_item = $template_ap->items->[0];
b8dfb10a Tamino Steinert
}
231ea4d9 Tamino Steinert
foreach my $i (@items) {
my %item = %{$i};

dec0e491 Tamino Steinert
my $net_total = $item{'subtotal'};

# set default values for items
b8dfb10a Tamino Steinert
my %line_params;
$line_params{amount} = $net_total;
if ($template_item) {
$line_params{tax_id} = $template_item->tax->id;
$line_params{chart} = $template_item->chart;
$line_params{project_id} = $template_item->project_id;
dec0e491 Tamino Steinert
} else {
b8dfb10a Tamino Steinert
my $tax_rate = $item{'tax_rate'};
$tax_rate /= 100 if $tax_rate > 1; # XML data is usually in percent
my $tax = first { $tax_rate == $_->rate } @{ $taxes };
$tax //= first { $active_taxkey->tax_id == $_->id } @{ $taxes };
$tax //= $taxes->[0];
$line_params{tax_id} = $tax->id;
$line_params{chart} = $default_ap_amount_chart;
dec0e491 Tamino Steinert
}
231ea4d9 Tamino Steinert
edb6e61e Tamino Steinert
$self->add_ap_amount_row(%line_params);
}
$self->recalculate_amounts();

dec0e491 Tamino Steinert
$self->create_ap_row(chart => $ap_chart);
edb6e61e Tamino Steinert
return $self;
}

cf0455f5 Moritz Bunkus
1;