FacturX French / German Standard for invoicing. More...

Inheritance diagram for Noalyss\XMLDocument\FacturX:

Collaboration diagram for Noalyss\XMLDocument\FacturX:

Public Member Functions
	build_data ($jr_id)
	transform an operation ($jr_id) into an array, which contains needed information for making an e-invoice

	check_company_data ()
	check that mandatory info are saved in the DB

	check_customer_data ()
	check that mandatory info are saved in the DB for customer

	check_VAT ()
	check that the VAT is using a PEPPOL Code

	create_invoice ($operation_id)
	create the invoice in the right format

	make_xml ($jr_id)
	create an XML invoice(Factur-X) based on JRN.JR_ID operation @parameter $jr_id (int) operation JRN.JR_ID operation

Public Member Functions inherited from Noalyss\XMLDocument\XMLInvoice
	__construct (\Database $conx)
	$jr_id (int) is JRN.JR_ID

	display_error ()
	display_error display a warning with all error

	fill_customer ($card_id)
	retrieve data from customer and return it into an array

	fill_document ($jr_id)
	retrieve additionnal documents but only PDF , not other files

	fill_operation_from_array ($a_array)
	build operation from array key :

	fill_supplier ()
	complete $this->data from $g_parameter (global variable) for Noalyss_Folder_Parameter

	get_data ()
	return data

	get_db_conx ()
	get Database Connexion

	load_noalyss_parameter ()
	make an array of parameter_extra where pe_code as key and pe_value as value

	set_data ($data)
	returns data

	set_db_conx (\Database $cn)
	set Database Connexion

	set_pdf_filename ($pdf_filename)
	set the PDF

Data Fields
const	EXTRA_PARAMETER

Protected Attributes
	$pdf_filename

Protected Attributes inherited from Noalyss\XMLDocument\XMLInvoice
	$cn
	Database conx , current folder.

	$data

	$jr_id
	$data (Array) data retrieve from DB

Additional Inherited Members
Static Public Member Functions inherited from Noalyss\XMLDocument\XMLInvoice
static	build_xmlinvoice (\Database $conx)
	thanks MY_INVOICE_FORMAT , create the corresponding object

Detailed Description

FacturX French / German Standard for invoicing.

Definition at line 42 of file facturx.class.php.

Member Function Documentation

◆ build_data()

Noalyss\XMLDocument\FacturX::build_data ( $jr_id )

transform an operation ($jr_id) into an array, which contains needed information for making an e-invoice

Parameters

$jr_id (int) operation JRN.JR_ID

Returns: array with all info7

Compute totals VAT and AMOUNT

block cac:LegalMonetaryTotal

Todo: Pour les intracomm , quel taux utilisé ? 0 ou 21%

Reimplemented from Noalyss\XMLDocument\XMLInvoice.

Definition at line 62 of file facturx.class.php.

                               : array {
        $this->data=parent::build_data($jr_id);
        return $this->data;
    }

References Noalyss\XMLDocument\XMLInvoice\$jr_id, and build_data().

Referenced by build_data(), and make_xml().

Here is the call graph for this function:

◆ check_company_data()

Noalyss\XMLDocument\FacturX::check_company_data ( )

check that mandatory info are saved in the DB

Parameters

$a_error (array) array of errors, empty if nothing found

Reimplemented from Noalyss\XMLDocument\XMLInvoice.

Definition at line 70 of file facturx.class.php.

    {
        $a_error=array();
        $company = $this->load_noalyss_parameter();
        foreach (FacturX::EXTRA_PARAMETER as $item) {
            if (!isset($company[$item]) || trim($company[$item]) == '') {
                $a_error[]=$item;
            }
        }
        return $a_error;
    }

References EXTRA_PARAMETER, and Noalyss\XMLDocument\XMLInvoice\load_noalyss_parameter().

Here is the call graph for this function:

◆ check_customer_data()

Noalyss\XMLDocument\FacturX::check_customer_data ( )

check that mandatory info are saved in the DB for customer

Reimplemented from Noalyss\XMLDocument\XMLInvoice.

Definition at line 84 of file facturx.class.php.

                                  {
        $a_error=array();
        $a_needed=[ATTR_DEF_NAME=>'name'
                ,ATTR_DEF_ADRESS=>'street'
                ,ATTR_DEF_POSTCODE=>'postalzone'
                ,ATTR_DEF_CITY=>'city'
                ,ATTR_DEF_COUNTRY_CODE=>'country'
                ,ATTR_DEF_NUMTVA=>'customer_vat_id'
            ];
        
        foreach ($a_needed as $item=>$value) {
             if ( $this->data['customer'][$value]=="") {
                 $a_error[]=$value;
             }
        }
      
        return $a_error;
    }

