Class DocumentLevelAllowances
BG-20 DOCUMENT LEVEL ALLOWANCES — A group of business terms providing information about allowances applicable to the Invoice as a whole.
The EN 16931 business terms and groups implemented by this class:
| Represents | BG-20 |
|---|---|
| Covers | BG-20-0, BT-95-00 |
| Business terms (value fields) | BG-20-1, BG-21-1, BT-92, BT-93, BT-94, BT-95, BT-95-0, BT-96, BT-97, BT-98, BT-99, BT-100, BT-101, BT-102, BT-102-0, BT-103, BT-104, BT-105 |
Documentation of the represented business group:
| Description | EN | A group of business terms providing information about allowances applicable to the Invoice as a whole. |
|---|---|---|
| FR | Groupe de termes métiers fournissant des informations sur les remises applicables à la Facture dans son ensemble. | |
| Usage note | EN | Deductions, such as withheld tax may also be specified in this group. |
| FR | Les déductions telles que la taxe retenue à la source peuvent donc être spécifiés dans ce groupe. | |
| Business rule | EN | ChargeIndicator=false |
| FR | ChargeIndicator=false |
- Since:
- 1.0.06/2.2
-
Method Summary
Modifier and TypeMethodDescriptionReturns BG-20-1 Allowance or Charge indicator Value.Returns BT-92 Document level allowance amount — The amount of an allowance, without VAT.Returns BT-93 Document level allowance base amount — The base amount that may be used, in conjunction with the document level allowance percentage, to calculate the document level allowance amount.Returns BT-94 Document level allowance percentage — The percentage that may be used, in conjunction with the document level allowance base amount, to calculate the document level allowance amount.Returns BT-97 Document level allowance reason — The reason for the document level allowance, expressed as text.Returns BT-98 Document level allowance reason code — The reason for the document level allowance, expressed as a code.Returns BT-95 Document level allowance VAT category code — A coded identification of what VAT category applies to the document level allowance.Returns BT-96 Document level allowance VAT rate — The VAT rate, represented as percentage that applies to the document level allowance.Returns BT-95-0 VAT type code for document level allowances.Sets BT-92 Document level allowance amount — The amount of an allowance, without VAT.Sets BT-93 Document level allowance base amount — The base amount that may be used, in conjunction with the document level allowance percentage, to calculate the document level allowance amount.Sets BT-94 Document level allowance percentage — The percentage that may be used, in conjunction with the document level allowance base amount, to calculate the document level allowance amount.Sets BT-97 Document level allowance reason — The reason for the document level allowance, expressed as text.Sets BT-98 Document level allowance reason code — The reason for the document level allowance, expressed as a code.Sets BT-95 Document level allowance VAT category code — A coded identification of what VAT category applies to the document level allowance.Sets BT-96 Document level allowance VAT rate — The VAT rate, represented as percentage that applies to the document level allowance.
-
Method Details
-
setDocumentLevelAllowanceAmount
Sets BT-92 Document level allowance amount — The amount of an allowance, without VAT.Rule: BR-31: Each Document level allowance (BG-20) shall have a Document level allowance amount (BT-92).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmountFR: Montant de la remise au niveau du document — Montant d'une remise de pied, hors TVA.
- Parameters:
value- the value to set- Returns:
- this
DocumentLevelAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setDocumentLevelAllowanceBaseAmount
Sets BT-93 Document level allowance base amount — The base amount that may be used, in conjunction with the document level allowance percentage, to calculate the document level allowance amount.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisAmountFR: Assiette de la remise au niveau du document — Montant de base pouvant être utilisé conjointement avec le Pourcentage de remise au niveau du document pour calculer le Montant de la remise au niveau du document.
- Parameters:
value- the value to set- Returns:
- this
DocumentLevelAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setDocumentLevelAllowancePercentage
Sets BT-94 Document level allowance percentage — The percentage that may be used, in conjunction with the document level allowance base amount, to calculate the document level allowance amount.Conditions (CIUS): 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:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercentFR: Pourcentage de remise au niveau du document — Pourcentage pouvant être utilisé conjointement avec l'Assiette de la remise au niveau du document pour calculer le Montant de la remise au niveau du document.
- Parameters:
value- the value to set- Returns:
- this
DocumentLevelAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setDocumentLevelAllowanceVATCategoryCode
public DocumentLevelAllowances setDocumentLevelAllowanceVATCategoryCode(Codes.VATCategoryCode value) Sets BT-95 Document level allowance VAT category code — A coded identification of what VAT category applies to the document level allowance.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-32: Each Document level allowance (BG-20) shall have a Document level allowance VAT category code (BT-95).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:CategoryCodeFR: Code de type de TVA de la remise au niveau du document — Identification codée du type de TVA applicable à la remise au niveau du document.
- Parameters:
value- the value to set- Returns:
- this
DocumentLevelAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setDocumentLevelAllowanceVATRate
Sets BT-96 Document level allowance VAT rate — The VAT rate, represented as percentage that applies to the document level allowance.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:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:RateApplicablePercentFR: Taux de TVA de la remise au niveau du document — Taux de TVA, exprimé sous forme de pourcentage, applicable à la remise au niveau du document.
- Parameters:
value- the value to set- Returns:
- this
DocumentLevelAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setDocumentLevelAllowanceReason
Sets BT-97 Document level allowance reason — The reason for the document level allowance, expressed as text.Conditions (CIUS): CHORUS PRO: this field is limited to 1024 characters
Rule: BR-33: Each Document level allowance (BG-20) shall have a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98).BR-CO-5: Document level allowance reason code (BT-98) and Document level allowance reason (BT-97) shall indicate the same type of allowance.BR-CO-21: Each Document level allowance (BG-20) shall contain a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98), or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonFR: Motif de la remise au niveau du document — Motif de la remise au niveau du document, exprimé sous forme de texte.
- Parameters:
value- the value to set- Returns:
- this
DocumentLevelAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setDocumentLevelAllowanceReasonCode
public DocumentLevelAllowances setDocumentLevelAllowanceReasonCode(Codes.SubsetForAllowanceIdentificationCode value) Sets BT-98 Document level allowance reason code — The reason for the document level allowance, expressed as a code.Usage: Use entries of the UNTDID 5189 code list [6]. The Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason.
Rule: BR-33: Each Document level allowance (BG-20) shall have a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98).BR-CO-5: Document level allowance reason code (BT-98) and Document level allowance reason (BT-97) shall indicate the same type of allowance.BR-CO-21: Each Document level allowance (BG-20) shall contain a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98), or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonCodeFR: Code de motif de la remise au niveau du document — Motif de la remise au niveau du document, exprimé sous forme de code.
- Parameters:
value- the value to set- Returns:
- this
DocumentLevelAllowancesfor chaining - Since:
- 1.0.06/2.2
-
getAllowanceOrChargeIndicatorValue
Returns BG-20-1 Allowance or Charge indicator Value.Usage: Value = false
Rule: Value = false
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ChargeIndicator/udt:IndicatorFR: Valeur de l'indicateur de charge
- Returns:
- the
BG-20-1value - Since:
- 1.0.06/2.2
-
getDocumentLevelAllowanceAmount
Returns BT-92 Document level allowance amount — The amount of an allowance, without VAT.Rule: BR-31: Each Document level allowance (BG-20) shall have a Document level allowance amount (BT-92).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmountFR: Montant de la remise au niveau du document — Montant d'une remise de pied, hors TVA.
- Returns:
- the
BT-92value - Since:
- 1.0.06/2.2
-
getDocumentLevelAllowanceBaseAmount
Returns BT-93 Document level allowance base amount — The base amount that may be used, in conjunction with the document level allowance percentage, to calculate the document level allowance amount.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisAmountFR: Assiette de la remise au niveau du document — Montant de base pouvant être utilisé conjointement avec le Pourcentage de remise au niveau du document pour calculer le Montant de la remise au niveau du document.
- Returns:
- the
BT-93value - Since:
- 1.0.06/2.2
-
getDocumentLevelAllowancePercentage
Returns BT-94 Document level allowance percentage — The percentage that may be used, in conjunction with the document level allowance base amount, to calculate the document level allowance amount.Conditions (CIUS): 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:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercentFR: Pourcentage de remise au niveau du document — Pourcentage pouvant être utilisé conjointement avec l'Assiette de la remise au niveau du document pour calculer le Montant de la remise au niveau du document.
- Returns:
- the
BT-94value - Since:
- 1.0.06/2.2
-
getDocumentLevelAllowanceVATCategoryCode
Returns BT-95 Document level allowance VAT category code — A coded identification of what VAT category applies to the document level allowance.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-32: Each Document level allowance (BG-20) shall have a Document level allowance VAT category code (BT-95).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:CategoryCodeFR: Code de type de TVA de la remise au niveau du document — Identification codée du type de TVA applicable à la remise au niveau du document.
- Returns:
- the
BT-95value - Since:
- 1.0.06/2.2
-
getVATTypeCodeForDocumentLevelAllowances
Returns BT-95-0 VAT type code for document level allowances.Usage: Value = VAT
Rule: Fixed value "VAT"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:TypeCodeFR: Code de type de TVA de la remise au niveau du document
- Returns:
- the
BT-95-0value - Throws:
ComputationException- Since:
- 1.0.06/2.2
-
getDocumentLevelAllowanceVATRate
Returns BT-96 Document level allowance VAT rate — The VAT rate, represented as percentage that applies to the document level allowance.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:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:RateApplicablePercentFR: Taux de TVA de la remise au niveau du document — Taux de TVA, exprimé sous forme de pourcentage, applicable à la remise au niveau du document.
- Returns:
- the
BT-96value - Since:
- 1.0.06/2.2
-
getDocumentLevelAllowanceReason
Returns BT-97 Document level allowance reason — The reason for the document level allowance, expressed as text.Conditions (CIUS): CHORUS PRO: this field is limited to 1024 characters
Rule: BR-33: Each Document level allowance (BG-20) shall have a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98).BR-CO-5: Document level allowance reason code (BT-98) and Document level allowance reason (BT-97) shall indicate the same type of allowance.BR-CO-21: Each Document level allowance (BG-20) shall contain a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98), or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonFR: Motif de la remise au niveau du document — Motif de la remise au niveau du document, exprimé sous forme de texte.
- Returns:
- the
BT-97value - Since:
- 1.0.06/2.2
-
getDocumentLevelAllowanceReasonCode
Returns BT-98 Document level allowance reason code — The reason for the document level allowance, expressed as a code.Usage: Use entries of the UNTDID 5189 code list [6]. The Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason.
Rule: BR-33: Each Document level allowance (BG-20) shall have a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98).BR-CO-5: Document level allowance reason code (BT-98) and Document level allowance reason (BT-97) shall indicate the same type of allowance.BR-CO-21: Each Document level allowance (BG-20) shall contain a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98), or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonCodeFR: Code de motif de la remise au niveau du document — Motif de la remise au niveau du document, exprimé sous forme de code.
- Returns:
- the
BT-98value - Since:
- 1.0.06/2.2
-