Class IncludedTax
BG-X-46 INCLUDED TAX — Tax information on advanced payments
The EN 16931 business terms and groups implemented by this class:
| Represents | BG-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:
| Description | EN | Tax information on advanced payments |
|---|
- Since:
- 1.0.06/2.2
-
Method Summary
Modifier and TypeMethodDescriptionReturns BT-X-293 CalculatedAmount.Returns BT-X-296 CategoryCode — Coded identification of a VAT category.Returns BT-X-295 ExemptionReason — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being chargedReturns BT-X-297 ExemptionReasonCode — A coded statement of the reason for why the amount is exempted from VAT.Returns BT-X-298 RateApplicablePercent — The VAT rate, represented as percentage that applies for the relevant VAT category.Returns BT-X-294 TypeCode.setCalculatedAmount(Decimal value) Sets BT-X-293 CalculatedAmount.Sets BT-X-296 CategoryCode — Coded identification of a VAT category.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 chargedSets BT-X-297 ExemptionReasonCode — A coded statement of the reason for why the amount is exempted from VAT.setRateApplicablePercent(Decimal value) Sets BT-X-298 RateApplicablePercent — The VAT rate, represented as percentage that applies for the relevant VAT category.
-
Method Details
-
setCalculatedAmount
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
IncludedTaxfor chaining - Since:
- 1.0.06/2.2
-
setExemptionReason
Sets BT-X-295 ExemptionReason — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being chargedXPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:ExemptionReasonFR: 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
IncludedTaxfor chaining - Since:
- 1.0.06/2.2
-
setCategoryCode
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:CategoryCodeFR: 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
IncludedTaxfor chaining - Since:
- 1.0.06/2.2
-
setExemptionReasonCode
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:ExemptionReasonCodeFR: 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
IncludedTaxfor chaining - Since:
- 1.0.06/2.2
-
setRateApplicablePercent
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:RateApplicablePercentFR: 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
IncludedTaxfor chaining - Since:
- 1.0.06/2.2
-
getCalculatedAmount
Returns BT-X-293 CalculatedAmount.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:CalculatedAmount- Returns:
- the
BT-X-293value - Since:
- 1.0.06/2.2
-
getTypeCode
Returns BT-X-294 TypeCode.Usage: Value = VAT
Rule: Fixed value "VAT"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:TypeCodeFR: Code de type de TVA
- Returns:
- the
BT-X-294value - Throws:
ComputationException- Since:
- 1.0.06/2.2
-
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 chargedXPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:IncludedTradeTax/ram:ExemptionReasonFR: Motif d'exonération de la TVA — Énoncé expliquant pourquoi un montant est exonéré de TVA.
- Returns:
- the
BT-X-295value - Since:
- 1.0.06/2.2
-
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:CategoryCodeFR: 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-296value - Since:
- 1.0.06/2.2
-
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:ExemptionReasonCodeFR: Motif d'exonération de la TVA en code — Code expliquant pourquoi un montant est exonéré de TVA.
- Returns:
- the
BT-X-297value - Since:
- 1.0.06/2.2
-
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:RateApplicablePercentFR: 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-298value - Since:
- 1.0.06/2.2
-