Class AdditionalSupportingDocuments

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

public class AdditionalSupportingDocuments extends Object implements Reference
BG-24 ADDITIONAL SUPPORTING DOCUMENTS — A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice.

The EN 16931 business terms and groups implemented by this class:

Business terms and groups implemented
RepresentsBG-24, BT-17-00, BT-18-00
Business terms (value fields)BT-X-149, BT-X-149-0, BT-X-556, BT-X-556-0, BT-X-557, BT-X-557-0, BT-17, BT-17-0, BT-18, BT-18-0, BT-18-1, BT-122, BT-122-0, BT-123, BT-124, BT-125, BT-125-1, BT-125-2

Documentation of the represented business groups:

BG-24 — ADDITIONAL SUPPORTING DOCUMENTS
DescriptionENA group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice.
FRGroupe de termes métiers fournissant des informations sur les documents justificatifs additionnels étayant les demandes formulées dans la Facture.
Usage noteENThe 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.
FRLes documents justificatifs additionnels peuvent être utilisés pour référencer un numéro de document censé être connu du Destinataire, un document externe (référencé par une adresse URL) ou un document intégré (tel qu'un relevé périodique au format PDF). Le recours à un lien vers un document externe est nécessaire, par exemple, dans le cas de pièces jointes volumineuses et/ou lorsque des informations sensibles, par exemple, des services liés à la personne, doivent être séparées de la Facture elle-même.
Conditions (CIUS)ENCHORUS 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)
FRCHORUS PRO : Si le groupe "DOCUMENTS JUSTIFICATIFS ADDITIONNELS" est renseignée, l’une des deux balises suivantes est obligatoirement renseignée : Contenu (BT-125) ou Identifiant unique (URI) ( BT-124)
BT-17-00 — (TENDER OR LOT REFERENCE)
Business ruleENUse maximum 1 occurrence of Addtionnal Documents block for Tender lor lot reference with Value 50 on BT-17-0
FRUtiliser une occurrence maximum du bloc Documents additionnels pour le champs Identifiant d'appel d'offres ou de lot, avec valeur = 50 sur BT-17-0
BT-18-00 — (INVOICED OBJECT IDENTIFIER)
Business ruleENUse maximum 1 ooccurrence of Addtionnal Documents block for Invoiced Object with Value 130 on BT-18-0
FRUtiliser une occurrence maximum du bloc Documents additionnels pour le champs Identifiant d'Objet Facturé ou de lot, avec valeur = 130 sur BT-18-0
Since:
1.0.06/2.2
  • Method Details

    • setID

      public AdditionalSupportingDocuments setID(String value)
      Sets BT-122 Supporting document reference — An identifier of the supporting document.

      Rule: 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

      FR: Identifiant de document justificatif — Identifiant du document justificatif.

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

      Deprecated.
      the role's ram:TypeCode is fixed internally by the per-role factories (appendNewAdditionalSupportingDocument / appendNewTenderOrLotReference / appendNewInvoicedObjectIdentifier); setting it directly is the legacy merged path.
      Sets BT-122-0.

      Usage: The code 916 "Additional supporting documents" shall be used to refer to the identification of additional supporting documents (BT-122).

      Conditions (CIUS): For this business term, same Xpath for BT-17, BT-18, and BT-122. For BT-18, Value = 916

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

      Parameters:
      value - the value to set
      Returns:
      this AdditionalSupportingDocuments for chaining
      Since:
      1.0.06/2.2
    • setSupportingDocumentDescription

      public AdditionalSupportingDocuments setSupportingDocumentDescription(String value)
      Sets BT-123 Supporting document description — A description of the supporting document.

      Usage: Such as: timesheet, usage report etc.

      Conditions (CIUS): CHORUS PRO: Chorus Pro allows only two types of attachements: main attachment and additional attachment.In the case of a PDF / A-3 (Factur-X), only the type of complementary attachment is allowed.

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

      FR: Description de document justificatif — Description du document justificatif.

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

      public AdditionalSupportingDocuments setExternalDocumentLocation(String value)
      Sets BT-124 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:ApplicableHeaderTradeAgreement/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 AdditionalSupportingDocuments for chaining
      Since:
      1.0.06/2.2
    • setAttachedDocument

      public AdditionalSupportingDocuments setAttachedDocument(BinaryObject value)
      Sets BT-125 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.

      Conditions (CIUS): CHORUS PRO : The attachment must be contained in a ZIP file. The maximum size of the attachment is 100 MB.

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

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

      Parameters:
      value - the value to set
      Returns:
      this AdditionalSupportingDocuments for chaining
      Since:
      1.0.06/2.2
    • setAttachedDocumentMimeCode

      public AdditionalSupportingDocuments setAttachedDocumentMimeCode(Codes.Mime value)
      Sets BT-125-1 Attached document Mime code — The mime code of the attached document.

      Usage: Allowed mime codes:- application/pdf- image/png- image/jpeg- text/csv- application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet- application/vnd.oasis.opendocument.spreadsheet

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

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

      Parameters:
      value - the value to set
      Returns:
      this AdditionalSupportingDocuments for chaining
      Since:
      1.0.06/2.2
    • setAttachedDocumentFilename

      public AdditionalSupportingDocuments setAttachedDocumentFilename(String value)
      Sets 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

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

      Parameters:
      value - the value to set
      Returns:
      this AdditionalSupportingDocuments for chaining
      Since:
      1.0.06/2.2
    • setSchemeIdentifier

      Sets BT-18-1 Scheme identifier — The identification scheme identifier of the Invoiced object identifier.

      Usage: If it may be not clear for the receiver what scheme is used for the identifier, a onditional 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

      FR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'objet facturé

      Parameters:
      value - the value to set
      Returns:
      this AdditionalSupportingDocuments for chaining
      Since:
      1.0.06/2.2
    • setDate

      public AdditionalSupportingDocuments setDate(LocalDate value)
      Sets BT-X-149 Document date.

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

      FR: 0

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

      public String getID()
      Returns BT-122 Supporting document reference — An identifier of the supporting document.

      Rule: 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

      FR: Identifiant de document justificatif — Identifiant du document justificatif.

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

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

      Usage: The code 916 "Additional supporting documents" shall be used to refer to the identification of additional supporting documents (BT-122).

      Conditions (CIUS): For this business term, same Xpath for BT-17, BT-18, and BT-122. For BT-18, Value = 916

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

      Returns:
      the BT-122-0 value
      Since:
      1.0.06/2.2
    • getSupportingDocumentDescription

      public String getSupportingDocumentDescription()
      Returns BT-123 Supporting document description — A description of the supporting document.

      Usage: Such as: timesheet, usage report etc.

      Conditions (CIUS): CHORUS PRO: Chorus Pro allows only two types of attachements: main attachment and additional attachment.In the case of a PDF / A-3 (Factur-X), only the type of complementary attachment is allowed.

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

      FR: Description de document justificatif — Description du document justificatif.

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

      public String getExternalDocumentLocation()
      Returns BT-124 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:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:URIID

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

      Returns:
      the BT-124 value
      Since:
      1.0.06/2.2
    • getAttachedDocument

      public BinaryObject getAttachedDocument()
      Returns BT-125 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.

      Conditions (CIUS): CHORUS PRO : The attachment must be contained in a ZIP file. The maximum size of the attachment is 100 MB.

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

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

      Returns:
      the BT-125 value
      Since:
      1.0.06/2.2
    • getAttachedDocumentMimeCode

      public Codes.Mime getAttachedDocumentMimeCode()
      Returns BT-125-1 Attached document Mime code — The mime code of the attached document.

      Usage: Allowed mime codes:- application/pdf- image/png- image/jpeg- text/csv- application/vnd.openxmlformatsofficedocument.spreadsheetml.sheet- application/vnd.oasis.opendocument.spreadsheet

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

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

      Returns:
      the BT-125-1 value
      Since:
      1.0.06/2.2
    • getAttachedDocumentFilename

      public String getAttachedDocumentFilename()
      Returns 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

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

      Returns:
      the BT-125-2 value
      Since:
      1.0.06/2.2
    • getSchemeIdentifier

      public Codes.ReferenceCodeIdentifier getSchemeIdentifier()
      Returns BT-18-1 Scheme identifier — The identification scheme identifier of the Invoiced object identifier.

      Usage: If it may be not clear for the receiver what scheme is used for the identifier, a onditional 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

      FR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'objet facturé

      Returns:
      the BT-18-1 value
      Since:
      1.0.06/2.2
    • getDate

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

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

      FR: 0

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

      public Codes.DateFormat getDateFormat() throws ComputationException
      Returns BT-X-149-0 Date format.

      Usage: Only value "102"

      Rule: Only value "102"

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

      FR: Date, format

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