Class AdvancePayment


  • public class AdvancePayment
    extends Object
    EXT:ADVANCE PAYMENT

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

    • Method Detail

      • appendNewIncludedTax

        public IncludedTax appendNewIncludedTax​(Codes.VATCategoryCode categoryCode)
        Creates an IncludedTax object and appends it to the list obtainable by a call to get getIncludedTaxes()
        Parameters:
        categoryCode - EXT:CategoryCode

        A coded identification of what VAT category applies to the document level charge.

        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)

        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

        BR-37: Each Document level charge (BG-21) shall have a Document level charge VAT category code (BT-102).

        Returns:
        IncludedTax
      • setPaidAmount

        public AdvancePayment setPaidAmount​(Decimal value)
        Parameters:
        value - EXT:PaidAmount

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

        Returns:
        AdvancePayment
      • setIssueDate

        public AdvancePayment setIssueDate​(String value)
        Parameters:
        value - EXT:Issue Date

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

        Returns:
        AdvancePayment
      • getPaidAmount

        public Decimal getPaidAmount()
        EXT:PaidAmount
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:PaidAmount
      • getFormat

        public Codes.DateFormat getFormat()
                                   throws ComputationException
        EXT:format

        Value = 102

        Only value "102"

        Returns:
        a computed value unless an explicit value has been set and Invoice.setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:FormattedReceivedDateTime/qdt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getIssueDate

        public String getIssueDate()
        EXT:Issue Date
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedAdvancePayment/ram:FormattedReceivedDateTime/qdt:DateTimeString