Class ExtendedPrecedingInvoiceReference
- All Implemented Interfaces:
Reference
BG-X-48 PRECEDING INVOICE REFERENCE — A group of business terms providing information on one or more preceding Invoices.
The EN 16931 business terms and groups implemented by this class:
| Represents | BG-X-48 |
|---|---|
| Business terms (value fields) | BT-X-331, BT-X-332, BT-X-333, BT-X-333-0, BT-X-540 |
Documentation of the represented business group:
| Description | EN | A group of business terms providing information on one or more preceding Invoices. |
|---|---|---|
| FR | Groupe de termes métiers fournissant des informations sur une Facture antérieure qui doit être rectifiée ou faire l’objet d’une facture d’avoir. | |
| Usage note | EN | To be used in case: - a preceding invoice is corrected - preceding partial invoices are refered to from a final invoice - preceding pre-payment invoices are refered to from a final invoice |
| FR | À utiliser dans les cas suivants : - la correction d'une facture précédente- la facture finale faisant référence à des factures partielles précédentes- la facture finale faisant référence à des factures de pré-paiement précédentes | |
| Conditions (CIUS) | EN | This business group is mandatory in case of a Credit Note which needs to reference more than one invoices it credits, unless the Credit Note refers to a period which must then be present in group BG-14. |
| FR | Ce groupe est obligatoire en cas d'avoir pour référencer la ou les facture(s) auxquelle(s) l'avoir se réfère en cas de multiple références à une facture antérieure, sauf si l'avoir se réfère à une période qui doit alors être renseignée dans le groupe BG-14. |
- Since:
- 1.0.06/2.2
-
Method Summary
Modifier and TypeMethodDescriptiongetDate()Returns BT-X-333 Preceding Invoice issue date — The date when the Preceding Invoice was issued.Returns BT-X-333-0 Date format.getID()Returns BT-X-331 Preceding Invoice reference — The identification of an Invoice that was previously sent by the Seller.Returns BT-X-540 Preceding invoice Line ID.Returns BT-X-332 Preceding invoive TypeCode — The type of preceding Invoice DocumentSets BT-X-333 Preceding Invoice issue date — The date when the Preceding Invoice was issued.Sets BT-X-331 Preceding Invoice reference — The identification of an Invoice that was previously sent by the Seller.Sets BT-X-540 Preceding invoice Line ID.Sets BT-X-332 Preceding invoive TypeCode — The type of preceding Invoice Document
-
Method Details
-
setID
Sets BT-X-331 Preceding Invoice reference — The identification of an Invoice that was previously sent by the Seller.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:InvoiceReferencedDocument/ram:IssuerAssignedIDFR: Numéro de facture antérieure — Identification d'une Facture précédemment envoyée par le Vendeur.
- Parameters:
value- the value to set- Returns:
- this
ExtendedPrecedingInvoiceReferencefor chaining - Since:
- 1.09.2/2.5.2
-
setPrecedingInvoiceTypeCode
Sets BT-X-332 Preceding invoive TypeCode — The type of preceding Invoice DocumentUsage: Can be used in case of final invoive after prepaid invoice, in order to refernce the previous prepaid invoices.Codelist UNCL 1001 restricted like BT-3.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:InvoiceReferencedDocument/ram:TypeCodeFR: Type de facture antérieure — Le type de la facture antérieure
- Parameters:
value- the value to set- Returns:
- this
ExtendedPrecedingInvoiceReferencefor chaining - Since:
- 1.09.2/2.5.2
-
setDate
Sets BT-X-333 Preceding Invoice issue date — The date when the Preceding Invoice was issued.Usage: The Preceding Invoice issue date shall be provided in case the Preceding Invoice identifier is not unique.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:InvoiceReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeStringFR: Date d'émission de facture antérieure — Date à laquelle la Facture antérieure a été émise.
- Parameters:
value- the value to set- Returns:
- this
ExtendedPrecedingInvoiceReferencefor chaining - Since:
- 1.09.2/2.5.2
-
setLineID
Sets BT-X-540 Preceding invoice Line ID.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:InvoiceReferencedDocument/ram:LineID- Parameters:
value- the value to set- Returns:
- this
ExtendedPrecedingInvoiceReferencefor chaining - Since:
- 1.09.2/2.5.2
-
getID
Returns BT-X-331 Preceding Invoice reference — The identification of an Invoice that was previously sent by the Seller.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:InvoiceReferencedDocument/ram:IssuerAssignedIDFR: Numéro de facture antérieure — Identification d'une Facture précédemment envoyée par le Vendeur.
- Returns:
- the
BT-X-331value - Since:
- 1.09.2/2.5.2
-
getPrecedingInvoiceTypeCode
Returns BT-X-332 Preceding invoive TypeCode — The type of preceding Invoice DocumentUsage: Can be used in case of final invoive after prepaid invoice, in order to refernce the previous prepaid invoices.Codelist UNCL 1001 restricted like BT-3.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:InvoiceReferencedDocument/ram:TypeCodeFR: Type de facture antérieure — Le type de la facture antérieure
- Returns:
- the
BT-X-332value - Since:
- 1.09.2/2.5.2
-
getDate
Returns BT-X-333 Preceding Invoice issue date — The date when the Preceding Invoice was issued.Usage: The Preceding Invoice issue date shall be provided in case the Preceding Invoice identifier is not unique.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:InvoiceReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeStringFR: Date d'émission de facture antérieure — Date à laquelle la Facture antérieure a été émise.
- Returns:
- the
BT-X-333value - Since:
- 1.09.2/2.5.2
-
getDateFormat
Returns BT-X-333-0 Date format.Usage: Value = 102
Rule: Only value "102"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:InvoiceReferencedDocument/ram:FormattedIssueDateTime/qdt:DateTimeString/@formatFR: Date, format
- Returns:
- the
BT-X-333-0value - Throws:
ComputationException- Since:
- 1.0.06/2.2
-
getLineID
Returns BT-X-540 Preceding invoice Line ID.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:InvoiceReferencedDocument/ram:LineID- Returns:
- the
BT-X-540value - Since:
- 1.09.2/2.5.2
-