|
package SL::DB::Helper::ZUGFeRD;
|
|
|
|
use strict;
|
|
use utf8;
|
|
|
|
use parent qw(Exporter);
|
|
our @EXPORT_CREATE = qw(create_zugferd_data create_zugferd_xmp_data);
|
|
our @EXPORT_IMPORT = qw(import_zugferd_xml);
|
|
our @EXPORT_OK = (@EXPORT_CREATE, @EXPORT_IMPORT);
|
|
our %EXPORT_TAGS = (
|
|
ALL => (@EXPORT_CREATE, @EXPORT_IMPORT),
|
|
CREATE => \@EXPORT_CREATE,
|
|
IMPORT => \@EXPORT_IMPORT,
|
|
);
|
|
|
|
use SL::DB::BankAccount;
|
|
use SL::DB::GenericTranslation;
|
|
use SL::DB::Tax;
|
|
use SL::DB::TaxKey;
|
|
use SL::DB::RecordTemplate;
|
|
use SL::Helper::ISO3166;
|
|
use SL::Helper::ISO4217;
|
|
use SL::Helper::UNECERecommendation20;
|
|
use SL::VATIDNr;
|
|
use SL::ZUGFeRD qw(:PROFILES);
|
|
use SL::Locale::String qw(t8);
|
|
|
|
use Carp;
|
|
use Encode qw(encode);
|
|
use List::MoreUtils qw(any pairwise);
|
|
use List::Util qw(first sum);
|
|
use Template;
|
|
use XML::Writer;
|
|
|
|
my @line_names = qw(LineOne LineTwo LineThree);
|
|
|
|
my %standards_ids = (
|
|
PROFILE_FACTURX_EXTENDED() => 'urn:cen.eu:en16931:2017#conformant#urn:factur-x.eu:1p0:extended',
|
|
PROFILE_XRECHNUNG() => 'urn:cen.eu:en16931:2017#compliant#urn:xoev-de:kosit:standard:xrechnung_2.0',
|
|
);
|
|
|
|
sub _is_profile {
|
|
my ($self, @profiles) = @_;
|
|
return any { $self->{_zugferd}->{profile} == $_ } @profiles;
|
|
}
|
|
|
|
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)
|
|
|
|
return $type eq 'credit_note' ? 381
|
|
: $type eq 'invoice_storno' ? 457
|
|
: $type eq 'credit_note_storno' ? 458
|
|
: 380;
|
|
}
|
|
|
|
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");
|
|
$params{xml}->dataElement("ram:BilledQuantity", $params{item}->qty, unitCode => _unit_code($params{item}->unit));
|
|
$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>
|
|
}
|
|
|
|
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>
|
|
}
|
|
|
|
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");
|
|
$params{xml}->dataElement("ram:CalculatedAmount", _r2($params{ptc_data}->{taxes_by_tax_id}->{$info->{taxkey}->tax_id}));
|
|
$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>
|
|
}
|
|
}
|
|
|
|
sub _calculate_payment_terms_values {
|
|
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);
|
|
}
|
|
|
|
return (
|
|
vars => \%vars,
|
|
amounts => \%amounts,
|
|
formatted_amounts => \%formatted_amounts,
|
|
);
|
|
}
|
|
|
|
sub _format_payment_terms_description {
|
|
my ($self, %params) = @_;
|
|
|
|
my $description = ($self->payment_terms->translated_attribute('description_long_invoice', $self->language_id) // '') || $self->payment_terms->description_long_invoice;
|
|
$description =~ s{<\%$_\%>}{ $params{vars}->{$_} }ge for keys %{ $params{vars} };
|
|
$description =~ s{<\%$_\%>}{ $params{formatted_amounts}->{$_} }ge for keys %{ $params{formatted_amounts} };
|
|
|
|
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;
|
|
}
|
|
|
|
return $description;
|
|
}
|
|
|
|
sub _payment_terms {
|
|
my ($self, %params) = @_;
|
|
|
|
return unless $self->payment_terms;
|
|
|
|
my %payment_terms_vars = _calculate_payment_terms_values($self);
|
|
|
|
# <ram:SpecifiedTradePaymentTerms>
|
|
$params{xml}->startTag("ram:SpecifiedTradePaymentTerms");
|
|
|
|
$params{xml}->dataElement("ram:Description", _u8(_format_payment_terms_description($self, %payment_terms_vars)));
|
|
|
|
# <ram:DueDateDateTime>
|
|
$params{xml}->startTag("ram:DueDateDateTime");
|
|
$params{xml}->dataElement("udt:DateTimeString", $self->duedate->strftime('%Y%m%d'), format => "102");
|
|
$params{xml}->endTag;
|
|
# </ram:DueDateDateTime>
|
|
|
|
if ( _is_profile($self, PROFILE_FACTURX_EXTENDED())
|
|
&& $self->payment_terms->percent_skonto
|
|
&& $self->payment_terms->terms_skonto) {
|
|
my $currency_id = _u8(SL::Helper::ISO4217::map_currency_name_to_code($self->currency->name) // 'EUR');
|
|
|
|
# <ram:ApplicableTradePaymentDiscountTerms>
|
|
$params{xml}->startTag("ram:ApplicableTradePaymentDiscountTerms");
|
|
$params{xml}->dataElement("ram:BasisPeriodMeasure", $self->payment_terms->terms_skonto, unitCode => "DAY");
|
|
$params{xml}->dataElement("ram:BasisAmount", _r2($payment_terms_vars{amounts}->{invtotal}), currencyID => $currency_id);
|
|
$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));
|
|
$params{xml}->dataElement("ram:TaxTotalAmount", _r2(sum(values %{ $params{ptc_data}->{taxes_by_tax_id} })), currencyID => "EUR");
|
|
$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");
|
|
|
|
if ($self->{_zugferd}->{test_mode}) {
|
|
$params{xml}->startTag("ram:TestIndicator");
|
|
$params{xml}->dataElement("udt:Indicator", "true");
|
|
$params{xml}->endTag;
|
|
}
|
|
|
|
$params{xml}->startTag("ram:GuidelineSpecifiedDocumentContextParameter");
|
|
$params{xml}->dataElement("ram:ID", $standards_ids{ $self->{_zugferd}->{profile} });
|
|
$params{xml}->endTag;
|
|
$params{xml}->endTag;
|
|
# </rsm:ExchangedDocumentContext>
|
|
}
|
|
|
|
sub _included_note {
|
|
my ($self, %params) = @_;
|
|
|
|
$params{xml}->startTag("ram:IncludedNote");
|
|
$params{xml}->dataElement("ram:Content", _u8($params{note}));
|
|
$params{xml}->endTag;
|
|
}
|
|
|
|
sub _exchanged_document {
|
|
my ($self, %params) = @_;
|
|
|
|
# <rsm:ExchangedDocument>
|
|
$params{xml}->startTag("rsm:ExchangedDocument");
|
|
|
|
$params{xml}->dataElement("ram:ID", _u8($self->invnumber));
|
|
$params{xml}->dataElement("ram:Name", _u8(_type_name($self))) if _is_profile($self, PROFILE_FACTURX_EXTENDED());
|
|
$params{xml}->dataElement("ram:TypeCode", _u8(_type_code($self)));
|
|
|
|
# <ram:IssueDateTime>
|
|
$params{xml}->startTag("ram:IssueDateTime");
|
|
$params{xml}->dataElement("udt:DateTimeString", $self->transdate->strftime('%Y%m%d'), format => "102");
|
|
$params{xml}->endTag;
|
|
# </ram:IssueDateTime>
|
|
|
|
if ( _is_profile($self, PROFILE_FACTURX_EXTENDED())
|
|
&& $self->language
|
|
&& (($self->language->template_code // '') =~ m{^(de|en)}i)) {
|
|
$params{xml}->dataElement("ram:LanguageID", uc($1));
|
|
}
|
|
|
|
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 };
|
|
|
|
my $notes = $self->notes_as_stripped_html;
|
|
|
|
_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;
|
|
|
|
$params{xml}->endTag;
|
|
# </rsm:ExchangedDocument>
|
|
}
|
|
|
|
sub _specified_tax_registration {
|
|
my ($ustid_nr, %params) = @_;
|
|
|
|
# <ram:SpecifiedTaxRegistration>
|
|
$params{xml}->startTag("ram:SpecifiedTaxRegistration");
|
|
$params{xml}->dataElement("ram:ID", _u8(SL::VATIDNr->normalize($ustid_nr)), schemeID => "VA");
|
|
$params{xml}->endTag;
|
|
# </ram:SpecifiedTaxRegistration>
|
|
}
|
|
|
|
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");
|
|
|
|
$params{xml}->dataElement("ram:PersonName", _u8($sales_person->safe_name));
|
|
|
|
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>
|
|
}
|
|
|
|
_specified_tax_registration($::instance_conf->get_co_ustid, %params);
|
|
|
|
$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);
|
|
_specified_tax_registration($self->customer->ustid, %params) if $self->customer->ustid;
|
|
|
|
$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");
|
|
|
|
$params{xml}->dataElement("ram:BuyerReference", _u8($self->customer->c_vendor_routing_id)) if $self->customer->c_vendor_routing_id;
|
|
|
|
_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");
|
|
$params{xml}->dataElement("udt:DateTimeString", ($self->deliverydate // $self->transdate)->strftime('%Y%m%d'), format => "102");
|
|
$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'));
|
|
|
|
_specified_trade_settlement_payment_means($self, %params);
|
|
_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>
|
|
}
|
|
|
|
sub _validate_data {
|
|
my ($self) = @_;
|
|
|
|
my %result;
|
|
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.'));
|
|
}
|
|
|
|
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."));
|
|
}
|
|
|
|
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));
|
|
}
|
|
|
|
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}) {
|
|
SL::X::ZUGFeRDValidation->throw(message => $prefix . $::locale->text('No bank account flagged for Factur-X/ZUGFeRD usage was found.'));
|
|
}
|
|
}
|
|
|
|
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'));
|
|
}
|
|
}
|
|
|
|
return %result;
|
|
}
|
|
|
|
sub create_zugferd_data {
|
|
my ($self) = @_;
|
|
$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";
|
|
}
|
|
|
|
my $output = '';
|
|
|
|
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',
|
|
);
|
|
|
|
$params{xml}->xmlDecl();
|
|
|
|
# <rsm:CrossIndustryInvoice>
|
|
$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");
|
|
|
|
_exchanged_document_context($self, %params);
|
|
_exchanged_document($self, %params);
|
|
_supply_chain_trade_transaction($self, %params);
|
|
|
|
$params{xml}->endTag;
|
|
# </rsm:CrossIndustryInvoice>
|
|
|
|
return $output;
|
|
}
|
|
|
|
sub create_zugferd_xmp_data {
|
|
my ($self) = @_;
|
|
|
|
return {
|
|
conformance_level => 'EXTENDED',
|
|
document_file_name => 'factur-x.xml',
|
|
document_type => 'INVOICE',
|
|
version => '1.0',
|
|
};
|
|
}
|
|
|
|
sub import_zugferd_xml {
|
|
my ($self, $zugferd_xml) = @_;
|
|
|
|
# 1. check if ZUGFeRD SellerTradeParty has a VAT-ID
|
|
my $ustid = $zugferd_xml->findnodes(
|
|
'//ram:SellerTradeParty/ram:SpecifiedTaxRegistration'
|
|
)->string_value;
|
|
die t8("No VAT Info for this Factur-X/ZUGFeRD invoice," .
|
|
" please ask your vendor to add this for his Factur-X/ZUGFeRD data.") unless $ustid;
|
|
|
|
$ustid = SL::VATIDNr->normalize($ustid);
|
|
|
|
# 1.1 check if we a have a vendor with this VAT-ID (vendor.ustid)
|
|
my $vendor_name = $zugferd_xml->findnodes('//ram:SellerTradeParty/ram:Name')->string_value;
|
|
my $vendor = SL::DB::Manager::Vendor->find_by(
|
|
ustid => $ustid,
|
|
or => [
|
|
obsolete => undef,
|
|
obsolete => 0,
|
|
]);
|
|
|
|
if (!$vendor) {
|
|
# 1.2 If no vendor with the exact VAT ID number is found, the
|
|
# number might be stored slightly different in the database
|
|
# (e.g. with spaces breaking up groups of numbers). Iterate over
|
|
# all existing vendors with VAT ID numbers, normalize their
|
|
# representation and compare those.
|
|
|
|
my $vendors = SL::DB::Manager::Vendor->get_all(
|
|
where => [
|
|
'!ustid' => undef,
|
|
'!ustid' => '',
|
|
or => [
|
|
obsolete => undef,
|
|
obsolete => 0,
|
|
],
|
|
]);
|
|
|
|
foreach my $other_vendor (@{ $vendors }) {
|
|
next unless SL::VATIDNr->normalize($other_vendor->ustid) eq $ustid;
|
|
|
|
$vendor = $other_vendor;
|
|
last;
|
|
}
|
|
}
|
|
|
|
die t8("Please add a valid VAT-ID for this vendor: #1", $vendor_name)
|
|
unless (ref $vendor eq 'SL::DB::Vendor');
|
|
|
|
# 2. check if we have a ap record template for this vendor (TODO only the oldest template is choosen)
|
|
my $template_ap = SL::DB::Manager::RecordTemplate->get_first(where => [vendor_id => $vendor->id]);
|
|
die t8("No AP Record Template for vendor #1 found, please add one", $vendor_name)
|
|
unless (ref $template_ap eq 'SL::DB::RecordTemplate');
|
|
|
|
|
|
# 3. parse the zugferd data and fill the ap record template
|
|
# -> no need to check sign (credit notes will be negative) just record thei ZUGFeRD type in ap.notes
|
|
# -> check direct debit (defaults to no)
|
|
# -> set amount (net amount) and unset taxincluded
|
|
# (template and user cares for tax and if there is more than one booking accno)
|
|
# -> date (can be empty)
|
|
# -> duedate (may be empty)
|
|
# -> compare record iban and generate a warning if this differs from vendor's master data iban
|
|
my $total = $zugferd_xml->findnodes(
|
|
'//ram:SpecifiedTradeSettlementHeaderMonetarySummation' .
|
|
'/ram:TaxBasisTotalAmount'
|
|
)->string_value;
|
|
|
|
my $invnumber = $zugferd_xml->findnodes(
|
|
'//rsm:ExchangedDocument/ram:ID'
|
|
)->string_value;
|
|
|
|
# parse dates to kivi if set/valid
|
|
my %dates = (
|
|
transdate => {
|
|
key => '//ram:IssueDateTime',
|
|
value => undef,
|
|
},
|
|
duedate => {
|
|
key => '//ram:DueDateDateTime',
|
|
value => undef,
|
|
},
|
|
);
|
|
foreach my $date (keys %dates) {
|
|
my $string_value = $zugferd_xml->findnodes($dates{$date}->{key})->string_value;
|
|
$string_value =~ s/^\s+|\s+$//g;
|
|
if ($string_value =~ /^[0-9]{8}$/) {
|
|
$dates{$date}->{value} = DateTime->new(
|
|
year => substr($string_value,0,4),
|
|
month => substr ($string_value,4,2),
|
|
day => substr($string_value,6,2)
|
|
)->to_kivitendo;
|
|
}
|
|
}
|
|
my $transdate = $dates{transdate}->{value};
|
|
my $duedate = $dates{duedate}->{value};
|
|
|
|
my $type = $zugferd_xml->findnodes(
|
|
'//rsm:ExchangedDocument/ram:TypeCode'
|
|
)->string_value;
|
|
|
|
my $dd = $zugferd_xml->findnodes(
|
|
'//ram:ApplicableHeaderTradeSettlement' .
|
|
'/ram:SpecifiedTradeSettlementPaymentMeans/ram:TypeCode'
|
|
)->string_value;
|
|
my $direct_debit = $dd == 59 ? 1 : 0;
|
|
|
|
my $iban = $zugferd_xml->findnodes(
|
|
'//ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementPaymentMeans' .
|
|
'/ram:PayeePartyCreditorFinancialAccount/ram:IBANID'
|
|
)->string_value;
|
|
|
|
my $ibanmessage;
|
|
$ibanmessage = $iban ne $vendor->iban ?
|
|
"Record IBAN $iban doesn't match vendor IBAN " . $vendor->iban
|
|
: $iban if $iban;
|
|
|
|
# write values to self
|
|
my $today = DateTime->today_local;
|
|
|
|
my $additional_notes = "ZUGFeRD Import. Type: $type\nIBAN: " . $ibanmessage;
|
|
|
|
my %params = (
|
|
invoice => 0,
|
|
vendor_id => $vendor->id,
|
|
taxzone_id => $vendor->taxzone_id,
|
|
currency_id => $template_ap->currency_id,
|
|
direct_debit => $direct_debit,
|
|
globalproject_id => $template_ap->project_id,
|
|
payment_id => $template_ap->payment_id,
|
|
invnumber => $invnumber,
|
|
transdate => $transdate || $today->to_kivitendo,
|
|
duedate => $duedate || (
|
|
$template_ap->vendor->payment ?
|
|
$template_ap->vendor->payment->calc_date(reference_date => $today)->to_kivitendo
|
|
: $today->to_kivitendo
|
|
),
|
|
department_id => $template_ap->department_id,
|
|
ordnumber => $template_ap->ordnumber,
|
|
taxincluded => 0,
|
|
notes => join("\n", $template_ap->notes, $additional_notes),
|
|
transactions => [],
|
|
transaction_description => $template_ap->transaction_description,
|
|
);
|
|
|
|
$self->assign_attributes(%params);
|
|
|
|
foreach my $template_item (@{$template_ap->items}) {
|
|
my %line_params = (
|
|
amount => $total,
|
|
project_id => $template_item->project_id,
|
|
tax_id => $template_item->tax_id,
|
|
chart => $template_item->chart,
|
|
);
|
|
|
|
$self->add_ap_amount_row(%line_params);
|
|
}
|
|
$self->recalculate_amounts();
|
|
|
|
my $ap_chart = SL::DB::Manager::Chart->get_first(
|
|
where => [id => $template_ap->ar_ap_chart_id]
|
|
);
|
|
$self->create_ap_row(chart => $ap_chart);
|
|
|
|
return $self;
|
|
}
|
|
|
|
1;
|