Class AdditionalReferencedDocumentOnLineLevel

java.lang.Object
com.fourjs.report.facturx.profiles.extended.AdditionalReferencedDocumentOnLineLevel
All Implemented Interfaces:
Reference

public class AdditionalReferencedDocumentOnLineLevel extends Object implements 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:

Business terms and groups implemented
RepresentsBG-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:

BG-X-3 — ADDITIONAL REFERENCED DOCUMENT ON LINE LEVEL
DescriptionENReferenced Additional document for this line
Since:
1.09.2/2.5.2
  • Method Details

    • setID

      Sets BT-X-27 Document number.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:IssuerAssignedID

      FR: Identifiant du document

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for chaining
      Since:
      1.09.2/2.5.2
    • setExternalDocumentLocation

      public AdditionalReferencedDocumentOnLineLevel setExternalDocumentLocation(String value)
      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:URIID

      FR: Emplacement de document externe — Adresse URL (Uniform Resource Locator) qui identifie l’emplacement du document externe.

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for 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:LineID

      FR: Identifiant de la ligne du document

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for chaining
      Since:
      1.09.2/2.5.2
    • setDocumentDescription

      public AdditionalReferencedDocumentOnLineLevel setDocumentDescription(String value)
      Sets BT-X-299 Document description.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:Name

      FR: Description de document

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for 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:TypeCode

      FR: Type de document (code)

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for chaining
      Since:
      1.09.2/2.5.2
    • setAttachedDocument

      public AdditionalReferencedDocumentOnLineLevel setAttachedDocument(BinaryObject value)
      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:AttachmentBinaryObject

      FR: Document joint — Document annexe intégré sous forme d'objet binaire.

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for chaining
      Since:
      1.09.2/2.5.2
    • setAttachedDocumentMimeCode

      public AdditionalReferencedDocumentOnLineLevel setAttachedDocumentMimeCode(Codes.Mime value)
      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/@mimeCode

      FR: Document Mime joint en code — Code Mime du document attaché

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for chaining
      Since:
      1.09.2/2.5.2
    • setAttachedDocumentFilename

      public AdditionalReferencedDocumentOnLineLevel setAttachedDocumentFilename(String value)
      Sets BT-X-31-2 Attached document Filename — The file name of the attached document

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@filename

      FR: Nom du fichier du document attaché — Nom du fichier du document attaché.

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for chaining
      Since:
      1.09.2/2.5.2
    • setReferenceTypeCode

      Sets BT-X-32 Type of the document reference (code).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:ReferenceTypeCode

      FR: Type de référence du document (code)

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for 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:DateTimeString

      FR: Date du document, valeur

      Parameters:
      value - the value to set
      Returns:
      this AdditionalReferencedDocumentOnLineLevel for chaining
      Since:
      1.09.2/2.5.2
    • getID

      public String getID()
      Returns BT-X-27 Document number.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:IssuerAssignedID

      FR: Identifiant du document

      Returns:
      the BT-X-27 value
      Since:
      1.09.2/2.5.2
    • getExternalDocumentLocation

      public String 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:URIID

      FR: Emplacement de document externe — Adresse URL (Uniform Resource Locator) qui identifie l’emplacement du document externe.

      Returns:
      the BT-X-28 value
      Since:
      1.09.2/2.5.2
    • getLineID

      public String getLineID()
      Returns BT-X-29 LineID.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:LineID

      FR: Identifiant de la ligne du document

      Returns:
      the BT-X-29 value
      Since:
      1.09.2/2.5.2
    • getDocumentDescription

      public String getDocumentDescription()
      Returns BT-X-299 Document description.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:Name

      FR: Description de document

      Returns:
      the BT-X-299 value
      Since:
      1.09.2/2.5.2
    • getTypeCode

      public Codes.SupportingDocumentTypeCode getTypeCode()
      Returns BT-X-30 Type of the document (code).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:TypeCode

      FR: Type de document (code)

      Returns:
      the BT-X-30 value
      Since:
      1.09.2/2.5.2
    • getAttachedDocument

      public BinaryObject 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:AttachmentBinaryObject

      FR: Document joint — Document annexe intégré sous forme d'objet binaire.

      Returns:
      the BT-X-31 value
      Since:
      1.09.2/2.5.2
    • getAttachedDocumentMimeCode

      public Codes.Mime 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/@mimeCode

      FR: Document Mime joint en code — Code Mime du document attaché

      Returns:
      the BT-X-31-1 value
      Since:
      1.09.2/2.5.2
    • getAttachedDocumentFilename

      public String getAttachedDocumentFilename()
      Returns BT-X-31-2 Attached document Filename — The file name of the attached document

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@filename

      FR: Nom du fichier du document attaché — Nom du fichier du document attaché.

      Returns:
      the BT-X-31-2 value
      Since:
      1.09.2/2.5.2
    • getReferenceTypeCode

      public Codes.ReferenceCodeIdentifier getReferenceTypeCode()
      Returns BT-X-32 Type of the document reference (code).

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:ReferenceTypeCode

      FR: Type de référence du document (code)

      Returns:
      the BT-X-32 value
      Since:
      1.09.2/2.5.2
    • getDate

      public LocalDate getDate()
      Returns BT-X-33 Document date.

      XPath: /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString

      FR: Date du document, valeur

      Returns:
      the BT-X-33 value
      Since:
      1.09.2/2.5.2
    • getDateFormat

      public Codes.DateFormat getDateFormat() throws ComputationException
      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/@format

      FR: Date, format

      Returns:
      the BT-X-33-0 value
      Throws:
      ComputationException
      Since:
      1.09.2/2.5.2