Class LineVATInformation

java.lang.Object
com.fourjs.report.facturx.profiles.extended.LineVATInformation

public class LineVATInformation extends Object
BG-30 LINE VAT INFORMATION — A group of business terms providing information about the VAT applicable for the goods and services invoiced on the Invoice line.

The EN 16931 business terms and groups implemented by this class:

Business terms and groups implemented
RepresentsBG-30
Business terms (value fields)BT-X-95, BT-X-96, BT-X-97, BT-X-589, BT-151, BT-151-0, BT-152

Documentation of the represented business group:

BG-30 — LINE VAT INFORMATION
DescriptionENA group of business terms providing information about the VAT applicable for the goods and services invoiced on the Invoice line.
FRGroupe de termes métiers fournissant des informations sur la TVA applicable aux biens et services facturés sur la ligne de Facture.
Since:
1.0.06/2.2
  • Method Details

    • setInvoicedItemVATCategoryCode

      public LineVATInformation setInvoicedItemVATCategoryCode(Codes.VATCategoryCode value)
      Sets BT-151 Invoiced item VAT category code — The VAT category code for the invoiced item.

      Usage: The following entries of UNTDID 5305 [6] are used (further clarification between brackets):- Standard rate (Liable for VAT in a standard way)- Zero rated goods (Liable for VAT with a percentage rate of zero)- Exempt from tax (VAT/IGIC/IPSI)- VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)- VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)- Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)- Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)- Canary Islands General Indirect Tax (Liable for IGIC tax)- Liable for IPSI (Ceuta/Melilla tax)

      Conditions (CIUS): The VAT category codes are as follows:S = Standard VAT rateZ = Zero rated goodsE = VAT exemptAE = Reverse chargeK = Intra-Community supply (specific reverse charge)G = Exempt VAT for Export outside EUO = Outside VAT scopeL = Canary IslandsM = Ceuta and Mellila

      Rule: BR-CO-4: Each Invoice line (BG-25) shall be categorized with an Invoiced item VAT category code (BT-151).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCode

      FR: Code de type de TVA de l'article facturé — Code de type de TVA applicable à l'article facturé.

      Parameters:
      value - the value to set
      Returns:
      this LineVATInformation for chaining
      Since:
      1.0.06/2.2
    • setInvoicedItemVATRate

      public LineVATInformation setInvoicedItemVATRate(Percentage value)
      Sets BT-152 Invoiced item VAT rate — The VAT rate, represented as percentage that applies to the invoiced item.

      Conditions (CIUS): The value to enter is the percentage. For example, for 20%, it must be given as 20 (and not 0.2)

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent

      FR: Taux de TVA de l'article facturé — Taux de TVA, exprimé sous forme de pourcentage, applicable à l'article facturé.

      Parameters:
      value - the value to set
      Returns:
      this LineVATInformation for chaining
      Since:
      1.0.06/2.2
    • setValueAddedTaxPointDateCodeOnLineLevel

      public LineVATInformation setValueAddedTaxPointDateCodeOnLineLevel(Codes.DateTypeCode value)
      Sets BT-X-589 Value added tax point date code on line level — The code of the date when the VAT becomes accountable for the Seller on line level and for the Buyer.

      Usage: The code shall distinguish between the following entries of UNTDID 2005 [6]:- Invoice docment issue date- Delivery date, actual- Payment date. The Value added tax point date code is used if the Value added tax point date is not known when the invoice is issued. The use of BT-8 and BT-7 is mutually exclusive.

      Conditions (CIUS): This code can be used in particular in multi-vendor invoices.This code should be selected from the following values from UNTDID 2475 (instead of UNTDID 2005 [6]):5: Date of the invoice (VAT on DEBITS)29: Delivery date (VAT on DEBITS)72: Payment date (VAT on RECEIPTS)

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:DueDateTypeCode

      FR: Date d'exigibilité de la taxe sur la valeur ajoutée en code à la ligne — Code spécifiant la date à laquelle la TVA devient imputable pour le Vendeur à la ligne et pour l'Acheteur

      Parameters:
      value - the value to set
      Returns:
      this LineVATInformation for chaining
      Since:
      1.09.2/2.5.2
    • setVATCalculatedAmount

      public LineVATInformation setVATCalculatedAmount(UnitPriceAmount value)
      Sets BT-X-95 VAT Calculated Amount — A monetary value resulting from the calculation of this trade related tax, levy or duty.

      Usage: Specification only for taxes that are not VAT

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CalculatedAmount

      FR: Montant de taxes

      Parameters:
      value - the value to set
      Returns:
      this LineVATInformation for chaining
      Since:
      1.09.2/2.5.2
    • setVATExemptionReason

      public LineVATInformation setVATExemptionReason(String value)
      Sets BT-X-96 VAT Exemption Reason — The reason, expressed as text, for exemption from this trade related tax

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:ExemptionReason

      FR: Motif d'exonération de la TVA — Énoncé expliquant pourquoi un montant est exonéré de TVA.

      Parameters:
      value - the value to set
      Returns:
      this LineVATInformation for chaining
      Since:
      1.09.2/2.5.2
    • setVATExemptionReasonCode

      public LineVATInformation setVATExemptionReasonCode(Codes.VATExemptionReasonCode value)
      Sets BT-X-97 VAT Exemption Reason Code — A coded statement of the reason for why the amount is exempted from VAT.

      Usage: Code list issued and maintained by the Connecting Europe Facility.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:ExemptionReasonCode

      FR: Motif d'exonération de la TVA en code — Code expliquant pourquoi un montant est exonéré de TVA.

      Parameters:
      value - the value to set
      Returns:
      this LineVATInformation for chaining
      Since:
      1.0.06/2.2
    • getInvoicedItemVATCategoryCode

      public Codes.VATCategoryCode getInvoicedItemVATCategoryCode()
      Returns BT-151 Invoiced item VAT category code — The VAT category code for the invoiced item.

      Usage: The following entries of UNTDID 5305 [6] are used (further clarification between brackets):- Standard rate (Liable for VAT in a standard way)- Zero rated goods (Liable for VAT with a percentage rate of zero)- Exempt from tax (VAT/IGIC/IPSI)- VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)- VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)- Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)- Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)- Canary Islands General Indirect Tax (Liable for IGIC tax)- Liable for IPSI (Ceuta/Melilla tax)

      Conditions (CIUS): The VAT category codes are as follows:S = Standard VAT rateZ = Zero rated goodsE = VAT exemptAE = Reverse chargeK = Intra-Community supply (specific reverse charge)G = Exempt VAT for Export outside EUO = Outside VAT scopeL = Canary IslandsM = Ceuta and Mellila

      Rule: BR-CO-4: Each Invoice line (BG-25) shall be categorized with an Invoiced item VAT category code (BT-151).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCode

      FR: Code de type de TVA de l'article facturé — Code de type de TVA applicable à l'article facturé.

      Returns:
      the BT-151 value
      Since:
      1.0.06/2.2
    • getVATTypeCodeOnLineLevel

      public Codes.VATTypeCode getVATTypeCodeOnLineLevel() throws ComputationException
      Returns BT-151-0 VAT type code on line level — The VAT category code for the invoiced item.

      Usage: For more information on the recommended codes, please refer to subclause 6.3.3.2 - Specification of VAT category codes.Fixed value = "VAT"

      Rule: Fixed value "VAT"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:TypeCode

      FR: Code de type de TVAInvoiced item VAT category code, Content — The VAT category code for the invoiced item.

      Returns:
      the BT-151-0 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
    • getInvoicedItemVATRate

      public Percentage getInvoicedItemVATRate()
      Returns BT-152 Invoiced item VAT rate — The VAT rate, represented as percentage that applies to the invoiced item.

      Conditions (CIUS): The value to enter is the percentage. For example, for 20%, it must be given as 20 (and not 0.2)

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent

      FR: Taux de TVA de l'article facturé — Taux de TVA, exprimé sous forme de pourcentage, applicable à l'article facturé.

      Returns:
      the BT-152 value
      Since:
      1.0.06/2.2
    • getValueAddedTaxPointDateCodeOnLineLevel

      public Codes.DateTypeCode getValueAddedTaxPointDateCodeOnLineLevel()
      Returns BT-X-589 Value added tax point date code on line level — The code of the date when the VAT becomes accountable for the Seller on line level and for the Buyer.

      Usage: The code shall distinguish between the following entries of UNTDID 2005 [6]:- Invoice docment issue date- Delivery date, actual- Payment date. The Value added tax point date code is used if the Value added tax point date is not known when the invoice is issued. The use of BT-8 and BT-7 is mutually exclusive.

      Conditions (CIUS): This code can be used in particular in multi-vendor invoices.This code should be selected from the following values from UNTDID 2475 (instead of UNTDID 2005 [6]):5: Date of the invoice (VAT on DEBITS)29: Delivery date (VAT on DEBITS)72: Payment date (VAT on RECEIPTS)

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:DueDateTypeCode

      FR: Date d'exigibilité de la taxe sur la valeur ajoutée en code à la ligne — Code spécifiant la date à laquelle la TVA devient imputable pour le Vendeur à la ligne et pour l'Acheteur

      Returns:
      the BT-X-589 value
      Since:
      1.09.2/2.5.2
    • getVATCalculatedAmount

      public UnitPriceAmount getVATCalculatedAmount()
      Returns BT-X-95 VAT Calculated Amount — A monetary value resulting from the calculation of this trade related tax, levy or duty.

      Usage: Specification only for taxes that are not VAT

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CalculatedAmount

      FR: Montant de taxes

      Returns:
      the BT-X-95 value
      Since:
      1.09.2/2.5.2
    • getVATExemptionReason

      public String getVATExemptionReason()
      Returns BT-X-96 VAT Exemption Reason — The reason, expressed as text, for exemption from this trade related tax

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:ExemptionReason

      FR: Motif d'exonération de la TVA — Énoncé expliquant pourquoi un montant est exonéré de TVA.

      Returns:
      the BT-X-96 value
      Since:
      1.09.2/2.5.2
    • getVATExemptionReasonCode

      public Codes.VATExemptionReasonCode getVATExemptionReasonCode()
      Returns BT-X-97 VAT Exemption Reason Code — A coded statement of the reason for why the amount is exempted from VAT.

      Usage: Code list issued and maintained by the Connecting Europe Facility.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:ExemptionReasonCode

      FR: Motif d'exonération de la TVA en code — Code expliquant pourquoi un montant est exonéré de TVA.

      Returns:
      the BT-X-97 value
      Since:
      1.0.06/2.2