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

Class InvoiceLineAllowances

  • public class InvoiceLineAllowances
extends Object
    BG-27:INVOICE LINE ALLOWANCES

    A group of business terms providing information about allowances applicable to the individual Invoice line.

    Invoice line allowancess are subject to the same VAT rate as the line they relate to. If invoice line allowances are subject to a different VAT rate, they must be treated as standalone (negative) invoice lines

    ChargeIndicator=false BG-28:INVOICE LINE CHARGES

    A group of business terms providing information about charges and taxes other than VAT applicable to the individual Invoice line.

    All charges and taxes are assumed to be liable to the same VAT rate as the Invoice line.

    Invoice line charges are subject to the same VAT rate as that of the line to which they relate. If invoice line charges are subject to a different VAT rate, they must be treated as stand-alone invoice lines.

    ChargeIndicator=true

    XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge

    • Method Detail

      • setAllowancesIndicatorValue

        public InvoiceLineAllowances setAllowancesIndicatorValue​(Boolean value)
        Parameters:
        value - BG-27-1:Allowances indicator value

        Value = false

        Value = false

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ChargeIndicator/udt:Indicator

        Returns:
        InvoiceLineAllowances

      • setInvoiceLineAllowancePercentage

        public InvoiceLineAllowances setInvoiceLineAllowancePercentage​(Percentage value)
        Parameters:
        value - BT-138:Invoice line allowance percentage

        The percentage that may be used, in conjunction with the Invoice line allowance base amount, to calculate the Invoice line 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:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercent

        Returns:
        InvoiceLineAllowances

      • setInvoiceLineAllowanceBaseAmount

        public InvoiceLineAllowances setInvoiceLineAllowanceBaseAmount​(Amount value)
        Parameters:
        value - BT-137:Invoice line allowance base amount

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

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisAmount

        Returns:
        InvoiceLineAllowances

      • setInvoiceLineAllowanceAmount

        public InvoiceLineAllowances setInvoiceLineAllowanceAmount​(Amount value)
        Parameters:
        value - BT-136:Invoice line allowance amount

        The amount of an allowance, without VAT.

        BR-41: Each Invoice line allowance (BG-27) shall have an Invoice line allowance amount (BT-136).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmount

        Returns:
        InvoiceLineAllowances

      • setInvoiceLineAllowanceReasonCode

        public InvoiceLineAllowances setInvoiceLineAllowanceReasonCode​(Codes.SubsetForAllowanceIdentificationCode value)
        Parameters:
        value - BT-140:Invoice line allowance reason code

        The reason for the Invoice line allowance, expressed as a code.

        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.

        BR-42: Each Invoice line allowance (BG-27) shall have an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140).BR-CO-7: Invoice line allowance reason code (BT-140) and Invoice line allowance reason (BT-139) shall indicate the same type of allowance reason.BR-CO-23: Each Invoice line allowance (BG-27) shall contain an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140), or both.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonCode

        Internally calls setAllowancesIndicatorValue(java.lang.Boolean)(Boolean.FALSE).

        Returns:
        InvoiceLineAllowances

      • setInvoiceLineAllowanceReasonCode

        public InvoiceLineAllowances setInvoiceLineAllowanceReasonCode​(Codes.SpecialServiceDescriptionCode value)
        BT-145:Invoice line charge reason code

        The reason for the Invoice line charge, expressed as a code.

        Use entries of the UNTDID 7161 code list [6]. The Invoice line charge reason code and the Invoice line charge reason shall indicate the same charge reason

        In particular, the following codes and reasons can be used: AA = Advertising discount, ABL = Packing supplement, ADR = Other services, ADT = Removal, FC = transportation costs, FI = Financial expenses and LA = Labeling

        BR-44: Each Invoice line charge (BG-28) shall have an Invoice line charge reason (BT-144) or an Invoice line charge reason code (BT-145). BR-CO-8: Invoice line charge reason code (BT-145) and Invoice line charge reason (BT144) shall indicate the same type of charge reason. BR-CO-24: Each Invoice line charge (BG-28) shall contain an Invoice line charge reason (BT-144) or an Invoice line charge reason code (BT-145), or both.

        Internally calls setAllowancesIndicatorValue(java.lang.Boolean)(Boolean.TRUE).

        Returns:
        InvoiceLineAllowances

      • setInvoiceLineAllowanceReason

        public InvoiceLineAllowances setInvoiceLineAllowanceReason​(String value)
        Parameters:
        value - BT-139:Invoice line allowance reason

        The reason for the Invoice line allowance, expressed as text.

        BR-42: Each Invoice line allowance (BG-27) shall have an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140).BR-CO-7: Invoice line allowance reason code (BT-140) and Invoice line allowance reason (BT-139) shall indicate the same type of allowance reason.BR-CO-23: Each Invoice line allowance (BG-27) shall contain an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140), or both.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:Reason

        Returns:
        InvoiceLineAllowances

      • getAllowancesIndicatorValue

        public Boolean getAllowancesIndicatorValue()
        BG-27-1:Allowances indicator value

        Value = false

        Value = false

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

      • getInvoiceLineAllowancePercentage

        public Percentage getInvoiceLineAllowancePercentage()
        BT-138:Invoice line allowance percentage

        The percentage that may be used, in conjunction with the Invoice line allowance base amount, to calculate the Invoice line 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:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:CalculationPercent

      • getInvoiceLineAllowanceBaseAmount

        public Amount getInvoiceLineAllowanceBaseAmount()
        BT-137:Invoice line allowance base amount

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

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:BasisAmount

      • getInvoiceLineAllowanceAmount

        public Amount getInvoiceLineAllowanceAmount()
        BT-136:Invoice line allowance amount

        The amount of an allowance, without VAT.

        BR-41: Each Invoice line allowance (BG-27) shall have an Invoice line allowance amount (BT-136).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ActualAmount

      • getInvoiceLineAllowanceReasonCode

        public Object getInvoiceLineAllowanceReasonCode()
        BT-140:Invoice line allowance reason code

        The reason for the Invoice line allowance, expressed as a code.

        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.

        BR-42: Each Invoice line allowance (BG-27) shall have an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140).BR-CO-7: Invoice line allowance reason code (BT-140) and Invoice line allowance reason (BT-139) shall indicate the same type of allowance reason.BR-CO-23: Each Invoice line allowance (BG-27) shall contain an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140), or both.

        The returned value can be cast to Codes.SubsetForAllowanceIdentificationCode when getAllowancesIndicatorValue() returns false. BT-145:Invoice line charge reason code

        The reason for the Invoice line charge, expressed as a code.

        Use entries of the UNTDID 7161 code list [6]. The Invoice line charge reason code and the Invoice line charge reason shall indicate the same charge reason

        In particular, the following codes and reasons can be used: AA = Advertising discount, ABL = Packing supplement, ADR = Other services, ADT = Removal, FC = transportation costs, FI = Financial expenses and LA = Labeling

        BR-44: Each Invoice line charge (BG-28) shall have an Invoice line charge reason (BT-144) or an Invoice line charge reason code (BT-145). BR-CO-8: Invoice line charge reason code (BT-145) and Invoice line charge reason (BT144) shall indicate the same type of charge reason. BR-CO-24: Each Invoice line charge (BG-28) shall contain an Invoice line charge reason (BT-144) or an Invoice line charge reason code (BT-145), or both.

        The returned value can be cast to Codes.SpecialServiceDescriptionCode when getAllowancesIndicatorValue() returns true.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:ReasonCode

      • getInvoiceLineAllowanceReason

        public String getInvoiceLineAllowanceReason()
        BT-139:Invoice line allowance reason

        The reason for the Invoice line allowance, expressed as text.

        BR-42: Each Invoice line allowance (BG-27) shall have an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140).BR-CO-7: Invoice line allowance reason code (BT-140) and Invoice line allowance reason (BT-139) shall indicate the same type of allowance reason.BR-CO-23: Each Invoice line allowance (BG-27) shall contain an Invoice line allowance reason (BT-139) or an Invoice line allowance reason code (BT-140), or both.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeAllowanceCharge/ram:Reason