Class InvoiceTotalVATAmount

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

public class InvoiceTotalVATAmount extends Object
BT-110 Invoice total VAT amount — The total VAT amount for the Invoice.

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

Business terms and groups implemented
RepresentsBT-110, BT-111
Business terms (value fields)BT-110, BT-110-0, BT-111, BT-111-0

Documentation of the represented business groups:

BT-110 — Invoice total VAT amount
DescriptionENThe total VAT amount for the Invoice.
FRMontant total de la TVA de la Facture.
Usage noteENThe Invoice total VAT amount is the sum of all VAT category tax amounts.
FRLe Montant total de la facture TVA comprise correspond à la somme de tous les montants de TVA des différents types de TVA.
Business ruleENBR-CO-14: Invoice total VAT amount (BT-110) = ∑ VAT category tax amount (BT-117).
FRBR-CO-14 : Montant total de TVA de la facture (BT-110) = ∑ Montants de TVA pour chaque type de TVA (BT-117).
BT-111 — Invoice total VAT amount in accounting currency
DescriptionENThe VAT total amount expressed in the accounting currency accepted or required in the country of the Seller.
FRMontant total de la TVA exprimé dans la devise de comptabilisation acceptée ou exigée dans le pays du Vendeur.
Usage noteENTo be used when the VAT accounting currency (BT-6) differs from the Invoice currency code (BT-5) in accordance with article 230 of Directive 2006/112 / EC on VAT. The VAT amount in accounting currency is not used in the calculation of the Invoice totals.
FRDoit être utilisé lorsque la Devise de comptabilisation de la TVA diffère du Code de devise de facturation.La Devise de comptabilisation de la TVA n'est pas utilisée dans le calcul des totaux de la Facture.Les listes de devises valides sont enregistrées auprès de l'Agence de maintenance de la norme ISO 4217 « Codes pour la représentation des monnaies et types de fonds ». Il est recommandé d'utiliser la représentation alpha-3.
Business ruleENBR-53: If the VAT accounting currency code (BT-6) is present, then the Invoice total VAT amount in accounting currency (BT-111) shall be provided.
FRBR-53 : Si le Code de devise de comptabilisation de la TVA (BT-6) est présent, alors le Montant total de TVA de la facture exprimée dans la devise de comptabilisation (BT-111) doit être indiqué.
Since:
1.0.06/2.2
  • Method Details

    • setInvoiceTotalVATAmount

      public InvoiceTotalVATAmount setInvoiceTotalVATAmount(Amount value)
      Sets BT-110 Invoice total VAT amount — The total VAT amount for the Invoice.

      Usage: The Invoice total VAT amount is the sum of all VAT category tax amounts.

      Rule: BR-CO-14: Invoice total VAT amount (BT-110) = ∑ VAT category tax amount (BT-117).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxTotalAmount

      FR: Montant total de TVA — Montant total de la TVA de la Facture.

      Parameters:
      value - the value to set
      Returns:
      this InvoiceTotalVATAmount for chaining
      Since:
      1.09.2/2.5.2
      API Note:
      This is a computed value: by default it is computed from the invoice contents, and a value supplied through this method is ignored. There is normally no reason to call this method.

      Calling this setter stores the value, but getInvoiceTotalVATAmount() returns that stored value if and only if recomputation is disabled -- that is, Invoice.setRecompute(false) has been called and is in effect at the moment getInvoiceTotalVATAmount() is invoked; otherwise getInvoiceTotalVATAmount() returns the freshly computed value and the stored value is ignored.

      Because toXML() reads this value through getInvoiceTotalVATAmount(), a value set here appears in the generated XML if and only if Invoice.setRecompute(false) is called before toXML().

    • setVATCurrency

      public InvoiceTotalVATAmount setVATCurrency(Codes.Currency value)
      Sets BT-110-0 VAT currency.

      Rule: @currencyID is mandatory to differentiate between VAT amount and VAT amount in accounting currency.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxTotalAmount/@currencyID

      FR: Devise de la TVA

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

      public Codes.Currency getVATCurrency()
      Returns BT-110-0 VAT currency.

      Rule: @currencyID is mandatory to differentiate between VAT amount and VAT amount in accounting currency.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxTotalAmount/@currencyID

      FR: Devise de la TVA

      Returns:
      the BT-110-0 value
      Since:
      1.0.06/2.2
    • getInvoiceTotalVATAmount

      public Amount getInvoiceTotalVATAmount() throws ComputationException
      Returns BT-110 Invoice total VAT amount — The total VAT amount for the Invoice.

      Usage: The Invoice total VAT amount is the sum of all VAT category tax amounts.

      Rule: BR-CO-14: Invoice total VAT amount (BT-110) = ∑ VAT category tax amount (BT-117).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxTotalAmount

      FR: Montant total de TVA — Montant total de la TVA de la Facture.

      Returns:
      the BT-110 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
      API Note:
      This value is normally computed by the API. 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 freshly computed value, which is also what toXML() writes.