Class AdditionalSupportingDocuments
- All Implemented Interfaces:
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:
| Represents | BG-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:
| Description | EN | A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice. |
|---|---|---|
| FR | Groupe de termes métiers fournissant des informations sur les documents justificatifs additionnels étayant les demandes formulées dans la Facture. | |
| Usage note | EN | 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. |
| FR | Les 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) | EN | 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) |
| FR | CHORUS 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) |
| Business rule | EN | Use maximum 1 occurrence of Addtionnal Documents block for Tender lor lot reference with Value 50 on BT-17-0 |
|---|---|---|
| FR | Utiliser 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 |
| Business rule | EN | Use maximum 1 ooccurrence of Addtionnal Documents block for Invoiced Object with Value 130 on BT-18-0 |
|---|---|---|
| FR | Utiliser 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 Summary
Modifier and TypeMethodDescriptionReturns BT-125 Attached document — An attached document embedded as binary object or sent together with the invoice.Returns BT-125-2 Attached document Filename — The file name of the attached documentReturns BT-125-1 Attached document Mime code — The mime code of the attached document.getDate()Returns BT-X-149 Document date.Returns BT-X-149-0 Date format.Returns BT-124 External document location — The URL (Uniform Resource Locator) that identifies where the external document is located.getID()Returns BT-122 Supporting document reference — An identifier of the supporting document.Returns BT-18-1 Scheme identifier — The identification scheme identifier of the Invoiced object identifier.Returns BT-123 Supporting document description — A description of the supporting document.Returns BT-122-0.setAttachedDocument(BinaryObject value) Sets BT-125 Attached document — An attached document embedded as binary object or sent together with the invoice.Sets BT-125-2 Attached document Filename — The file name of the attached documentSets BT-125-1 Attached document Mime code — The mime code of the attached document.Sets BT-X-149 Document date.Sets BT-124 External document location — The URL (Uniform Resource Locator) that identifies where the external document is located.Sets BT-122 Supporting document reference — An identifier of the supporting document.Sets BT-18-1 Scheme identifier — The identification scheme identifier of the Invoiced object identifier.Sets BT-123 Supporting document description — A description of the supporting document.Deprecated.
-
Method Details
-
setID
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:IssuerAssignedIDFR: Identifiant de document justificatif — Identifiant du document justificatif.
- Parameters:
value- the value to set- Returns:
- this
AdditionalSupportingDocumentsfor chaining - Since:
- 1.09.2/2.5.2
-
setTypeCode
@Deprecated public AdditionalSupportingDocuments setTypeCode(Codes.SupportingDocumentTypeCode value) Deprecated.the role'sram:TypeCodeis 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
AdditionalSupportingDocumentsfor chaining - Since:
- 1.0.06/2.2
-
setSupportingDocumentDescription
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:NameFR: Description de document justificatif — Description du document justificatif.
- Parameters:
value- the value to set- Returns:
- this
AdditionalSupportingDocumentsfor chaining - Since:
- 1.09.2/2.5.2
-
setExternalDocumentLocation
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: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
AdditionalSupportingDocumentsfor chaining - Since:
- 1.0.06/2.2
-
setAttachedDocument
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:AttachmentBinaryObjectFR: Document joint — Document annexe intégré sous forme d'objet binaire.
- Parameters:
value- the value to set- Returns:
- this
AdditionalSupportingDocumentsfor chaining - Since:
- 1.0.06/2.2
-
setAttachedDocumentMimeCode
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/@mimeCodeFR: Document Mime joint en code — Code Mime du document attaché
- Parameters:
value- the value to set- Returns:
- this
AdditionalSupportingDocumentsfor chaining - Since:
- 1.0.06/2.2
-
setAttachedDocumentFilename
Sets BT-125-2 Attached document Filename — The file name of the attached documentXPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/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
AdditionalSupportingDocumentsfor 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:ReferenceTypeCodeFR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'objet facturé
- Parameters:
value- the value to set- Returns:
- this
AdditionalSupportingDocumentsfor chaining - Since:
- 1.0.06/2.2
-
setDate
Sets BT-X-149 Document date.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeStringFR: 0
- Parameters:
value- the value to set- Returns:
- this
AdditionalSupportingDocumentsfor chaining - Since:
- 1.09.2/2.5.2
-
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:IssuerAssignedIDFR: Identifiant de document justificatif — Identifiant du document justificatif.
- Returns:
- the
BT-122value - Since:
- 1.09.2/2.5.2
-
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-0value - Since:
- 1.0.06/2.2
-
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:NameFR: Description de document justificatif — Description du document justificatif.
- Returns:
- the
BT-123value - Since:
- 1.09.2/2.5.2
-
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:URIIDFR: Emplacement de document externe — Adresse URL (Uniform Resource Locator) qui identifie l’emplacement du document externe.
- Returns:
- the
BT-124value - Since:
- 1.0.06/2.2
-
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:AttachmentBinaryObjectFR: Document joint — Document annexe intégré sous forme d'objet binaire.
- Returns:
- the
BT-125value - Since:
- 1.0.06/2.2
-
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/@mimeCodeFR: Document Mime joint en code — Code Mime du document attaché
- Returns:
- the
BT-125-1value - Since:
- 1.0.06/2.2
-
getAttachedDocumentFilename
Returns BT-125-2 Attached document Filename — The file name of the attached documentXPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:AttachmentBinaryObject/@filenameFR: Nom du fichier du document attaché — Nom du fichier du document attaché.
- Returns:
- the
BT-125-2value - Since:
- 1.0.06/2.2
-
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:ReferenceTypeCodeFR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'objet facturé
- Returns:
- the
BT-18-1value - Since:
- 1.0.06/2.2
-
getDate
Returns BT-X-149 Document date.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:AdditionalReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeStringFR: 0
- Returns:
- the
BT-X-149value - Since:
- 1.09.2/2.5.2
-
getDateFormat
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/@formatFR: Date, format
- Returns:
- the
BT-X-149-0value - Throws:
ComputationException- Since:
- 1.09.2/2.5.2
-
ram:TypeCodeis fixed internally by the per-role factories (appendNewAdditionalSupportingDocument/appendNewTenderOrLotReference/appendNewInvoicedObjectIdentifier); setting it directly is the legacy merged path.