Class InvoiceNote
BG-1 INVOICE NOTE — A group of business terms providing textual notes that are relevant for the invoice, together with an indication of the note subject.
The EN 16931 business terms and groups implemented by this class:
| Represents | BG-1 |
|---|---|
| Business terms (value fields) | BT-X-5, BT-21, BT-22 |
Documentation of the represented business group:
| Description | EN | A group of business terms providing textual notes that are relevant for the invoice, together with an indication of the note subject. |
|---|---|---|
| FR | Groupe de termes métier fournissant des notes en texte pertinentes dans la facture, associées à un indicateur précisant le sujet de la note. |
- Since:
- 1.0.06/2.2
-
Method Summary
Modifier and TypeMethodDescriptionReturns BT-X-5 Content Code — a code to classify the content of the invoiceReturns BT-22 Invoice note — A textual note that gives unstructured information that is relevant to the Invoice as a whole.Returns BT-21 Invoice note subject code — The subject of the textual note in BT-22.setContentCode(String value) Sets BT-X-5 Content Code — a code to classify the content of the invoicesetInvoiceNote(String value) Sets BT-22 Invoice note — A textual note that gives unstructured information that is relevant to the Invoice as a whole.Sets BT-21 Invoice note subject code — The subject of the textual note in BT-22.
-
Method Details
-
setInvoiceNoteSubjectCode
Sets BT-21 Invoice note subject code — The subject of the textual note in BT-22.Usage: To be chosen from the entries in UNTDID 4451 [6].
Conditions (CIUS): Among the list, the following codes can be used:AAI: General InformationSUR: Supplier NotesREG: Regulatory informationABL: Legal InformationTXD: Tax InformationCUS: Customs Information
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IncludedNote/ram:SubjectCodeFR: Sujet de la note de facture en code — Sujet de la note en texte suivant.
- Parameters:
value- the value to set- Returns:
- this
InvoiceNotefor chaining - Since:
- 1.0.06/2.2
-
setInvoiceNote
Sets BT-22 Invoice note — A textual note that gives unstructured information that is relevant to the Invoice as a whole.Usage: Such as the reason for any correction or assignment note in case the invoice has been factored.
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IncludedNote/ram:ContentFR: Note de facture — Sujet de la note en texte suivant.
- Parameters:
value- the value to set- Returns:
- this
InvoiceNotefor chaining - Since:
- 1.0.06/2.2
-
setContentCode
Sets BT-X-5 Content Code — a code to classify the content of the invoiceUsage: To be chosen from the entries in UNTDID 4451 [6], and must be the same meaning than BT-22
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IncludedNote/ram:ContentCodeFR: Note de facture en code — Code permettant de classer le contenu de la note de facturation.
- Parameters:
value- the value to set- Returns:
- this
InvoiceNotefor chaining - Since:
- 1.0.06/2.2
-
getInvoiceNoteSubjectCode
Returns BT-21 Invoice note subject code — The subject of the textual note in BT-22.Usage: To be chosen from the entries in UNTDID 4451 [6].
Conditions (CIUS): Among the list, the following codes can be used:AAI: General InformationSUR: Supplier NotesREG: Regulatory informationABL: Legal InformationTXD: Tax InformationCUS: Customs Information
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IncludedNote/ram:SubjectCodeFR: Sujet de la note de facture en code — Sujet de la note en texte suivant.
- Returns:
- the
BT-21value - Since:
- 1.0.06/2.2
-
getInvoiceNote
Returns BT-22 Invoice note — A textual note that gives unstructured information that is relevant to the Invoice as a whole.Usage: Such as the reason for any correction or assignment note in case the invoice has been factored.
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IncludedNote/ram:ContentFR: Note de facture — Sujet de la note en texte suivant.
- Returns:
- the
BT-22value - Since:
- 1.0.06/2.2
-
getContentCode
Returns BT-X-5 Content Code — a code to classify the content of the invoiceUsage: To be chosen from the entries in UNTDID 4451 [6], and must be the same meaning than BT-22
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IncludedNote/ram:ContentCodeFR: Note de facture en code — Code permettant de classer le contenu de la note de facturation.
- Returns:
- the
BT-X-5value - Since:
- 1.0.06/2.2
-