Class AdvancePayment

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

public class AdvancePayment extends Object
BG-X-45 ADVANCE PAYMENT.

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

Business terms and groups implemented
RepresentsBG-X-45
Business terms (value fields)BT-X-291, BT-X-292, BT-X-292-0
Business groups (object lists)BG-X-46, BG-X-85
Since:
1.0.06/2.2
  • Method Details

    • setPaidAmount

      public AdvancePayment setPaidAmount(Decimal value)
      Sets BT-X-291 PaidAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:PaidAmount

      FR: Paiement anticipé, valeur

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

      public AdvancePayment setIssueDate(LocalDate value)
      Sets BT-X-292 Issue Date.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:FormattedReceivedDateTime/qdt:DateTimeString

      FR: Date de réception du paiement, date

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

      public Decimal getPaidAmount()
      Returns BT-X-291 PaidAmount.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:PaidAmount

      FR: Paiement anticipé, valeur

      Returns:
      the BT-X-291 value
      Since:
      1.0.06/2.2
    • getIssueDate

      public LocalDate getIssueDate()
      Returns BT-X-292 Issue Date.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:FormattedReceivedDateTime/qdt:DateTimeString

      FR: Date de réception du paiement, date

      Returns:
      the BT-X-292 value
      Since:
      1.09.2/2.5.2
    • getFormat

      public Codes.DateFormat getFormat() throws ComputationException
      Returns BT-X-292-0 format.

      Usage: Only value "102"

      Rule: Only value "102"

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:FormattedReceivedDateTime/qdt:DateTimeString/@format

      FR: Date, format

      Returns:
      the BT-X-292-0 value
      Throws:
      ComputationException
      Since:
      1.0.06/2.2
    • appendNewIncludedTax

      public IncludedTax appendNewIncludedTax(Decimal calculatedAmount, Codes.VATCategoryCode categoryCode)
      Creates, appends and returns a new IncludedTax (BG-X-46 INCLUDED TAX).
      Parameters:
      calculatedAmount - BT-X-293 CalculatedAmount
      categoryCode - BT-X-296 CategoryCode — Coded identification of a VAT category.

      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

      FR: Code de type de TVA de la remise ou de la charge au niveau du document — Identification codée d’un type de TVA.

      Returns:
      the new IncludedTax
      Since:
      1.09.2/2.5.2
    • getIncludedTaxes

      public List<IncludedTax> getIncludedTaxes()
    • appendNewPrecedingInvoiceReferenceForAdvancePayment

      public PrecedingInvoiceReferenceForAdvancePayment appendNewPrecedingInvoiceReferenceForAdvancePayment(String precedingInvoiceReference)
      Creates, appends and returns a new PrecedingInvoiceReferenceForAdvancePayment (BG-X-85 PRECEDING INVOICE REFERENCE FOR ADVANCE PAYMENT).
      Parameters:
      precedingInvoiceReference - BT-X-558 Preceding Invoice reference — The identification of an Invoice that was previously sent by the Seller.

      FR: Numéro de facture antérieure — Numéro de facture antérieure Identification d'une Facture précédemment envoyée par le Vendeur.

      Returns:
      the new PrecedingInvoiceReferenceForAdvancePayment
      Since:
      1.09.2/2.5.2
    • getPrecedingInvoiceReferenceForAdvancePayments

      public List<PrecedingInvoiceReferenceForAdvancePayment> getPrecedingInvoiceReferenceForAdvancePayments()