Class AppliedTradeAllowanceCharge

java.lang.Object
com.fourjs.report.facturx.profiles.extended.AppliedTradeAllowanceCharge

public class AppliedTradeAllowanceCharge extends Object
BT-147-00 (((Item price discount))), BT-X-302-00 (((Item price charge))).

The EN 16931 business terms and groups implemented by this class:

Business terms and groups implemented
RepresentsBT-X-302-00, BT-147-00
CoversBT-X-302-01, BT-147-01
Business terms (value fields)BT-X-34, BT-X-35, BT-X-36, BT-X-300, BT-X-301, BT-X-302, BT-X-302-02, BT-X-303, BT-X-313, BT-X-314, BT-X-616, BT-X-616-1, BT-147, BT-147-02
Since:
1.0.06/2.2
  • Method Details

    • setItemPriceDiscount

      public AppliedTradeAllowanceCharge setItemPriceDiscount(UnitPriceAmount value)
      Sets BT-147 Item price discount — The total discount subtracted from the Item gross price to calculate the Item net price.

      Usage: Only applies if the discount is provided per unit and if it is not included in the Item gross price.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ActualAmount

      FR: Rabais sur le prix de l'article — Remise totale qui, une fois soustraite du Prix brut de l'article, donne le Prix net de l'article.

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

      Sets BT-X-313 Reason for the discount (code) — The code specifying the reason for this trade allowance.

      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.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode

      FR: Motif de la réduction (code)

      Parameters:
      value - the value to set
      Returns:
      this AppliedTradeAllowanceCharge for chaining
      Since:
      1.09.2/2.5.2
    • setReasonCode

      Sets BT-X-314 Reason for the charge (code) — The code specifying the reason for this trade allowance.

      Usage: Use entries of the UNTDID 7161 code list . The order line level item trade price discount reason code and the order line level item trade price discount reason shall indicate the same item trade price charge reason. Example AEW for WEEE.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode

      FR: Motif du supplément (code)

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

      public AppliedTradeAllowanceCharge setDiscountInPercent(Percentage value)
      Sets BT-X-34 Discount in percent — The percentage applied to calculate this trade allowance

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:CalculationPercent

      FR: Réduction en pourcentage

      Parameters:
      value - the value to set
      Returns:
      this AppliedTradeAllowanceCharge for chaining
      Since:
      1.09.2/2.5.2
    • setDiscountBaseAmount

      public AppliedTradeAllowanceCharge setDiscountBaseAmount(UnitPriceAmount value)
      Sets BT-X-35 Discount base amount — The monetary value that is the basis on which this trade allowance is calculated.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:BasisAmount

      FR: Montant de base de la réduction

      Parameters:
      value - the value to set
      Returns:
      this AppliedTradeAllowanceCharge for chaining
      Since:
      1.09.2/2.5.2
    • setReason

      public AppliedTradeAllowanceCharge setReason(String value)
      Sets BT-X-36 Reason for the discount (free text) — The Text specifying the reason for this trade allowance.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:Reason

      FR: Liste de codes de réduction

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

      public AppliedTradeAllowanceCharge setNonVATTaxCode(Codes.NonVATTaxCode value)
      Sets BT-X-616 Invoice line-level non-VAT tax code — The type of non-VAT tax charged, expressed as a code.

      Usage: Use entries of the UNTDID 5153 code list [6]. The gross price charge non-VAT tax code and the gross price charge or tax reason shall indicate the same tax type. Either BT-X-314 or BT-X-616 is to be used, not both.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode

      FR: Code de motif des Taxes (hors TVA) applicables à la ligne de facture — Motif des cTaxes (hors TVA) applicables à la ligne de Facture, exprimé sous forme de code.

      Parameters:
      value - the value to set
      Returns:
      this AppliedTradeAllowanceCharge for chaining
      Since:
      1.09.2/2.5.2
    • setReasonCodeListID

      public AppliedTradeAllowanceCharge setReasonCodeListID(String value)
      Sets BT-X-616-1 Non-VAT tax code list identifier.

      Usage: Value = 5153

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode/@listID

      FR: Identifiant de la liste des codes fiscaux hors TVA

      Parameters:
      value - the value to set
      Returns:
      this AppliedTradeAllowanceCharge for chaining
      Since:
      1.09.2/2.5.2
    • getItemPriceDiscount

      public UnitPriceAmount getItemPriceDiscount()
      Returns BT-147 Item price discount — The total discount subtracted from the Item gross price to calculate the Item net price.

      Usage: Only applies if the discount is provided per unit and if it is not included in the Item gross price.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ActualAmount

      FR: Rabais sur le prix de l'article — Remise totale qui, une fois soustraite du Prix brut de l'article, donne le Prix net de l'article.

      Returns:
      the BT-147 value
      Since:
      1.0.06/2.2
    • getItemPriceChargeIndicator

      public Boolean getItemPriceChargeIndicator()
      Returns BT-147-02 (Item price discount).

      Usage: Price allowance => false

      Rule: Value = false

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ChargeIndicator/udt:Indicator

      FR: (Rabais sur le prix de l'article)

      Returns:
      the BT-147-02 value
      Since:
      1.09.2/2.5.2
    • getAllowanceReasonCode

      public Codes.SubsetForAllowanceIdentificationCode getAllowanceReasonCode()
      Returns BT-X-313 Reason for the discount (code) — The code specifying the reason for this trade allowance.

      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.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode

      FR: Motif de la réduction (code)

      Returns:
      the BT-X-313 value
      Since:
      1.09.2/2.5.2
    • getReasonCode

      public Codes.SpecialServiceDescriptionCode getReasonCode()
      Returns BT-X-314 Reason for the charge (code) — The code specifying the reason for this trade allowance.

      Usage: Use entries of the UNTDID 7161 code list . The order line level item trade price discount reason code and the order line level item trade price discount reason shall indicate the same item trade price charge reason. Example AEW for WEEE.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode

      FR: Motif du supplément (code)

      Returns:
      the BT-X-314 value
      Since:
      1.0.06/2.2
    • getDiscountInPercent

      public Percentage getDiscountInPercent()
      Returns BT-X-34 Discount in percent — The percentage applied to calculate this trade allowance

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:CalculationPercent

      FR: Réduction en pourcentage

      Returns:
      the BT-X-34 value
      Since:
      1.09.2/2.5.2
    • getDiscountBaseAmount

      public UnitPriceAmount getDiscountBaseAmount()
      Returns BT-X-35 Discount base amount — The monetary value that is the basis on which this trade allowance is calculated.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:BasisAmount

      FR: Montant de base de la réduction

      Returns:
      the BT-X-35 value
      Since:
      1.09.2/2.5.2
    • getReason

      public String getReason()
      Returns BT-X-36 Reason for the discount (free text) — The Text specifying the reason for this trade allowance.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:Reason

      FR: Liste de codes de réduction

      Returns:
      the BT-X-36 value
      Since:
      1.0.06/2.2
    • getNonVATTaxCode

      public Codes.NonVATTaxCode getNonVATTaxCode()
      Returns BT-X-616 Invoice line-level non-VAT tax code — The type of non-VAT tax charged, expressed as a code.

      Usage: Use entries of the UNTDID 5153 code list [6]. The gross price charge non-VAT tax code and the gross price charge or tax reason shall indicate the same tax type. Either BT-X-314 or BT-X-616 is to be used, not both.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode

      FR: Code de motif des Taxes (hors TVA) applicables à la ligne de facture — Motif des cTaxes (hors TVA) applicables à la ligne de Facture, exprimé sous forme de code.

      Returns:
      the BT-X-616 value
      Since:
      1.09.2/2.5.2
    • getReasonCodeListID

      public String getReasonCodeListID()
      Returns BT-X-616-1 Non-VAT tax code list identifier.

      Usage: Value = 5153

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode/@listID

      FR: Identifiant de la liste des codes fiscaux hors TVA

      Returns:
      the BT-X-616-1 value
      Since:
      1.09.2/2.5.2
      API Note:
      This value is normally derived by the API: it is "5153" when getNonVATTaxCode() is set, and null otherwise. A value assigned through the corresponding setter is returned here only if Invoice.setRecompute(false) has been called and is in effect at the moment this getter is invoked; otherwise this getter returns the derived value, which is also what toXML() writes.