Class PrecedingInvoiceReference


  • public class PrecedingInvoiceReference
    extends Object
    BG-3:PRECEDING INVOICE REFERENCE

    A group of business terms providing information on one or more preceding Invoices.

    To be used in case:- a preceding invoice is corrected- preceding partial invoices are referred to from a final invoice-preceding pre-payment invoices are referred to from a final invoice

    This business group is mandatory in case of a Credit Note in order to reference the invoices it credits, unless the Credit Note refers to a period which must then be present in group BG-14.

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

    • Method Detail

      • setPrecedingInvoiceReference

        public PrecedingInvoiceReference setPrecedingInvoiceReference​(DocumentReference value)
        Parameters:
        value - BT-25:Preceding Invoice reference

        The identification of an Invoice that was previously sent by the Seller.

        BR-55: Each Preceding Invoice reference (BG-3) shall contain a Preceding Invoice reference (BT-25).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceReferencedDocument/ram:IssuerAssignedID

        Returns:
        PrecedingInvoiceReference
      • setPrecedingInvoiceIssueDate

        public PrecedingInvoiceReference setPrecedingInvoiceIssueDate​(LocalDate value)
        Parameters:
        value - BT-26:Preceding Invoice issue date

        The date when the Preceding Invoice was issued.

        The Preceding Invoice issue date shall be provided in case the Preceding Invoice identifier is not unique.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString

        Returns:
        PrecedingInvoiceReference
      • getPrecedingInvoiceReference

        public DocumentReference getPrecedingInvoiceReference()
        BT-25:Preceding Invoice reference

        The identification of an Invoice that was previously sent by the Seller.

        BR-55: Each Preceding Invoice reference (BG-3) shall contain a Preceding Invoice reference (BT-25).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceReferencedDocument/ram:IssuerAssignedID
      • getDateFormat

        public Codes.DateFormat getDateFormat()
                                       throws ComputationException
        BT-26-0:Date 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:InvoiceReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getPrecedingInvoiceIssueDate

        public LocalDate getPrecedingInvoiceIssueDate()
        BT-26:Preceding Invoice issue date

        The date when the Preceding Invoice was issued.

        The Preceding Invoice issue date shall be provided in case the Preceding Invoice identifier is not unique.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString