Class VATBreakdown
BG-23 VAT BREAKDOWN — A group of business terms providing information about VAT breakdown by different categories, rates and exemption reasons
The EN 16931 business terms and groups implemented by this class:
| Represents | BG-23 |
|---|---|
| Business terms (value fields) | BT-8, BT-116, BT-117, BT-118, BT-118-0, BT-119, BT-120, BT-121 |
Documentation of the represented business group:
| Description | EN | A group of business terms providing information about VAT breakdown by different categories, rates and exemption reasons |
|---|---|---|
| FR | Groupe de termes métiers fournissant des informations sur la répartition de la TVA par types. | |
| Business rule | EN | BR-CO-18: An Invoice shall at least have one VAT breakdown group (BG-23). |
| FR | BR-CO-18 : Une Facture doit au moins avoir un groupe de Ventilation de la TVA (BG-23). |
- Since:
- 1.0.06/2.2
-
Method Summary
Modifier and TypeMethodDescriptionReturns BT-8 Value added tax point date code — The code of the date when the VAT becomes accountable for the Seller and for the Buyer.Returns BT-118 VAT category code — Coded identification of a VAT category.Returns BT-119 VAT category rate — The VAT rate, represented as percentage that applies for the relevant VAT category.Returns BT-116 VAT category taxable amount — Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).Returns BT-117 VAT category tax amount — The total VAT amount for a given VAT category.Returns BT-121 VAT exemption reason code — A coded statement of the reason for why the amount is exempted from VAT.Returns BT-120 VAT exemption reason text — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being chargedReturns BT-118-0 VAT type code — Coded identification of a VAT category.Sets BT-8 Value added tax point date code — The code of the date when the VAT becomes accountable for the Seller and for the Buyer.Sets BT-118 VAT category code — Coded identification of a VAT category.setVATCategoryRate(Percentage value) Sets BT-119 VAT category rate — The VAT rate, represented as percentage that applies for the relevant VAT category.Sets BT-116 VAT category taxable amount — Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).setVATCategoryTaxAmount(Amount value) Sets BT-117 VAT category tax amount — The total VAT amount for a given VAT category.Sets BT-121 VAT exemption reason code — A coded statement of the reason for why the amount is exempted from VAT.setVATExemptionReasonText(String value) Sets BT-120 VAT exemption reason text — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being charged
-
Method Details
-
setVATCategoryTaxableAmount
Sets BT-116 VAT category taxable amount — Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).Usage: The sum of Invoice line net amount minus allowances plus charges on document level which are subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).
Rule: BR-45: Each VAT breakdown (BG-23) shall have a VAT category taxable amount (BT-116).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:BasisAmountFR: Base d'imposition du type de TVA — Somme de tous les montants imposables assujettis à un code et à un taux de type de TVA spécifiques (si le Taux de type de TVA est applicable).
- Parameters:
value- the value to set- Returns:
- this
VATBreakdownfor chaining - Since:
- 1.0.06/2.2
-
setVATCategoryTaxAmount
Sets BT-117 VAT category tax amount — The total VAT amount for a given VAT category.Usage: Calculated by multiplying the VAT category taxable amount with the VAT category rate for the relevant VAT category.
Rule: BR-46: Each VAT breakdown (BG-23) shall have a VAT category tax amount (BT-117).BR-CO-17: VAT category tax amount (BT-117) = VAT category taxable amount (BT-116) x (VAT category rate (BT-119) / 100), rounded to two decimals.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:CalculatedAmountFR: Montant de la taxe pour le type de TVA — Montant total de la TVA pour un type donné de TVA.
- Parameters:
value- the value to set- Returns:
- this
VATBreakdownfor chaining - Since:
- 1.0.06/2.2
-
setVATCategoryCode
Sets BT-118 VAT category code — 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
Rule: BR-47: Each VAT breakdown (BG-23) shall be defined through a VAT category code (BT-118).For EXTENDED profile only, BR-O-11, BR-O-12, BR-O-13 and BR-O-14 are not applied.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCodeFR: Code de type de TVA — Identification codée d’un type de TVA.
- Parameters:
value- the value to set- Returns:
- this
VATBreakdownfor chaining - Since:
- 1.0.06/2.2
-
setVATCategoryRate
Sets BT-119 VAT category rate — 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.
Conditions (CIUS): The value to enter is the percentage. For example, for 20%, it must be given as 20 (and not 0.2)
Rule: BR-48: Each VAT breakdown (BG-23) shall have a VAT category rate (BT-119), except if the Invoice is not subject to VAT.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercentFR: Taux de type de TVA — Taux de TVA, exprimé sous forme de pourcentage, applicable au type de TVA correspondant.
- Parameters:
value- the value to set- Returns:
- this
VATBreakdownfor chaining - Since:
- 1.0.06/2.2
-
setVATExemptionReasonText
Sets BT-120 VAT exemption reason text — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being chargedUsage: Articles 226 items 11 to 15 Directive 2006/112/EC [2].
Conditions (CIUS): CHORUS PRO: this field is limited to 1024 characters
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/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
VATBreakdownfor chaining - Since:
- 1.0.06/2.2
-
setVATExemptionReasonCode
Sets BT-121 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:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/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
VATBreakdownfor chaining - Since:
- 1.0.06/2.2
-
setValueAddedTaxPointDateCode
Sets BT-8 Value added tax point date code — The code of the date when the VAT becomes accountable for the Seller 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 not be present if the Value added tax point date is provided directly in the "Value added tax point date" (BT-7). 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)
Rule: BR-CO-3: Value added tax point date (BT-7) and Value added tax point date code (BT-8) are mutually exclusive.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:DueDateTypeCodeFR: Date d'exigibilité de la taxe sur la valeur ajoutée en code — Code spécifiant la date à laquelle la TVA devient imputable pour le Vendeur et pour l'Acheteur
- Parameters:
value- the value to set- Returns:
- this
VATBreakdownfor chaining - Since:
- 1.0.06/2.2
-
getVATCategoryTaxableAmount
Returns BT-116 VAT category taxable amount — Sum of all taxable amounts subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).Usage: The sum of Invoice line net amount minus allowances plus charges on document level which are subject to a specific VAT category code and VAT category rate (if the VAT category rate is applicable).
Rule: BR-45: Each VAT breakdown (BG-23) shall have a VAT category taxable amount (BT-116).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:BasisAmountFR: Base d'imposition du type de TVA — Somme de tous les montants imposables assujettis à un code et à un taux de type de TVA spécifiques (si le Taux de type de TVA est applicable).
- Returns:
- the
BT-116value - Since:
- 1.0.06/2.2
-
getVATCategoryTaxAmount
Returns BT-117 VAT category tax amount — The total VAT amount for a given VAT category.Usage: Calculated by multiplying the VAT category taxable amount with the VAT category rate for the relevant VAT category.
Rule: BR-46: Each VAT breakdown (BG-23) shall have a VAT category tax amount (BT-117).BR-CO-17: VAT category tax amount (BT-117) = VAT category taxable amount (BT-116) x (VAT category rate (BT-119) / 100), rounded to two decimals.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:CalculatedAmountFR: Montant de la taxe pour le type de TVA — Montant total de la TVA pour un type donné de TVA.
- Returns:
- the
BT-117value - Since:
- 1.0.06/2.2
-
getVATCategoryCode
Returns BT-118 VAT category code — 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
Rule: BR-47: Each VAT breakdown (BG-23) shall be defined through a VAT category code (BT-118).For EXTENDED profile only, BR-O-11, BR-O-12, BR-O-13 and BR-O-14 are not applied.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCodeFR: Code de type de TVA — Identification codée d’un type de TVA.
- Returns:
- the
BT-118value - Since:
- 1.0.06/2.2
-
getVATTypeCode
Returns BT-118-0 VAT type code — Coded identification of a VAT category.Usage: The VAT category code and the VAT category rate shall be consistent. For more information on the recommended codes, please refer to subclause 6.3.3.2 - Specification of VAT category codes.Fix value = "VAT"
Rule: Fixed value "VAT"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:TypeCodeFR: Code de type de TVA — Coded identification of a VAT category.
- Returns:
- the
BT-118-0value - Throws:
ComputationException- Since:
- 1.0.06/2.2
-
getVATCategoryRate
Returns BT-119 VAT category rate — 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.
Conditions (CIUS): The value to enter is the percentage. For example, for 20%, it must be given as 20 (and not 0.2)
Rule: BR-48: Each VAT breakdown (BG-23) shall have a VAT category rate (BT-119), except if the Invoice is not subject to VAT.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercentFR: Taux de type de TVA — Taux de TVA, exprimé sous forme de pourcentage, applicable au type de TVA correspondant.
- Returns:
- the
BT-119value - Since:
- 1.0.06/2.2
-
getVATExemptionReasonText
Returns BT-120 VAT exemption reason text — A textual statement of the reason why the amount is exempted from VAT or why no VAT is being chargedUsage: Articles 226 items 11 to 15 Directive 2006/112/EC [2].
Conditions (CIUS): CHORUS PRO: this field is limited to 1024 characters
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:ExemptionReasonFR: Motif d'exonération de la TVA — Énoncé expliquant pourquoi un montant est exonéré de TVA.
- Returns:
- the
BT-120value - Since:
- 1.0.06/2.2
-
getVATExemptionReasonCode
Returns BT-121 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:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:ExemptionReasonCodeFR: Motif d'exonération de la TVA en code — Code expliquant pourquoi un montant est exonéré de TVA.
- Returns:
- the
BT-121value - Since:
- 1.0.06/2.2
-
getValueAddedTaxPointDateCode
Returns BT-8 Value added tax point date code — The code of the date when the VAT becomes accountable for the Seller 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 not be present if the Value added tax point date is provided directly in the "Value added tax point date" (BT-7). 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)
Rule: BR-CO-3: Value added tax point date (BT-7) and Value added tax point date code (BT-8) are mutually exclusive.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ApplicableTradeTax/ram:DueDateTypeCodeFR: Date d'exigibilité de la taxe sur la valeur ajoutée en code — Code spécifiant la date à laquelle la TVA devient imputable pour le Vendeur et pour l'Acheteur
- Returns:
- the
BT-8value - Since:
- 1.0.06/2.2
-