Class InvoiceNote

java.lang.Object
com.fourjs.report.facturx.profiles.extended.InvoiceNote

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

Business terms and groups implemented
RepresentsBG-1
Business terms (value fields)BT-X-5, BT-21, BT-22

Documentation of the represented business group:

BG-1 — INVOICE NOTE
DescriptionENA group of business terms providing textual notes that are relevant for the invoice, together with an indication of the note subject.
FRGroupe 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 Details

    • setInvoiceNoteSubjectCode

      public InvoiceNote setInvoiceNoteSubjectCode(Codes.TextSubjectCodeQualifier value)
      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:SubjectCode

      FR: Sujet de la note de facture en code — Sujet de la note en texte suivant.

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

      public InvoiceNote setInvoiceNote(String value)
      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:Content

      FR: Note de facture — Sujet de la note en texte suivant.

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

      public InvoiceNote setContentCode(String value)
      Sets BT-X-5 Content Code — a code to classify the content of the invoice

      Usage: 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:ContentCode

      FR: Note de facture en code — Code permettant de classer le contenu de la note de facturation.

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

      public Codes.TextSubjectCodeQualifier 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:SubjectCode

      FR: Sujet de la note de facture en code — Sujet de la note en texte suivant.

      Returns:
      the BT-21 value
      Since:
      1.0.06/2.2
    • getInvoiceNote

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

      FR: Note de facture — Sujet de la note en texte suivant.

      Returns:
      the BT-22 value
      Since:
      1.0.06/2.2
    • getContentCode

      public String getContentCode()
      Returns BT-X-5 Content Code — a code to classify the content of the invoice

      Usage: 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:ContentCode

      FR: Note de facture en code — Code permettant de classer le contenu de la note de facturation.

      Returns:
      the BT-X-5 value
      Since:
      1.0.06/2.2