References $value, ATTR_DEF_ADRESS, ATTR_DEF_CITY, ATTR_DEF_COUNTRY_CODE, ATTR_DEF_NAME, ATTR_DEF_NUMTVA, and ATTR_DEF_POSTCODE.

◆ check_VAT()

Noalyss\XMLDocument\FacturX::check_VAT ( )

check that the VAT is using a PEPPOL Code

Reimplemented from Noalyss\XMLDocument\XMLInvoice.

Definition at line 263 of file facturx.class.php.

    {
        return array();
    }

◆ create_invoice()

Noalyss\XMLDocument\FacturX::create_invoice ( $operation_id )

create the invoice in the right format

Parameters

$operation_id (int) JRN.JR_ID

Returns: string PDF Invoice including the XML

Reimplemented from Noalyss\XMLDocument\XMLInvoice.

Definition at line 235 of file facturx.class.php.

                                           {
        $documentBuilder= $this->make_xml($operation_id);
        
        $invoice =  \horstoeko\zugferd\ZugferdDocumentPdfBuilder::fromPdfFile($documentBuilder, $this->pdf_filename);
        $invoice->generateDocument();
        $invoice->saveDocument($this->pdf_filename."-new.pdf");
        return $invoice->downloadString();
    }

References $operation_id, and make_xml().

Here is the call graph for this function:

◆ make_xml()

Noalyss\XMLDocument\FacturX::make_xml ( $jr_id )

create an XML invoice(Factur-X) based on JRN.JR_ID operation @parameter $jr_id (int) operation JRN.JR_ID operation

Returns: XML String

Note: SIREN or SIRET is mandatory

Reimplemented from Noalyss\XMLDocument\XMLInvoice.

