Class IncludedTax

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

public class IncludedTax extends Object
BG-X-46 INCLUDED TAX — Tax information on advanced payments

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

Business terms and groups implemented
RepresentsBG-X-46
Business terms (value fields)BT-X-293, BT-X-294, BT-X-295, BT-X-296, BT-X-297, BT-X-298

Documentation of the represented business group:

BG-X-46 — INCLUDED TAX
DescriptionENTax information on advanced payments
Since:
1.0.06/2.2
  • Method Details

    • setCalculatedAmount

      public IncludedTax setCalculatedAmount(Decimal value)
      Sets BT-X-293 CalculatedAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:CalculatedAmount

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

      public IncludedTax setExemptionReason(String value)
      Sets BT-X-295 ExemptionReason — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/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 IncludedTax for chaining
      Since:
      1.0.06/2.2
    • setCategoryCode

      public IncludedTax setCategoryCode(Codes.VATCategoryCode value)
      Sets BT-X-296 CategoryCode — Coded identification of a VAT category.

      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

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:CategoryCode

      FR: Code de type de TVA de la remise ou de la charge au niveau du document — Identification codée d’un type de TVA.

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

      public IncludedTax setExemptionReasonCode(Codes.VATExemptionReasonCode value)
      Sets BT-X-297 ExemptionReasonCode — 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:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/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 IncludedTax for chaining
      Since:
      1.0.06/2.2
    • setRateApplicablePercent

      public IncludedTax setRateApplicablePercent(Decimal value)
      Sets BT-X-298 RateApplicablePercent — The VAT rate, represented as percentage that applies for the relevant VAT category.

      Usage: The VAT category code and the VAT category rate shall be consistent.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:RateApplicablePercent

      FR: Taux de TVA de la remise ou de la charge au niveau du document — Taux de TVA, exprimé sous forme de pourcentage, applicable au type de TVA correspondant.

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

      public Decimal getCalculatedAmount()
      Returns BT-X-293 CalculatedAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:CalculatedAmount

      Returns:
      the BT-X-293 value
      Since:
      1.0.06/2.2
    • getTypeCode

      public Codes.VATTypeCode getTypeCode() throws ComputationException
      Returns BT-X-294 TypeCode.

      Usage: Value = VAT

      Rule: Fixed value "VAT"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:TypeCode

      FR: Code de type de TVA

      Returns:
      the BT-X-294 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
    • getExemptionReason

      public String getExemptionReason()
      Returns BT-X-295 ExemptionReason — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:ExemptionReason

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

      Returns:
      the BT-X-295 value
      Since:
      1.0.06/2.2
    • getCategoryCode

      public Codes.VATCategoryCode getCategoryCode()
      Returns BT-X-296 CategoryCode — Coded identification of a VAT category.

      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

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:CategoryCode

      FR: Code de type de TVA de la remise ou de la charge au niveau du document — Identification codée d’un type de TVA.

      Returns:
      the BT-X-296 value
      Since:
      1.0.06/2.2
    • getExemptionReasonCode

      public Codes.VATExemptionReasonCode getExemptionReasonCode()
      Returns BT-X-297 ExemptionReasonCode — 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:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/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-297 value
      Since:
      1.0.06/2.2
    • getRateApplicablePercent

      public Decimal getRateApplicablePercent()
      Returns BT-X-298 RateApplicablePercent — The VAT rate, represented as percentage that applies for the relevant VAT category.

      Usage: The VAT category code and the VAT category rate shall be consistent.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:RateApplicablePercent

      FR: Taux de TVA de la remise ou de la charge au niveau du document — Taux de TVA, exprimé sous forme de pourcentage, applicable au type de TVA correspondant.

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