public class AdditionalSupportingDocuments
extends java.lang.Object
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
public SupportingDocumentDescription appendNewSupportingDocumentDescription()
getSupportingDocumentDescriptions()public java.util.List<SupportingDocumentDescription> getSupportingDocumentDescriptions()
appendNewSupportingDocumentDescription()public AdditionalSupportingDocuments setSupportingDocumentReference(DocumentReference value)
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
public AdditionalSupportingDocuments setExternalDocumentLocation(java.lang.String value)
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
public AdditionalSupportingDocuments setTypeCode(Codes.SupportingDocumentTypeCode value)
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
public AdditionalSupportingDocuments setAttachedDocumentMimeCode(Codes.Mime value)
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
public AdditionalSupportingDocuments setAttachedDocumentFilename(java.lang.String value)
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
public AdditionalSupportingDocuments setAttachedDocument(BinaryObject value)
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
public AdditionalSupportingDocuments setSchemeIdentifier(Codes.ReferenceCodeIdentifier value)
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
public AdditionalSupportingDocuments setDateTimeStringFormat(java.lang.String value)
value - EXT:Date, format Date Format
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString/@format
public AdditionalSupportingDocuments setDateTimeString(java.lang.String value)
value - EXT:Document Date, Value
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString
public DocumentReference getSupportingDocumentReference()
An identifier of the supporting document.
BR-52: Each Additional supporting document (BG-24) shall contain a Supporting document reference (BT-122).
public java.lang.String getExternalDocumentLocation()
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.
public Codes.SupportingDocumentTypeCode getTypeCode()
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"
public Codes.Mime getAttachedDocumentMimeCode()
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
public java.lang.String getAttachedDocumentFilename()
The file name of the attached document
public BinaryObject getAttachedDocument()
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.
public Codes.ReferenceCodeIdentifier getSchemeIdentifier()
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.
public java.lang.String getDateTimeStringFormat()
public java.lang.String getDateTimeString()