Class InvoiceLineAllowances
BG-27 INVOICE LINE ALLOWANCES — A group of business terms providing information about allowances applicable to the individual Invoice line.
The EN 16931 business terms and groups implemented by this class:
| Represents | BG-27 |
|---|---|
| Covers | BG-27-0 |
| Business terms (value fields) | BG-27-1, BG-28-1, BT-136, BT-137, BT-138, BT-139, BT-140, BT-141, BT-142, BT-143, BT-144, BT-145, BT-193, BT-193-1 |
Documentation of the represented business group:
| Description | EN | A group of business terms providing information about allowances applicable to the individual Invoice line. |
|---|---|---|
| FR | Groupe de termes métiers fournissant des informations sur les remises applicables à une ligne de Facture. | |
| Conditions (CIUS) | EN | Invoice line allowancess are subject to the same VAT rate as the line they relate to. If invoice line allowances are subject to a different VAT rate, they must be treated as standalone (negative) invoice lines |
| FR | Les remises de ligne sont soumises au même taux de TVA que celui de la ligne auxquelles elles se rapportent. Si des remises font l'objet d'un taux de TVA différent, elle doivent être traitées comme des lignes de facture autonomes (négatives) | |
| Business rule | EN | ChargeIndicator=false |
| FR | ChargeIndicator=false |
- Since:
- 1.0.06/2.2
-
Method Summary
Modifier and TypeMethodDescriptionReturns BG-27-1 Allowances indicator value.Returns BT-136 Invoice line allowance amount — The amount of an allowance, without VAT.Returns BT-137 Invoice line allowance base amount — The base amount that may be used, in conjunction with the Invoice line allowance percentage, to calculate the Invoice line allowance amount.Returns BT-138 Invoice line allowance percentage — The percentage that may be used, in conjunction with the Invoice line allowance base amount, to calculate the Invoice line allowance amount.Returns BT-139 Invoice line allowance reason — The reason for the Invoice line allowance, expressed as text.Returns BT-140 Invoice line allowance reason code — The reason for the Invoice line allowance, expressed as a code.Sets BT-136 Invoice line allowance amount — The amount of an allowance, without VAT.Sets BT-137 Invoice line allowance base amount — The base amount that may be used, in conjunction with the Invoice line allowance percentage, to calculate the Invoice line allowance amount.Sets BT-138 Invoice line allowance percentage — The percentage that may be used, in conjunction with the Invoice line allowance base amount, to calculate the Invoice line allowance amount.Sets BT-139 Invoice line allowance reason — The reason for the Invoice line allowance, expressed as text.Sets BT-140 Invoice line allowance reason code — The reason for the Invoice line allowance, expressed as a code.
-
Method Details
-
setInvoiceLineAllowanceAmount
Sets BT-136 Invoice line allowance amount — The amount of an allowance, without VAT.Rule: BR-41: Each Invoice line allowance (BG-27) shall have an Invoice line allowance amount (BT-136).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmountFR: Montant de la remise applicable à la ligne de facture — Montant d'une remise, hors TVA.
- Parameters:
value- the value to set- Returns:
- this
InvoiceLineAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setInvoiceLineAllowanceBaseAmount
Sets BT-137 Invoice line allowance base amount — The base amount that may be used, in conjunction with the Invoice line allowance percentage, to calculate the Invoice line allowance amount.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisAmountFR: Assiette de la remise applicable à la ligne de facture — Montant de base pouvant être utilisé conjointement avec le Pourcentage de remise applicable à la ligne de facture pour calculer le Montant de la remise applicable à la ligne de facture.
- Parameters:
value- the value to set- Returns:
- this
InvoiceLineAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setInvoiceLineAllowancePercentage
Sets BT-138 Invoice line allowance percentage — The percentage that may be used, in conjunction with the Invoice line allowance base amount, to calculate the Invoice line allowance amount.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:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercentFR: Pourcentage de remise applicable à la ligne de facture — Pourcentage pouvant être utilisé conjointement avec l'Assiette de la remise applicable à la ligne de facture pour calculer le Montant de la remise applicable à la ligne de facture.
- Parameters:
value- the value to set- Returns:
- this
InvoiceLineAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setInvoiceLineAllowanceReason
Sets BT-139 Invoice line allowance reason — The reason for the Invoice line allowance, expressed as text.Rule: BR-42: Each Invoice line allowance (BG-27) shall have an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140).BR-CO-7: Invoice line allowance reason code (BT-140) and Invoice line allowance reason (BT-139) shall indicate the same type of allowance reason.BR-CO-23: Each Invoice line allowance (BG-27) shall contain an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140), or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonFR: Motif de la remise applicable à la ligne de facture — Motif de la remise applicable à la ligne de Facture, exprimé sous forme de texte.
- Parameters:
value- the value to set- Returns:
- this
InvoiceLineAllowancesfor chaining - Since:
- 1.0.06/2.2
-
setInvoiceLineAllowanceReasonCode
public InvoiceLineAllowances setInvoiceLineAllowanceReasonCode(Codes.SubsetForAllowanceIdentificationCode value) Sets BT-140 Invoice line allowance reason code — The reason for the Invoice line allowance, expressed as a code.Usage: Use entries of the UNTDID 5189 code list [6]. The Invoice line level allowance reason code and the Invoice line level allowance reason shall indicate the same allowance reason.
Conditions (CIUS): In particular, the following codes and reasons can be used:AA = Advertising discountABL = Packing supplementADR = Other servicesADT = RemovalFC = transportation costsFI = Financial expensesLA = Labeling
Rule: BR-42: Each Invoice line allowance (BG-27) shall have an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140).BR-CO-7: Invoice line allowance reason code (BT-140) and Invoice line allowance reason (BT-139) shall indicate the same type of allowance reason.BR-CO-23: Each Invoice line allowance (BG-27) shall contain an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140), or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonCodeFR: Code de motif de la remise applicable à la ligne de facture — Motif de la remise applicable à la ligne de Facture, exprimé sous forme de code.
- Parameters:
value- the value to set- Returns:
- this
InvoiceLineAllowancesfor chaining - Since:
- 1.0.06/2.2
-
getAllowancesIndicatorValue
Returns BG-27-1 Allowances indicator value.Usage: Value = false
Rule: Value = false
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ChargeIndicator/udt:IndicatorFR: Valeur de l'indicateur de charge
- Returns:
- the
BG-27-1value - Since:
- 1.0.06/2.2
-
getInvoiceLineAllowanceAmount
Returns BT-136 Invoice line allowance amount — The amount of an allowance, without VAT.Rule: BR-41: Each Invoice line allowance (BG-27) shall have an Invoice line allowance amount (BT-136).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmountFR: Montant de la remise applicable à la ligne de facture — Montant d'une remise, hors TVA.
- Returns:
- the
BT-136value - Since:
- 1.0.06/2.2
-
getInvoiceLineAllowanceBaseAmount
Returns BT-137 Invoice line allowance base amount — The base amount that may be used, in conjunction with the Invoice line allowance percentage, to calculate the Invoice line allowance amount.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisAmountFR: Assiette de la remise applicable à la ligne de facture — Montant de base pouvant être utilisé conjointement avec le Pourcentage de remise applicable à la ligne de facture pour calculer le Montant de la remise applicable à la ligne de facture.
- Returns:
- the
BT-137value - Since:
- 1.0.06/2.2
-
getInvoiceLineAllowancePercentage
Returns BT-138 Invoice line allowance percentage — The percentage that may be used, in conjunction with the Invoice line allowance base amount, to calculate the Invoice line allowance amount.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:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercentFR: Pourcentage de remise applicable à la ligne de facture — Pourcentage pouvant être utilisé conjointement avec l'Assiette de la remise applicable à la ligne de facture pour calculer le Montant de la remise applicable à la ligne de facture.
- Returns:
- the
BT-138value - Since:
- 1.0.06/2.2
-
getInvoiceLineAllowanceReason
Returns BT-139 Invoice line allowance reason — The reason for the Invoice line allowance, expressed as text.Rule: BR-42: Each Invoice line allowance (BG-27) shall have an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140).BR-CO-7: Invoice line allowance reason code (BT-140) and Invoice line allowance reason (BT-139) shall indicate the same type of allowance reason.BR-CO-23: Each Invoice line allowance (BG-27) shall contain an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140), or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonFR: Motif de la remise applicable à la ligne de facture — Motif de la remise applicable à la ligne de Facture, exprimé sous forme de texte.
- Returns:
- the
BT-139value - Since:
- 1.0.06/2.2
-
getInvoiceLineAllowanceReasonCode
Returns BT-140 Invoice line allowance reason code — The reason for the Invoice line allowance, expressed as a code.Usage: Use entries of the UNTDID 5189 code list [6]. The Invoice line level allowance reason code and the Invoice line level allowance reason shall indicate the same allowance reason.
Conditions (CIUS): In particular, the following codes and reasons can be used:AA = Advertising discountABL = Packing supplementADR = Other servicesADT = RemovalFC = transportation costsFI = Financial expensesLA = Labeling
Rule: BR-42: Each Invoice line allowance (BG-27) shall have an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140).BR-CO-7: Invoice line allowance reason code (BT-140) and Invoice line allowance reason (BT-139) shall indicate the same type of allowance reason.BR-CO-23: Each Invoice line allowance (BG-27) shall contain an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140), or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonCodeFR: Code de motif de la remise applicable à la ligne de facture — Motif de la remise applicable à la ligne de Facture, exprimé sous forme de code.
- Returns:
- the
BT-140value - Since:
- 1.0.06/2.2
-