Class 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.

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

    • Method Detail

      • setTaxAmount

        public LineVATInformation setTaxAmount​(UnitPriceAmount value)
        Parameters:
        value - EXT:Tax Amount

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

        Returns:
        LineVATInformation
      • setExemptionReason

        public LineVATInformation setExemptionReason​(String value)
        Parameters:
        value - EXT:VAT exemption reason (free text)

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

        Returns:
        LineVATInformation
      • setInvoicedItemVATCategoryCode

        public LineVATInformation setInvoicedItemVATCategoryCode​(Codes.VATCategoryCode value)
        Parameters:
        value - BT-151:Invoiced item VAT category code

        The VAT category code for the invoiced item.

        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)

        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

        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

        Returns:
        LineVATInformation
      • setVATExemptionReasonCode

        public LineVATInformation setVATExemptionReasonCode​(Codes.VATExemptionReasonCode value)
        Parameters:
        value - EXT:VAT exemption reason code

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

        Returns:
        LineVATInformation
      • setInvoicedItemVATRate

        public LineVATInformation setInvoicedItemVATRate​(Percentage value)
        Parameters:
        value - BT-152:Invoiced item VAT rate

        The VAT rate, represented as percentage that applies to the invoiced item.

        The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)

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

        Returns:
        LineVATInformation
      • getTaxAmount

        public UnitPriceAmount getTaxAmount()
        EXT:Tax Amount
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CalculatedAmount
      • getVATTypeCodeOnLineLevel

        public Codes.VATTypeCode getVATTypeCodeOnLineLevel()
        BT-151-0:VAT type code on line level

        Value = VAT

        Fixed value "VAT"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:TypeCode
      • getExemptionReason

        public String getExemptionReason()
        EXT:VAT exemption reason (free text)
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:ExemptionReason
      • getInvoicedItemVATCategoryCode

        public Codes.VATCategoryCode getInvoicedItemVATCategoryCode()
        BT-151:Invoiced item VAT category code

        The VAT category code for the invoiced item.

        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)

        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

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

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCode
      • getVATExemptionReasonCode

        public Codes.VATExemptionReasonCode getVATExemptionReasonCode()
        EXT:VAT exemption reason code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:ExemptionReasonCode
      • getInvoicedItemVATRate

        public Percentage getInvoicedItemVATRate()
        BT-152:Invoiced item VAT rate

        The VAT rate, represented as percentage that applies to the invoiced item.

        The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent