Class AdditionalReferencedDocumentOnLineLevel
- All Implemented Interfaces:
Reference
BG-X-3 ADDITIONAL REFERENCED DOCUMENT ON LINE LEVEL — Referenced Additional document for this line
The EN 16931 business terms and groups implemented by this class:
| Represents | BG-X-3 |
|---|---|
| Business terms (value fields) | BT-X-27, BT-X-28, BT-X-29, BT-X-30, BT-X-31, BT-X-31-1, BT-X-31-2, BT-X-32, BT-X-33, BT-X-33-0, BT-X-299 |
Documentation of the represented business group:
| Description | EN | Referenced Additional document for this line |
|---|
- Since:
- 1.09.2/2.5.2
-
Method Summary
Modifier and TypeMethodDescriptionReturns BT-X-31 Attached document — An attached document embedded as binary object or sent together with the invoice.Returns BT-X-31-2 Attached document Filename — The file name of the attached documentReturns BT-X-31-1 Attached document Mime code — The mime code of the attached document.getDate()Returns BT-X-33 Document date.Returns BT-X-33-0 Date format.Returns BT-X-299 Document description.Returns BT-X-28 External document location — The URL (Uniform Resource Locator) that identifies where the external document is located.getID()Returns BT-X-27 Document number.Returns BT-X-29 LineID.Returns BT-X-32 Type of the document reference (code).Returns BT-X-30 Type of the document (code).setAttachedDocument(BinaryObject value) Sets BT-X-31 Attached document — An attached document embedded as binary object or sent together with the invoice.Sets BT-X-31-2 Attached document Filename — The file name of the attached documentSets BT-X-31-1 Attached document Mime code — The mime code of the attached document.Sets BT-X-33 Document date.setDocumentDescription(String value) Sets BT-X-299 Document description.Sets BT-X-28 External document location — The URL (Uniform Resource Locator) that identifies where the external document is located.Sets BT-X-27 Document number.Sets BT-X-29 LineID.Sets BT-X-32 Type of the document reference (code).Sets BT-X-30 Type of the document (code).
-
Method Details
-
setID
Sets BT-X-27 Document number.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:IssuerAssignedIDFR: Identifiant du document
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
setExternalDocumentLocation
Sets BT-X-28 External document location — The URL (Uniform Resource Locator) that identifies where the external document is located.Usage: 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:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:URIIDFR: Emplacement de document externe — Adresse URL (Uniform Resource Locator) qui identifie l’emplacement du document externe.
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
setLineID
Sets BT-X-29 LineID.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:LineIDFR: Identifiant de la ligne du document
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
setDocumentDescription
Sets BT-X-299 Document description.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:NameFR: Description de document
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
setTypeCode
Sets BT-X-30 Type of the document (code).XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:TypeCodeFR: Type de document (code)
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
setAttachedDocument
Sets BT-X-31 Attached document — An attached document embedded as binary object or sent together with the invoice.Usage: Attached document is used when documentation shall be stored with the Invoice for future reference or audit purposes.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObjectFR: Document joint — Document annexe intégré sous forme d'objet binaire.
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
setAttachedDocumentMimeCode
Sets BT-X-31-1 Attached document Mime code — The mime code of the attached document.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@mimeCodeFR: Document Mime joint en code — Code Mime du document attaché
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
setAttachedDocumentFilename
Sets BT-X-31-2 Attached document Filename — The file name of the attached documentXPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@filenameFR: Nom du fichier du document attaché — Nom du fichier du document attaché.
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
setReferenceTypeCode
public AdditionalReferencedDocumentOnLineLevel setReferenceTypeCode(Codes.ReferenceCodeIdentifier value) Sets BT-X-32 Type of the document reference (code).XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:ReferenceTypeCodeFR: Type de référence du document (code)
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
setDate
Sets BT-X-33 Document date.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeStringFR: Date du document, valeur
- Parameters:
value- the value to set- Returns:
- this
AdditionalReferencedDocumentOnLineLevelfor chaining - Since:
- 1.09.2/2.5.2
-
getID
Returns BT-X-27 Document number.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:IssuerAssignedIDFR: Identifiant du document
- Returns:
- the
BT-X-27value - Since:
- 1.09.2/2.5.2
-
getExternalDocumentLocation
Returns BT-X-28 External document location — The URL (Uniform Resource Locator) that identifies where the external document is located.Usage: 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:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:URIIDFR: Emplacement de document externe — Adresse URL (Uniform Resource Locator) qui identifie l’emplacement du document externe.
- Returns:
- the
BT-X-28value - Since:
- 1.09.2/2.5.2
-
getLineID
Returns BT-X-29 LineID.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:LineIDFR: Identifiant de la ligne du document
- Returns:
- the
BT-X-29value - Since:
- 1.09.2/2.5.2
-
getDocumentDescription
Returns BT-X-299 Document description.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:NameFR: Description de document
- Returns:
- the
BT-X-299value - Since:
- 1.09.2/2.5.2
-
getTypeCode
Returns BT-X-30 Type of the document (code).XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:TypeCodeFR: Type de document (code)
- Returns:
- the
BT-X-30value - Since:
- 1.09.2/2.5.2
-
getAttachedDocument
Returns BT-X-31 Attached document — An attached document embedded as binary object or sent together with the invoice.Usage: Attached document is used when documentation shall be stored with the Invoice for future reference or audit purposes.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObjectFR: Document joint — Document annexe intégré sous forme d'objet binaire.
- Returns:
- the
BT-X-31value - Since:
- 1.09.2/2.5.2
-
getAttachedDocumentMimeCode
Returns BT-X-31-1 Attached document Mime code — The mime code of the attached document.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@mimeCodeFR: Document Mime joint en code — Code Mime du document attaché
- Returns:
- the
BT-X-31-1value - Since:
- 1.09.2/2.5.2
-
getAttachedDocumentFilename
Returns BT-X-31-2 Attached document Filename — The file name of the attached documentXPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@filenameFR: Nom du fichier du document attaché — Nom du fichier du document attaché.
- Returns:
- the
BT-X-31-2value - Since:
- 1.09.2/2.5.2
-
getReferenceTypeCode
Returns BT-X-32 Type of the document reference (code).XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:ReferenceTypeCodeFR: Type de référence du document (code)
- Returns:
- the
BT-X-32value - Since:
- 1.09.2/2.5.2
-
getDate
Returns BT-X-33 Document date.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeStringFR: Date du document, valeur
- Returns:
- the
BT-X-33value - Since:
- 1.09.2/2.5.2
-
getDateFormat
Returns BT-X-33-0 Date format.Usage: Only value "102"
Rule: Only value "102"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString/@formatFR: Date, format
- Returns:
- the
BT-X-33-0value - Throws:
ComputationException- Since:
- 1.09.2/2.5.2
-