Package com.fourjs.report.facturx.profiles.extended

Class DocumentLevelAllowances

  • public class DocumentLevelAllowances
extends Object
    BG-20:DOCUMENT LEVEL ALLOWANCES

    A group of business terms providing information about allowances applicable to the Invoice as a whole.

    Deductions, such as withheld tax may also be specified in this group.

    ChargeIndicator=false

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

    • Method Detail

      • setAllowanceOrChargeIndicatorValue

        public DocumentLevelAllowances setAllowanceOrChargeIndicatorValue​(Boolean value)
        Parameters:
        value - BG-20-1:Allowance or Charge indicator Value

        Value = false

        Value = false

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ChargeIndicator/udt:Indicator

        Returns:
        DocumentLevelAllowances

      • setCalculationSequence

        public DocumentLevelAllowances setCalculationSequence​(String value)
        Parameters:
        value - EXT:Calculation sequence

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:SequenceNumeric

        Returns:
        DocumentLevelAllowances

      • setDocumentLevelAllowancePercentage

        public DocumentLevelAllowances setDocumentLevelAllowancePercentage​(Percentage value)
        Parameters:
        value - BT-94:Document level allowance percentage

        The percentage that may be used, in conjunction with the document level allowance base amount, to calculate the document level allowance amount.

        The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercent

        Returns:
        DocumentLevelAllowances

      • setDocumentLevelAllowanceBaseAmount

        public DocumentLevelAllowances setDocumentLevelAllowanceBaseAmount​(Amount value)
        Parameters:
        value - BT-93:Document level allowance base amount

        The base amount that may be used, in conjunction with the document level allowance percentage, to calculate the document level allowance amount.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisAmount

        Returns:
        DocumentLevelAllowances

      • setBasisQuantityUnitCode

        public DocumentLevelAllowances setBasisQuantityUnitCode​(Codes.UnitOfMeasure value)
        Parameters:
        value - EXT:Price base quantity, unit

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisQuantity/@unitCode

        Returns:
        DocumentLevelAllowances

      • setBasisQuantity

        public DocumentLevelAllowances setBasisQuantity​(Quantity value)
        Parameters:
        value - EXT:Allowance / charge base quantity

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisQuantity

        Returns:
        DocumentLevelAllowances

      • setDocumentLevelAllowanceAmount

        public DocumentLevelAllowances setDocumentLevelAllowanceAmount​(Amount value)
        Parameters:
        value - BT-92:Document level allowance amount

        The amount of an allowance, without VAT.

        BR-31: Each Document level allowance (BG-20) shall have a Document level allowance amount (BT-92).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmount

        Returns:
        DocumentLevelAllowances

      • setDocumentLevelAllowanceReasonCode

        public DocumentLevelAllowances setDocumentLevelAllowanceReasonCode​(Codes.SubsetForAllowanceIdentificationCode value)
        Parameters:
        value - BT-98:Document level allowance reason code

        The reason for the document level allowance, expressed as a code.

        Use entries of the UNTDID 5189 code list [6]. The Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason.

        BR-33: Each Document level allowance (BG-20) shall have a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98).BR-CO-5: Document level allowance reason code (BT-98) and Document level allowance reason (BT-97) shall indicate the same type of allowance.BR-CO-21: Each Document level allowance (BG-20) shall contain a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98), or both.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonCode

        Returns:
        DocumentLevelAllowances

      • setDocumentLevelAllowanceReason

        public DocumentLevelAllowances setDocumentLevelAllowanceReason​(String value)
        Parameters:
        value - BT-97:Document level allowance reason

        The reason for the document level allowance, expressed as text.

        BR-33: Each Document level allowance (BG-20) shall have a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98).BR-CO-5: Document level allowance reason code (BT-98) and Document level allowance reason (BT-97) shall indicate the same type of allowance.BR-CO-21: Each Document level allowance (BG-20) shall contain a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98), or both.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:Reason

        Returns:
        DocumentLevelAllowances

      • setDocumentLevelAllowanceVATCategoryCode

        public DocumentLevelAllowances setDocumentLevelAllowanceVATCategoryCode​(Codes.VATCategoryCode value)
        Parameters:
        value - BT-95:Document level allowance VAT category code

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

        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-32: Each Document level allowance (BG-20) shall have a Document level allowance VAT category code (BT-95).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:CategoryCode

        Returns:
        DocumentLevelAllowances

      • setDocumentLevelAllowanceVATRate

        public DocumentLevelAllowances setDocumentLevelAllowanceVATRate​(Percentage value)
        Parameters:
        value - BT-96:Document level allowance VAT rate

        The VAT rate, represented as percentage that applies to the document level allowance.

        The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:RateApplicablePercent

        Returns:
        DocumentLevelAllowances

      • getAllowanceOrChargeIndicatorValue

        public Boolean getAllowanceOrChargeIndicatorValue()
        BG-20-1:Allowance or Charge indicator Value

        Value = false

        Value = false

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ChargeIndicator/udt:Indicator

      • getCalculationSequence

        public String getCalculationSequence()
        EXT:Calculation sequence
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:SequenceNumeric

      • getDocumentLevelAllowancePercentage

        public Percentage getDocumentLevelAllowancePercentage()
        BT-94:Document level allowance percentage

        The percentage that may be used, in conjunction with the document level allowance base amount, to calculate the document level allowance amount.

        The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercent

      • getDocumentLevelAllowanceBaseAmount

        public Amount getDocumentLevelAllowanceBaseAmount()
        BT-93:Document level allowance base amount

        The base amount that may be used, in conjunction with the document level allowance percentage, to calculate the document level allowance amount.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisAmount

      • getBasisQuantityUnitCode

        public Codes.UnitOfMeasure getBasisQuantityUnitCode()
        EXT:Price base quantity, unit
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisQuantity/@unitCode

      • getBasisQuantity

        public Quantity getBasisQuantity()
        EXT:Allowance / charge base quantity
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisQuantity

      • getDocumentLevelAllowanceAmount

        public Amount getDocumentLevelAllowanceAmount()
        BT-92:Document level allowance amount

        The amount of an allowance, without VAT.

        BR-31: Each Document level allowance (BG-20) shall have a Document level allowance amount (BT-92).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmount

      • getDocumentLevelAllowanceReasonCode

        public Codes.SubsetForAllowanceIdentificationCode getDocumentLevelAllowanceReasonCode()
        BT-98:Document level allowance reason code

        The reason for the document level allowance, expressed as a code.

        Use entries of the UNTDID 5189 code list [6]. The Document level allowance reason code and the Document level allowance reason shall indicate the same allowance reason.

        BR-33: Each Document level allowance (BG-20) shall have a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98).BR-CO-5: Document level allowance reason code (BT-98) and Document level allowance reason (BT-97) shall indicate the same type of allowance.BR-CO-21: Each Document level allowance (BG-20) shall contain a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98), or both.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonCode

      • getDocumentLevelAllowanceReason

        public String getDocumentLevelAllowanceReason()
        BT-97:Document level allowance reason

        The reason for the document level allowance, expressed as text.

        BR-33: Each Document level allowance (BG-20) shall have a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98).BR-CO-5: Document level allowance reason code (BT-98) and Document level allowance reason (BT-97) shall indicate the same type of allowance.BR-CO-21: Each Document level allowance (BG-20) shall contain a Document level allowance reason (BT-97) or a Document level allowance reason code (BT-98), or both.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:Reason

      • getVATTypeCodeForDocumentLevelAllowances

        public Codes.VATTypeCode getVATTypeCodeForDocumentLevelAllowances()
                                                           throws ComputationException
        BT-95-0:VAT type code for document level allowances

        Value = VAT

        Fixed value "VAT"

        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:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:TypeCode is returned
        Throws:
        ComputationException

      • getDocumentLevelAllowanceVATCategoryCode

        public Codes.VATCategoryCode getDocumentLevelAllowanceVATCategoryCode()
        BT-95:Document level allowance VAT category code

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

        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-32: Each Document level allowance (BG-20) shall have a Document level allowance VAT category code (BT-95).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:CategoryCode

      • getDocumentLevelAllowanceVATRate

        public Percentage getDocumentLevelAllowanceVATRate()
        BT-96:Document level allowance VAT rate

        The VAT rate, represented as percentage that applies to the document level allowance.

        The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CategoryTradeTax/ram:RateApplicablePercent