--- /dev/null
+package SL::DB::Helper::ZUGFeRD;
+
+use strict;
+use utf8;
+
+use parent qw(Exporter);
+our @EXPORT = qw(create_zugferd_data create_zugferd_xmp_data);
+
+use SL::DB::Tax;
+use SL::DB::TaxKey;
+use SL::Helper::ISO3166;
+use SL::Helper::ISO4217;
+use SL::Helper::UNECERecommendation20;
+
+use Carp;
+use Encode qw(encode);
+use List::MoreUtils qw(pairwise);
+use List::Util qw(sum);
+use Template;
+use XML::Writer;
+
+my @line_names = qw(LineOne LineTwo LineThree);
+
+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 : 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 _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};
+ $info->{tax_amount} += $item->{tax_amount};
+ }
+
+ 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}->{$info->{tax}->{chart_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 _format_payment_terms_description {
+ 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);
+ }
+
+ my $description = ($self->payment_terms->translated_attribute('description_long_invoice', $self->language_id) // '') || $self->payment_terms->description_long_invoice;
+ $description =~ s{<\%$_\%>}{ $vars{$_} }ge for keys %vars;
+ $description =~ s{<\%$_\%>}{ $formatted_amounts{$_} }ge for keys %formatted_amounts;
+
+ return $description;
+}
+
+sub _payment_terms {
+ my ($self, %params) = @_;
+
+ return unless $self->payment_terms;
+
+ # <ram:SpecifiedTradePaymentTerms>
+ $params{xml}->startTag("ram:SpecifiedTradePaymentTerms");
+
+ $params{xml}->dataElement("ram:Description", _u8(_format_payment_terms_description($self)));
+
+ # <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 ($self->payment_terms->percent_skonto && $self->payment_terms->terms_skonto) {
+ # <ram:ApplicableTradePaymentDiscountTerms>
+ $params{xml}->startTag("ram:ApplicableTradePaymentDiscountTerms");
+ $params{xml}->dataElement("ram:BasisPeriodMeasure", $self->payment_terms->terms_skonto, "unitCode" => "DAY");
+ $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} })), "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");
+ $params{xml}->startTag("ram:TestIndicator");
+ $params{xml}->dataElement("udt:Indicator", "true"); # TODO: change to 'false'
+ $params{xml}->endTag;
+
+ $params{xml}->startTag("ram:GuidelineSpecifiedDocumentContextParameter");
+ $params{xml}->dataElement("ram:ID", "urn:cen.eu:en16931:2017#conformant#urn:zugferd.de:2p0:extended");
+ $params{xml}->endTag;
+ $params{xml}->endTag;
+ # </rsm:ExchangedDocumentContext>
+}
+
+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)));
+ $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 ($self->language && (($self->language->template_code // '') =~ m{^(de|en)}i)) {
+ $params{xml}->dataElement("ram:LanguageID", uc($1));
+ }
+
+ if ($self->transaction_description) {
+ $params{xml}->startTag("ram:IncludedNote");
+ $params{xml}->dataElement("ram:Content", _u8($self->transaction_description));
+ $params{xml}->endTag;
+ }
+
+ my $notes = $self->notes_as_stripped_html;
+ if ($notes) {
+ $params{xml}->startTag("ram:IncludedNote");
+ $params{xml}->dataElement("ram:Content", _u8($notes));
+ $params{xml}->endTag;
+ }
+
+ $params{xml}->endTag;
+ # </rsm:ExchangedDocument>
+}
+
+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_cfg{name} || $sales_person_cfg{login}));
+
+ 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>
+ }
+
+ my $ustid_nr = $::instance_conf->get_co_ustid;
+ if ($ustid_nr) {
+ $ustid_nr = "DE$ustid_nr" unless $ustid_nr =~ m{^[A-Z]{2}};
+ # <ram:SpecifiedTaxRegistration>
+ $params{xml}->startTag("ram:SpecifiedTaxRegistration");
+ $params{xml}->dataElement("ram:ID", _u8($ustid_nr), "schemeID" => "VA");
+ $params{xml}->endTag;
+ # </ram:SpecifiedTaxRegistration>
+ }
+
+ $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);
+
+ $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");
+
+ _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'));
+
+ _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 create_zugferd_data {
+ my ($self) = @_;
+
+ my %ptc_data = $self->calculate_prices_and_taxes;
+ my $output = '';
+ my $xml = XML::Writer->new(
+ OUTPUT => \$output,
+ DATA_MODE => 1,
+ DATA_INDENT => 2,
+ ENCODING => 'utf-8',
+ );
+
+ my %params = (
+ ptc_data => \%ptc_data,
+ xml => $xml,
+ );
+
+ $xml->xmlDecl();
+
+ # <rsm:CrossIndustryInvoice>
+ $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);
+
+ $xml->endTag;
+ # </rsm:CrossIndustryInvoice>
+
+ return $output;
+}
+
+sub create_zugferd_xmp_data {
+ my ($self) = @_;
+
+ return {
+ conformance_level => 'EXTENDED',
+ document_file_name => 'ZUGFeRD-invoice.xml',
+ document_type => 'INVOICE',
+ version => '1.0',
+ };
+}
+
+1;
projects / kivitendo-erp.git / commitdiff