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

Class AdditionalSupportingDocuments

  • public class AdditionalSupportingDocuments
extends Object
    BG-24:ADDITIONAL SUPPORTING DOCUMENTS

    A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice.

    The additional supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external document (referenced by a URL) or as an embedded document (such as a time report in pdf). The option to link to an external document will be needed, for example in the case of large attachments and/or when sensitive information, e.g. person-related services, has to be separated from the Invoice itself.

    CHORUS PRO: If the group "ADDITIONAL SUPPORTING DOCUMENTS" is filled in, one of the following two business terms must be present: Attached Document (BT-125) or External document location (URI) (BT-124)

    XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument

    • Method Detail

      • setSupportingDocumentReference

        public AdditionalSupportingDocuments setSupportingDocumentReference​(DocumentReference value)
        Parameters:
        value - BT-122:Supporting document reference

        An identifier of the supporting document.

        BR-52: Each Additional supporting document (BG-24) shall contain a Supporting document reference (BT-122).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:IssuerAssignedID

        Returns:
        AdditionalSupportingDocuments

      • setExternalDocumentLocation

        public AdditionalSupportingDocuments setExternalDocumentLocation​(String value)
        Parameters:
        value - BT-124:External document location

        The URL (Uniform Resource Locator) that identifies where the external document is located.

        A means of locating the resource including its primary access mechanism, e.g. http:// or ftp://.External document location shall be used if the Buyer requires additional information to support the Invoice.External documents do not form part of the invoice. Risks can be involved when accessing external documents.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:URIID

        Returns:
        AdditionalSupportingDocuments

      • setTypeCode

        public AdditionalSupportingDocuments setTypeCode​(Codes.SupportingDocumentTypeCode value)
        Parameters:
        value - BT-122-0:

        Use for "ADDITIONAL SUPPORTING DOCUMENTS" with TypeCode Value = 916

        For this business term, same Xpath for BT-17, BT-18, and BT-122. For BT-18, Value = 916

        Use for "ADDITIONAL SUPPORTING DOCUMENTS" with TypeCode "916"

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:TypeCode

        Returns:
        AdditionalSupportingDocuments

      • setAttachedDocumentMimeCode

        public AdditionalSupportingDocuments setAttachedDocumentMimeCode​(Codes.Mime value)
        Parameters:
        value - BT-125-1:Attached document Mime code

        The mime code of the attached document.

        Allowed mime codes: - application/pdf- image/png- image/jpeg- text/csv- application/vnd.openxmlformats- officedocument.spreadsheetml.sheet- application/vnd.oasis.opendocument. Spreadsheet

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@mimeCode

        Returns:
        AdditionalSupportingDocuments

      • setAttachedDocumentFilename

        public AdditionalSupportingDocuments setAttachedDocumentFilename​(String value)
        Parameters:
        value - BT-125-2:Attached document Filename

        The file name of the attached document

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@filename

        Returns:
        AdditionalSupportingDocuments

      • setAttachedDocument

        public AdditionalSupportingDocuments setAttachedDocument​(BinaryObject value)
        Parameters:
        value - BT-125:Attached document

        An attached document embedded as binary object or sent together with the invoice.

        Attached document is used when documentation shall be stored with the Invoice for future reference or audit purposes.

        CHORUS PRO: The attachment must be contained in a ZIP archive, the maximum weight of the attachment is 100 MB.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject

        Returns:
        AdditionalSupportingDocuments

      • setSchemeIdentifier

        public AdditionalSupportingDocuments setSchemeIdentifier​(Codes.ReferenceCodeIdentifier value)
        Parameters:
        value - BT-18-1:Scheme identifier

        The identification scheme identifier of the Invoiced object identifier.

        If it may be not clear for the receiver what scheme is used for the identifier, a conditional scheme identifier should be used that shall be chosen from the UNTDID 1153 code list [6] entries.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:ReferenceTypeCode

        Returns:
        AdditionalSupportingDocuments

      • setDateTimeStringFormat

        public AdditionalSupportingDocuments setDateTimeStringFormat​(String value)
        Parameters:
        value - EXT:Date, format Date Format

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString/@format

        Returns:
        AdditionalSupportingDocuments

      • setDateTimeString

        public AdditionalSupportingDocuments setDateTimeString​(String value)
        Parameters:
        value - EXT:Document Date, Value

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString

        Returns:
        AdditionalSupportingDocuments

      • getSupportingDocumentReference

        public DocumentReference getSupportingDocumentReference()
        BT-122:Supporting document reference

        An identifier of the supporting document.

        BR-52: Each Additional supporting document (BG-24) shall contain a Supporting document reference (BT-122).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:IssuerAssignedID

      • getExternalDocumentLocation

        public String getExternalDocumentLocation()
        BT-124:External document location

        The URL (Uniform Resource Locator) that identifies where the external document is located.

        A means of locating the resource including its primary access mechanism, e.g. http:// or ftp://.External document location shall be used if the Buyer requires additional information to support the Invoice.External documents do not form part of the invoice. Risks can be involved when accessing external documents.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:URIID

      • getTypeCode

        public Codes.SupportingDocumentTypeCode getTypeCode()
        BT-122-0:

        Use for "ADDITIONAL SUPPORTING DOCUMENTS" with TypeCode Value = 916

        For this business term, same Xpath for BT-17, BT-18, and BT-122. For BT-18, Value = 916

        Use for "ADDITIONAL SUPPORTING DOCUMENTS" with TypeCode "916"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:TypeCode

      • getAttachedDocumentMimeCode

        public Codes.Mime getAttachedDocumentMimeCode()
        BT-125-1:Attached document Mime code

        The mime code of the attached document.

        Allowed mime codes: - application/pdf- image/png- image/jpeg- text/csv- application/vnd.openxmlformats- officedocument.spreadsheetml.sheet- application/vnd.oasis.opendocument. Spreadsheet

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@mimeCode

      • getAttachedDocumentFilename

        public String getAttachedDocumentFilename()
        BT-125-2:Attached document Filename

        The file name of the attached document

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@filename

      • getAttachedDocument

        public BinaryObject getAttachedDocument()
        BT-125:Attached document

        An attached document embedded as binary object or sent together with the invoice.

        Attached document is used when documentation shall be stored with the Invoice for future reference or audit purposes.

        CHORUS PRO: The attachment must be contained in a ZIP archive, the maximum weight of the attachment is 100 MB.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject

      • getSchemeIdentifier

        public Codes.ReferenceCodeIdentifier getSchemeIdentifier()
        BT-18-1:Scheme identifier

        The identification scheme identifier of the Invoiced object identifier.

        If it may be not clear for the receiver what scheme is used for the identifier, a conditional scheme identifier should be used that shall be chosen from the UNTDID 1153 code list [6] entries.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:ReferenceTypeCode

      • getDateTimeStringFormat

        public String getDateTimeStringFormat()
        EXT:Date, format Date Format
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString/@format

      • getDateTimeString

        public String getDateTimeString()
        EXT:Document Date, Value
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString