Class InvoiceLineAllowances

java.lang.Object
com.fourjs.report.facturx.profiles.en16931.InvoiceLineAllowances

public class InvoiceLineAllowances extends Object
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:

Business terms and groups implemented
RepresentsBG-27
CoversBG-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

Documentation of the represented business group:

BG-27 — INVOICE LINE ALLOWANCES
DescriptionENA group of business terms providing information about allowances applicable to the individual Invoice line.
FRGroupe de termes métiers fournissant des informations sur les remises applicables à une ligne de Facture.
Conditions (CIUS)ENInvoice 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
FRLes 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 ruleENChargeIndicator=false
FRChargeIndicator=false
Since:
1.0.06/2.2
  • Method Details

    • setInvoiceLineAllowanceAmount

      public InvoiceLineAllowances setInvoiceLineAllowanceAmount(Amount value)
      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:ActualAmount

      FR: Montant de la remise applicable à la ligne de facture — Montant d'une remise, hors TVA.

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

      public InvoiceLineAllowances setInvoiceLineAllowanceBaseAmount(Amount value)
      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:BasisAmount

      FR: 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 InvoiceLineAllowances for chaining
      Since:
      1.0.06/2.2
    • setInvoiceLineAllowancePercentage

      public InvoiceLineAllowances setInvoiceLineAllowancePercentage(Percentage value)
      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:CalculationPercent

      FR: 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 InvoiceLineAllowances for chaining
      Since:
      1.0.06/2.2
    • setInvoiceLineAllowanceReason

      public InvoiceLineAllowances setInvoiceLineAllowanceReason(String value)
      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:Reason

      FR: 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 InvoiceLineAllowances for 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:ReasonCode

      FR: 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 InvoiceLineAllowances for chaining
      Since:
      1.0.06/2.2
    • getAllowancesIndicatorValue

      public Boolean 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:Indicator

      FR: Valeur de l'indicateur de charge

      Returns:
      the BG-27-1 value
      Since:
      1.0.06/2.2
    • getInvoiceLineAllowanceAmount

      public Amount 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:ActualAmount

      FR: Montant de la remise applicable à la ligne de facture — Montant d'une remise, hors TVA.

      Returns:
      the BT-136 value
      Since:
      1.0.06/2.2
    • getInvoiceLineAllowanceBaseAmount

      public Amount 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:BasisAmount

      FR: 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-137 value
      Since:
      1.0.06/2.2
    • getInvoiceLineAllowancePercentage

      public Percentage 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:CalculationPercent

      FR: 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-138 value
      Since:
      1.0.06/2.2
    • getInvoiceLineAllowanceReason

      public String 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:Reason

      FR: 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-139 value
      Since:
      1.0.06/2.2
    • getInvoiceLineAllowanceReasonCode

      public Object 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:ReasonCode

      FR: 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-140 value
      Since:
      1.0.06/2.2