Definition at line 109 of file facturx.class.php.

    {
        $this->data = $this->build_data($jr_id);
        $company = $this->load_noalyss_parameter();
      //  var_dump($this->data);
        $documentBuilder = ZugferdDocumentBuilder::createNew(ZugferdProfiles::PROFILE_EN16931);
        $documentBuilder->setDocumentInformation(
                $this->data['id']
                ,"380"
                ,\DateTime::createFromFormat( 'Y-m-d',$this->data["issue_date"])
                , $this->data['currency']
                );
        
        $documentBuilder->addDocumentPaymentTerm(
            sprintf("IBAN %s",$company['COMPANY_BANK_IBAN'])
            ,\DateTime::createFromFormat( 'Y-m-d',$this->data["due_date"])
            , $this->data['info']['communication']
        );
        //------------------------------------------------
        // SELLER
        //------------------------------------------------
        $documentBuilder->setDocumentSeller($company['MY_NAME'], );
        $documentBuilder->addDocumentSellerGlobalId($company['SIREN'], '0009');
        $documentBuilder->addDocumentSellerTaxNumber($company['MY_TVA']);
        $documentBuilder->addDocumentSellerVATRegistrationNumber($company['MY_TVA']);
        $documentBuilder->setDocumentSellerAddress(
                $company['MY_STREET']
                , '', ''
                , $company['MY_POSTCODE']
                , $company['MY_CITY']
                ,$company['MY_COUNTRY_CODE']);
        
        $documentBuilder->setDocumentSellerCommunication(ZugferdElectronicAddressScheme::UNECE3155_EM
                   , $company["INVOICE_EMAIL_COMPANY"]);
        
        //------------------------------------------------
        // BUYER
        //------------------------------------------------
        
        $documentBuilder->setDocumentBuyer($this->data['customer']['name'], $this->data['customer']['customer_vat_id']);
        $documentBuilder->setDocumentBuyerAddress(
                                                    $this->data['customer']['street']
                                                    , ''
                                                    , ''
                                                    , $this->data['customer']['postalzone']
                                                    , $this->data['customer']['city']
                                                    , $this->data['customer']['country']
                                                    );
//        $documentBuilder->setDocumentBuyerContact('H. Meier', 'Einkauf', '+49-333-4444444', '+49-333-5555555', 'hm@kunde.de');
//        $documentBuilder->setDocumentBuyerCommunication(ZugferdElectronicAddressScheme::UNECE3155_EM, 'purchase@kunde.de');
        
        $documentBuilder->setDocumentBuyerOrderReferencedDocument($this->data['info']['order']);
        
        //------------------------------------------------
        // Item & total
        //------------------------------------------------
       
        $base=0;$vat=0;
        $nb=count($this->data['operation']);
 
        for ($i=0;$i < $nb;$i++) {
            $documentBuilder->addNewPosition($i+1);
            $documentBuilder->setDocumentPositionProductDetails($this->data['operation'][$i]['qcode']
                        ,$this->data['operation'][$i]['name']
                        ,$this->data['operation'][$i]['description']
                    );
            $documentBuilder->setDocumentPositionNetPrice($this->data['operation'][$i]['price']);
            $documentBuilder->setDocumentPositionQuantity($this->data['operation'][$i]['quantity']
                    ,$this->data['operation'][$i]['code_quantity']
                    );
            $documentBuilder->addDocumentPositionTax(
                    $this->data['operation'][$i]['vat_code']
                    , ZugferdVatTypeCodes::VALUE_ADDED_TAX
                    , bcmul($this->data['operation'][$i]['vat_rate'],100,2)
                    );
            $documentBuilder->setDocumentPositionLineSummation($this->data['operation'][$i]['price']);
            
            
            $base=bcadd($base,$this->data['operation'][$i]['price'],2);
            $vat=bcadd($vat,$this->data['operation'][$i]['vat'],2);
            $vat=bcsub($vat,$this->data['operation'][$i]['vat_reversed'],2);
        }
        $tt  = bcadd($base,$vat,2);
        //------------------------------------------------
        // VAT Detail
        //------------------------------------------------
        $subTotal=$this->data['subTotalVAT'];
        $nb_sub=count($subTotal);
        for ($i=0;$i<$nb_sub;$i++) 
        {
            $documentBuilder->addDocumentTax(
                   $subTotal[$i]["vat_code"]
                 , ZugferdVatTypeCodes::VALUE_ADDED_TAX
                 ,sprintf("%.2f",$subTotal[$i]['amount'])
                 , sprintf("%.2f",$subTotal[$i]['vat'])
                 , sprintf("%.2f",$subTotal[$i]['percent'])
                 );
        }
        //------------------------------------------------
        // Total summary
        //------------------------------------------------
        $documentBuilder->setDocumentSummation(
                  sprintf("%.2f",$this->data['TaxInclusiveAmount'])
                , sprintf("%.2f",$this->data['PayableAmount'])
                , sprintf("%.2f",$this->data['TaxExclusiveAmount'])
                , 0.0
                , 0.0
                , sprintf("%.2f",$this->data['LineExtensionAmount'])
                , sprintf("%.2f",(bcsub($this->data['TaxInclusiveAmount'],
                                        $this->data['TaxExclusiveAmount'],
                                        2)
                                )
                        )
                , 0
                );
 
         
         return $documentBuilder;
 
         
    }

References $base, $i, Noalyss\XMLDocument\XMLInvoice\$jr_id, $nb, build_data(), and Noalyss\XMLDocument\XMLInvoice\load_noalyss_parameter().

Referenced by create_invoice().

Here is the call graph for this function:

Field Documentation

◆ $pdf_filename

Noalyss\XMLDocument\FacturX::$pdf_filename

protected

Definition at line 60 of file facturx.class.php.

◆ EXTRA_PARAMETER

const Noalyss\XMLDocument\FacturX::EXTRA_PARAMETER

Initial value:

= [
         "INVOICE_EMAIL_COMPANY"
        , 'INVOICE_CONTACT_NAME'
        , 'COMPANY_LEGAL_ENTITY'
        , 'COMPANY_LEGAL_REGISTRATION'
        , 'COMPANY_BANK_IBAN'
        , 'COMPANY_BANK_BIC'
        , 'MY_NAME'
        , 'MY_STREET'
        , 'MY_CITY'
        , 'MY_COUNTRY_CODE'
        , 'MY_TVA'
        ,'SIREN'
     
        ]

Definition at line 44 of file facturx.class.php.

Referenced by check_company_data().

The documentation for this class was generated from the following file:

include/XMLDocument/facturx.class.php

Public Member Functions

Data Fields

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ build_data()

◆ check_company_data()

◆ check_customer_data()

◆ check_VAT()

◆ create_invoice()

◆ make_xml()

Field Documentation

◆ $pdf_filename

◆ EXTRA_PARAMETER