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

Class PaymentTerms

  • public class PaymentTerms
extends Object
    BT-20-00:(PAYMENT TERMS)

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

    • Method Detail

      • setPaymentTerms

        public PaymentTerms setPaymentTerms​(String value)
        Parameters:
        value - BT-20:Payment terms

        A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).

        This element may contain multiple lines and multiple terms.

        BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:Description

        Returns:
        PaymentTerms

      • setPaymentDueDate

        public PaymentTerms setPaymentDueDate​(LocalDate value)
        Parameters:
        value - BT-9:Payment due date

        The date when the payment is due.

        The payment due date reflects the due date of the net payment. For partial payments it states the first net due date. The corresponding description of more complex payment terms can be stated in BT-20 Payment terms.

        BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DueDateDateTime/udt:DateTimeString

        Returns:
        PaymentTerms

      • setMandateReferenceIdentifier

        public PaymentTerms setMandateReferenceIdentifier​(IdentifierType value)
        Parameters:
        value - BT-89:Mandate reference identifier

        Unique identifier assigned by the Payee for referencing the direct debit mandate.

        Used in order to pre-notify the Buyer of a SEPA direct debit.

        This is the RUM (Unique Mandate Reference) for SEPA direct debits

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DirectDebitMandateID

        Returns:
        PaymentTerms

      • setPartialPaymentAmount

        public PaymentTerms setPartialPaymentAmount​(Decimal value)
        Parameters:
        value - EXT:PartialPaymentAmount

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PartialPaymentAmount

        Returns:
        PaymentTerms

      • setDateFormat

        public PaymentTerms setDateFormat​(String value)
        Parameters:
        value - EXT:Date format

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisDateTime/udt:DateTimeString/@format

        Returns:
        PaymentTerms

      • setPaymentPenaltyDateTime

        public PaymentTerms setPaymentPenaltyDateTime​(String value)
        Parameters:
        value - EXT:Maturity Reference Date, Value

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisDateTime/udt:DateTimeString

        Returns:
        PaymentTerms

      • setBasisPeriodMeasureUnitCode

        public PaymentTerms setBasisPeriodMeasureUnitCode​(Codes.UnitOfMeasure value)
        Parameters:
        value - EXT:Maturity Period, Unit code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisPeriodMeasure/@unitCode

        Returns:
        PaymentTerms

      • setDueDatePeriod

        public PaymentTerms setDueDatePeriod​(String value)
        Parameters:
        value - EXT:Due date period

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisPeriodMeasure

        Returns:
        PaymentTerms

      • setPaymentPenaltyBaseAmount

        public PaymentTerms setPaymentPenaltyBaseAmount​(UnitPriceAmount value)
        Parameters:
        value - EXT:Payment penalty base amount

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:BasisAmount

        Returns:
        PaymentTerms

      • setPaymentPenaltyPercentage

        public PaymentTerms setPaymentPenaltyPercentage​(Percentage value)
        Parameters:
        value - EXT:Payment penalty percentage

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:CalculationPercent

        Returns:
        PaymentTerms

      • setPaymentPenaltyAmount

        public PaymentTerms setPaymentPenaltyAmount​(UnitPriceAmount value)
        Parameters:
        value - EXT:Payment penalty amount

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentPenaltyTerms/ram:ActualPenaltyAmount

        Returns:
        PaymentTerms

      • setPaymentDiscountDateTime

        public PaymentTerms setPaymentDiscountDateTime​(String value)
        Parameters:
        value - EXT:DateTimeString

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisDateTime/udt:DateTimeString

        Returns:
        PaymentTerms

      • setUnitCode

        public PaymentTerms setUnitCode​(Codes.UnitOfMeasure value)
        Parameters:
        value - EXT:unitCode

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisPeriodMeasure/@unitCode

        Returns:
        PaymentTerms

      • setBasisPeriodMeasure

        public PaymentTerms setBasisPeriodMeasure​(Decimal value)
        Parameters:
        value - EXT:Basis Period Measure

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisPeriodMeasure

        Returns:
        PaymentTerms

      • setBasisAmount

        public PaymentTerms setBasisAmount​(Decimal value)
        Parameters:
        value - EXT:BasisAmount

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:BasisAmount

        Returns:
        PaymentTerms

      • setCalculationPercent

        public PaymentTerms setCalculationPercent​(Decimal value)
        Parameters:
        value - EXT:CalculationPercent

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:CalculationPercent

        Returns:
        PaymentTerms

      • setActualDiscountAmount

        public PaymentTerms setActualDiscountAmount​(Decimal value)
        Parameters:
        value - EXT:ActualDiscountAmount

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:ApplicableTradePaymentDiscountTerms/ram:ActualDiscountAmount

        Returns:
        PaymentTerms

      • setPaymentTermsPayeeName

        public PaymentTerms setPaymentTermsPayeeName​(String value)
        Parameters:
        value - EXT:Payee name

        The name of the Payee.

        Shall be used when the Payee is different from the Seller. The Payee name may however be the same as the Seller name.

        If the PAYEE party bock is present, the name of the Payee is mandatory

        BR-17: The Payee name (BT-59) shall be provided in the Invoice, if the Payee (BG-10) is different from the Seller (BG-4).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:Name

        Returns:
        PaymentTerms

      • setPaymentTermsPayeeLegalOrganizationIdentifer

        public PaymentTerms setPaymentTermsPayeeLegalOrganizationIdentifer​(IdentifierType value)
        Parameters:
        value - EXT:Payee legal registration identifierScheme identifier

        An identifier issued by an official registrar that identifies the Payee as a legal entity or person.The identification scheme identifier of the Payee legal registration identifier.

        If no scheme is specified, it should be known by Buyer and Seller, e.g. the identifier that is exclusively used in the applicable legal environment.If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        PaymentTerms

      • getPaymentTerms

        public String getPaymentTerms()

      • getPaymentTermsForJAXB

        public String getPaymentTermsForJAXB()

      • getPaymentDueDate

        public LocalDate getPaymentDueDate()

      • getPaymentDueDateForJAXB

        public String getPaymentDueDateForJAXB()

      • getMandateReferenceIdentifier

        public IdentifierType getMandateReferenceIdentifier()

      • getMandateReferenceIdentifierForJAXB

        public String getMandateReferenceIdentifierForJAXB()

      • getPartialPaymentAmount

        public Decimal getPartialPaymentAmount()

      • getPartialPaymentAmountForJAXB

        public String getPartialPaymentAmountForJAXB()

      • getDateFormat

        public String getDateFormat()

      • getDateFormatForJAXB

        public String getDateFormatForJAXB()

      • getPaymentPenaltyDateTime

        public String getPaymentPenaltyDateTime()

      • getPaymentPenaltyDateTimeForJAXB

        public String getPaymentPenaltyDateTimeForJAXB()

      • getBasisPeriodMeasureUnitCodeForJAXB

        public Codes.UnitOfMeasure getBasisPeriodMeasureUnitCodeForJAXB()

      • getDueDatePeriod

        public String getDueDatePeriod()

      • getDueDatePeriodForJAXB

        public String getDueDatePeriodForJAXB()

      • getPaymentPenaltyBaseAmount

        public UnitPriceAmount getPaymentPenaltyBaseAmount()

      • getPaymentPenaltyBaseAmountForJAXB

        public String getPaymentPenaltyBaseAmountForJAXB()

      • getPaymentPenaltyPercentage

        public Percentage getPaymentPenaltyPercentage()

      • getPaymentPenaltyPercentageForJAXB

        public String getPaymentPenaltyPercentageForJAXB()

      • getPaymentPenaltyAmount

        public UnitPriceAmount getPaymentPenaltyAmount()

      • getPaymentPenaltyAmountForJAXB

        public String getPaymentPenaltyAmountForJAXB()

      • getPaymentDiscountDateTime

        public String getPaymentDiscountDateTime()

      • getPaymentDiscountDateTimeForJAXB

        public String getPaymentDiscountDateTimeForJAXB()

      • getBasisPeriodMeasure

        public Decimal getBasisPeriodMeasure()

      • getBasisPeriodMeasureForJAXB

        public String getBasisPeriodMeasureForJAXB()

      • getBasisAmount

        public Decimal getBasisAmount()

      • getBasisAmountForJAXB

        public String getBasisAmountForJAXB()

      • getCalculationPercent

        public Decimal getCalculationPercent()

      • getCalculationPercentForJAXB

        public String getCalculationPercentForJAXB()

      • getActualDiscountAmount

        public Decimal getActualDiscountAmount()

      • getActualDiscountAmountForJAXB

        public String getActualDiscountAmountForJAXB()

      • getPaymentTermsPayeeName

        public String getPaymentTermsPayeeName()

      • getPaymentTermsPayeeNameForJAXB

        public String getPaymentTermsPayeeNameForJAXB()

      • getPaymentTermsPayeeLegalOrganizationIdentifer

        public IdentifierType getPaymentTermsPayeeLegalOrganizationIdentifer()

      • getPaymentTermsPayeeLegalOrganizationIdentiferForJAXB

        public String getPaymentTermsPayeeLegalOrganizationIdentiferForJAXB()