Class Invoice
BG-0 Invoice — Cross Industry Invoice
The EN 16931 business terms and groups implemented by this class:
| Represents | BG-0 |
|---|---|
| Covers | BG-2, BG-4, BG-5, BG-7, BG-8, BG-13-00, BG-19, BG-22, BG-25-00, BT-1-00, BT-2-00, BT-10-00, BT-24-00 |
| Business terms (value fields) | BT-1, BT-2, BT-2-0, BT-3, BT-5, BT-6, BT-9, BT-9-0, BT-10, BT-11, BT-11-0, BT-19, BT-20, BT-23, BT-24, BT-27, BT-28, BT-30, BT-30-1, BT-33, BT-34, BT-34-1, BT-35, BT-36, BT-37, BT-38, BT-39, BT-40, BT-41, BT-41-0, BT-42, BT-43, BT-44, BT-45, BT-46, BT-47, BT-47-1, BT-49, BT-49-1, BT-50, BT-51, BT-52, BT-53, BT-54, BT-55, BT-56, BT-56-0, BT-57, BT-58, BT-59, BT-60, BT-61, BT-61-1, BT-62, BT-64, BT-65, BT-66, BT-67, BT-68, BT-69, BT-70, BT-71, BT-72, BT-72-0, BT-73, BT-73-0, BT-74, BT-74-0, BT-75, BT-76, BT-77, BT-78, BT-79, BT-80, BT-83, BT-89, BT-90, BT-106, BT-107, BT-108, BT-109, BT-112, BT-113, BT-114, BT-115, BT-162, BT-163, BT-164, BT-165 |
| Repeatable business terms (value lists) | BT-29 |
| Business groups (object lists) | BG-1, BG-3, BG-16, BG-20, BG-21, BG-23, BG-24, BG-25, BT-12-00, BT-13-00, BT-14-00, BT-15-00, BT-16-00, BT-17-00, BT-18-00, BT-29-0, BT-31-00, BT-32-00, BT-46-0, BT-48-00, BT-60-0, BT-63-00, BT-71-0, BT-110, BT-111 |
Documentation of the represented business group:
| Description | EN | Cross Industry Invoice |
|---|
- Since:
- 1.0.06/2.2
-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractInvoice
AbstractInvoice.Profile -
Field Summary
Fields inherited from class AbstractInvoice
computeBT131, debug -
Constructor Summary
ConstructorsConstructorDescriptionInvoice(IdentifierType invoiceNumber, Codes.InvoiceTypeCode invoiceTypeCode, LocalDate invoiceIssueDate, Codes.Currency invoiceCurrencyCode) Deprecated.Invoice(String invoiceNumber, Codes.InvoiceTypeCode invoiceTypeCode, LocalDate invoiceIssueDate, String sellerName, Codes.CountryCodeList sellerCountryCode, String buyerName, Codes.CountryCodeList buyerCountryCode, Codes.Currency invoiceCurrencyCode) Creates a newInvoicecarrying the profile's mandatory business terms. -
Method Summary
Modifier and TypeMethodDescriptionaddSellerIdentifier(String value) appendNewAdditionalSupportingDocument(String supportingDocumentReference) Deprecated.appendNewAdditionalSupportingDocuments(String supportingDocumentReference, Codes.SupportingDocumentTypeCode typeCode) Deprecated.legacy merged factory -- theram:TypeCoderole discriminator is a caller argument.Deprecated.appendNewBuyerIdentifierSchemeIdentifier(Codes.SchemeIdentifier buyerIdentifierIdentificationSchemeIdentifier, String buyerIdentifierSchemeIdentifier) Creates, appends and returns a newBuyerIdentifierSchemeIdentifier(BT-46-0 Buyer identifier).Deprecated.appendNewBuyerVATIdentifier(String buyerVATIdentifier) Creates, appends and returns a newBuyerVATIdentifier(BT-48-00 (BUYER VAT IDENTIFIER)).Deprecated.appendNewContractReference(String contractReference) Creates, appends and returns a newContractReference(BT-12-00 (CONTRACT REFERENCE)).Deprecated.appendNewDeliverToIdentifierSchemeIdentifier(Codes.SchemeIdentifier deliverToIdentifierIdentificationSchemeIdentifier, String deliverToIdentifierSchemeIdentifier) Creates, appends and returns a newDeliverToIdentifierSchemeIdentifier(BT-71-0 Deliver to location identifier Scheme identifier (GlobalID)).Deprecated.appendNewDespatchAdviceReference(String despatchAdviceReference) Creates, appends and returns a newDespatchAdviceReference(BT-16-00 (DESPATCH ADVICE REFERENCE)).appendNewInvoiceLine(String invoiceLineIdentifier, String itemName, Codes.UnitOfMeasure invoicedQuantityUnitOfMeasureCode, Quantity invoicedQuantity, Codes.VATCategoryCode invoicedItemVATCategoryCode) Creates, appends and returns a newInvoiceLine(BG-25 INVOICE LINE).Deprecated.appendNewInvoiceNote(String invoiceNote) Creates, appends and returns a newInvoiceNote(BG-1 INVOICE NOTE).Creates, appends and returns a newInvoiceTotalVATAmount(BT-110 Invoice total VAT amount).Deprecated.appendNewPayeeIdentifierSchemeIdentifier(Codes.SchemeIdentifier payeeIdentifierIdentificationSchemeIdentifier, String payeeIdentifierSchemeIdentifier) Creates, appends and returns a newPayeeIdentifierSchemeIdentifier(BT-60-0 Payee scheme identifier).appendNewPaymentInstructions(Codes.PaymentMeansCode paymentMeansTypeCode) Creates, appends and returns a newPaymentInstructions(BG-16 PAYMENT INSTRUCTIONS).Deprecated.appendNewPrecedingInvoiceReference(String precedingInvoiceReference) Creates, appends and returns a newPrecedingInvoiceReference(BG-3 PRECEDING INVOICE REFERENCE).Deprecated.appendNewPurchaseOrderReference(String purchaseOrderReference) Creates, appends and returns a newPurchaseOrderReference(BT-13-00 (PURCHASE ORDER REFERENCE)).Deprecated.appendNewReceivingAdviceReference(String receivingAdviceReference) Creates, appends and returns a newReceivingAdviceReference(BT-15-00 (RECEIVING ADVICE REFERENCE)).Deprecated.appendNewSalesOrderReference(String salesOrderReference) Creates, appends and returns a newSalesOrderReference(BT-14-00 (SALES ORDER REFERENCE)).Deprecated.appendNewSellerIdentifierSchemeIdentifier(Codes.SchemeIdentifier sellerIdentifierIdentificationSchemeIdentifier, String sellerIdentifierSchemeIdentifier) Creates, appends and returns a newSellerIdentifierSchemeIdentifier(BT-29-0 Seller identifier (Global ID)).Deprecated.appendNewSellerTaxRepresentativeVATIdentifier(String sellerTaxRepresentativeVATIdentifier) Creates, appends and returns a newSellerTaxRepresentativeVATIdentifier(BT-63-00 (SELLER TAX REPRESENTATIVE VAT IDENTIFIER)).appendNewVATBreakdown(Codes.VATCategoryCode vATCategoryCode) Creates, appends and returns a newVATBreakdown(BG-23 VAT BREAKDOWN).Returns BT-72 Actual delivery date — the date on which the supply of goods or services was made or completed.Returns BT-72-0 Date format.Returns BT-115 Amount due for payment — The outstanding amount that is requested to be paid.Returns BT-90 Bank assigned creditor identifier — Unique banking reference identifier of the Payee or Seller assigned by the Payee or Seller bank.Returns BT-23 Business process type — Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.Returns BT-19 Buyer accounting reference — A textual value that specifies where to book the relevant data into the Buyer's financial accounts.Returns BT-50 Buyer address line 1 — The main address line in an address.Returns BT-51 Buyer address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.Returns BT-163 Buyer address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.Returns BT-52 Buyer city — The common name of the city, town or village, where the Buyer's address is located.Returns BT-58 Buyer contact email address — An e-mail address for the contact point.Returns BT-57 Buyer contact telephone number — A phone number for the contact point.Returns BT-55 Buyer country code — A code that identifies the country.Returns BT-54 Buyer country subdivision — The subdivision of a country.Returns BT-56-0 Buyer contact point.Returns BT-49 Buyer electronic address — Identifies the Buyer's electronic address to which the invoice is delivered.Returns BT-49-1 scheme identifier attribute — The identification scheme identifier of the Buyer electronic address.Returns BT-46 Buyer identifier — An identifier of the Buyer.Returns BT-47 Buyer legal registration identifier — An identifier issued by an official registrar that identifies the Buyer as a legal entity or person.Returns BT-47-1 scheme identifier attribute — The identification scheme identifier of the Buyer legal registration identifier.Returns BT-45 Buyer trading name — A name by which the Buyer is known, other than Buyer name (also known as Business name).Returns BT-44 Buyer name — The full name of the Buyer.Returns BT-56 Buyer contact point — A contact point for a legal entity or person.Returns BT-53 Buyer post code — The identifier for an addressable group of properties according to the relevant postal service.Returns BT-10 Buyer reference — An identifier assigned by the Buyer used for internal routing purposes.Returns BT-2-0 date format.Returns BT-75 Deliver to address line 1 — The main address line in an address.Returns BT-76 Deliver to address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.Returns BT-165 Deliver to address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.Returns BT-77 Deliver to city — The common name of the city, town or village, where the deliver to address is located.Returns BT-80 Deliver to country code — A code that identifies the country.Returns BT-79 Deliver to country subdivision — The subdivision of a country.Returns BT-71 Deliver to location identifier — An identifier for the location at which the goods and services are delivered.Returns BT-70 Deliver to party name — The name of the party to which the goods and services are delivered.Returns BT-78 Deliver to post code — The identifier for an addressable group of properties according to the relevant postal service.Returns BT-9-0 Format.Returns BT-5 Invoice currency code — The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency.Returns BT-2 Invoice issue date — The date when the Invoice was issued.Returns BT-1 Invoice number — A unique identification of the Invoice.Returns BT-109 Invoice total amount without VAT — The total amount of the Invoice without VAT.Returns BT-112 Invoice total amount with VAT — The total amount of the Invoice with VAT.Returns BT-3 Invoice type code — A code specifying the functional type of the Invoice.Returns BT-74 Invoicing period end date — The date when the Invoice period ends.Returns BT-74-0 Date format.Returns BT-73 Invoicing period start date — The date when the Invoice period starts.Returns BT-73-0 Date format.Returns BT-89 Mandate reference identifier — Unique identifier assigned by the Payee for referencing the direct debit mandate.Returns BT-113 Paid amount — The sum of amounts which have been paid in advance.Returns BT-60 Payee identifier Scheme identifier — An identifier for the Payee.Returns BT-61 Payee legal registration identifier Scheme identifier — An identifier issued by an official registrar that identifies the Payee as a legal entity or person.Returns BT-61-1 Scheme identifier — The identification scheme identifier of the Payee legal registration identifier.Returns BT-59 Payee name — The name of the Payee.Returns BT-9 Payment due date — The date when the payment is due.Returns BT-20 Payment terms — A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).Returns BT-11-0 Project name — The identification of the project the invoice refers toReturns BT-11 Project reference — The identification of the project the invoice refers to.Returns BT-83 Remittance information — A textual value used to establish a link between the payment and the Invoice, issued by the Seller.Returns BT-114 Rounding amount — The amount to be added to the invoice total to round the amount to be paid.Returns BT-33 Seller additional legal information — Additional legal information relevant for the Seller.Returns BT-35 Seller address line 1 — The main address line in an address.Returns BT-36 Seller address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.Returns BT-162 Seller address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.Returns BT-37 Seller city — The common name of the city, town or village, where the Seller address is located.Returns BT-43 Seller contact email address — An e-mail address for the contact point.Returns BT-42 Seller contact telephone number — A phone number for the contact point.Returns BT-40 Seller country code — A code that identifies the country.Returns BT-39 Seller country subdivision — The subdivision of a country.Returns BT-41-0 Seller contact point — A contact point for a legal entity or person.Returns BT-34 Seller electronic address — Identifies the Seller's electronic address to which a business document may be delivered.Returns BT-34-1 Seller electronic address identification scheme identifier — The identification scheme identifier of the Seller electronic addressReturns BT-30 Seller legal registration identifier — An identifier issued by an official registrar that identifies the Seller as a legal entity or person.Returns BT-30-1 Seller legal registration identifier identification scheme identifier — The identification scheme identifier of the Seller legal registration identifier.Returns BT-28 Seller trading name — A name by which the Seller is known, other than Seller name (also known as Business name).Returns BT-27 Seller name — The full formal name by which the Seller is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.Returns BT-41 Seller contact point — A contact point for a legal entity or person.Returns BT-38 Seller post code — The identifier for an addressable group of properties according to the relevant postal service.Returns BT-64 Tax representative address line 1 — The main address line in an address.Returns BT-65 Tax representative address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.Returns BT-164 Tax representative address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.Returns BT-66 Tax representative city — The common name of the city, town or village, where the tax representative address is located.Returns BT-69 Tax representative country code — A code that identifies the country.Returns BT-68 Tax representative country subdivision — The subdivision of a country.Returns BT-62 Seller tax representative name — The full name of the Seller's tax representative party.Returns BT-67 Tax representative post code — The identifier for an addressable group of properties according to the relevant postal service.Returns BT-24 Specification identifier — An identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms.Returns BT-107 Sum of allowances on document level — Sum of all allowances on document level in the Invoice.Returns BT-108 Sum of charges on document level — Sum of all charges on document level in the Invoice.Returns BT-106 Sum of Invoice line net amount — Sum of all Invoice line net amounts in the Invoice.Returns BT-6 VAT accounting currency code — The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller.voidsetActualDeliveryDate(LocalDate value) Sets BT-72 Actual delivery date — the date on which the supply of goods or services was made or completed.setAmountDueForPayment(Amount value) Sets BT-115 Amount due for payment — The outstanding amount that is requested to be paid.Sets BT-90 Bank assigned creditor identifier — Unique banking reference identifier of the Payee or Seller assigned by the Payee or Seller bank.setBusinessProcessType(String value) Sets BT-23 Business process type — Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.Sets BT-19 Buyer accounting reference — A textual value that specifies where to book the relevant data into the Buyer's financial accounts.setBuyerAddressLine1(String value) Sets BT-50 Buyer address line 1 — The main address line in an address.setBuyerAddressLine2(String value) Sets BT-51 Buyer address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.setBuyerAddressLine3(String value) Sets BT-163 Buyer address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.setBuyerCity(String value) Sets BT-52 Buyer city — The common name of the city, town or village, where the Buyer's address is located.Sets BT-58 Buyer contact email address — An e-mail address for the contact point.Sets BT-57 Buyer contact telephone number — A phone number for the contact point.Sets BT-55 Buyer country code — A code that identifies the country.setBuyerCountrySubdivision(String value) Sets BT-54 Buyer country subdivision — The subdivision of a country.setBuyerDepartmentName(String value) Sets BT-56-0 Buyer contact point.setBuyerElectronicAddress(String value) Sets BT-49 Buyer electronic address — Identifies the Buyer's electronic address to which the invoice is delivered.Sets BT-49-1 scheme identifier attribute — The identification scheme identifier of the Buyer electronic address.setBuyerIdentifier(String value) Sets BT-46 Buyer identifier — An identifier of the Buyer.Sets BT-47 Buyer legal registration identifier — An identifier issued by an official registrar that identifies the Buyer as a legal entity or person.Sets BT-47-1 scheme identifier attribute — The identification scheme identifier of the Buyer legal registration identifier.Sets BT-45 Buyer trading name — A name by which the Buyer is known, other than Buyer name (also known as Business name).setBuyerName(String value) Sets BT-44 Buyer name — The full name of the Buyer.setBuyerPersonName(String value) Sets BT-56 Buyer contact point — A contact point for a legal entity or person.setBuyerPostCode(String value) Sets BT-53 Buyer post code — The identifier for an addressable group of properties according to the relevant postal service.setBuyerReference(String value) Sets BT-10 Buyer reference — An identifier assigned by the Buyer used for internal routing purposes.setDeliverToAddressLine1(String value) Sets BT-75 Deliver to address line 1 — The main address line in an address.setDeliverToAddressLine2(String value) Sets BT-76 Deliver to address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.setDeliverToAddressLine3(String value) Sets BT-165 Deliver to address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.setDeliverToCity(String value) Sets BT-77 Deliver to city — The common name of the city, town or village, where the deliver to address is located.Sets BT-80 Deliver to country code — A code that identifies the country.Sets BT-79 Deliver to country subdivision — The subdivision of a country.setDeliverToIdentifier(String value) Sets BT-71 Deliver to location identifier — An identifier for the location at which the goods and services are delivered.setDeliverToName(String value) Sets BT-70 Deliver to party name — The name of the party to which the goods and services are delivered.setDeliverToPostCode(String value) Sets BT-78 Deliver to post code — The identifier for an addressable group of properties according to the relevant postal service.Sets BT-5 Invoice currency code — The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency.setInvoiceIssueDate(LocalDate value) Sets BT-2 Invoice issue date — The date when the Invoice was issued.setInvoiceNumber(String value) Sets BT-1 Invoice number — A unique identification of the Invoice.Sets BT-109 Invoice total amount without VAT — The total amount of the Invoice without VAT.Sets BT-112 Invoice total amount with VAT — The total amount of the Invoice with VAT.Sets BT-3 Invoice type code — A code specifying the functional type of the Invoice.Sets BT-74 Invoicing period end date — The date when the Invoice period ends.Sets BT-73 Invoicing period start date — The date when the Invoice period starts.Sets BT-89 Mandate reference identifier — Unique identifier assigned by the Payee for referencing the direct debit mandate.setPaidAmount(Amount value) Sets BT-113 Paid amount — The sum of amounts which have been paid in advance.setPayeeIdentifier(String value) Sets BT-60 Payee identifier Scheme identifier — An identifier for the Payee.Sets BT-61 Payee legal registration identifier Scheme identifier — An identifier issued by an official registrar that identifies the Payee as a legal entity or person.Sets BT-61-1 Scheme identifier — The identification scheme identifier of the Payee legal registration identifier.setPayeeName(String value) Sets BT-59 Payee name — The name of the Payee.setPaymentDueDate(LocalDate value) Sets BT-9 Payment due date — The date when the payment is due.setPaymentTerms(String value) Sets BT-20 Payment terms — A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).setProjectName(String value) Sets BT-11-0 Project name — The identification of the project the invoice refers tosetProjectReference(String value) Sets BT-11 Project reference — The identification of the project the invoice refers to.setRemittanceInformation(String value) Sets BT-83 Remittance information — A textual value used to establish a link between the payment and the Invoice, issued by the Seller.setRoundingAmount(Amount value) Sets BT-114 Rounding amount — The amount to be added to the invoice total to round the amount to be paid.Sets BT-33 Seller additional legal information — Additional legal information relevant for the Seller.setSellerAddressLine1(String value) Sets BT-35 Seller address line 1 — The main address line in an address.setSellerAddressLine2(String value) Sets BT-36 Seller address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.setSellerAddressLine3(String value) Sets BT-162 Seller address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.setSellerCity(String value) Sets BT-37 Seller city — The common name of the city, town or village, where the Seller address is located.Sets BT-43 Seller contact email address — An e-mail address for the contact point.Sets BT-42 Seller contact telephone number — A phone number for the contact point.Sets BT-40 Seller country code — A code that identifies the country.Sets BT-39 Seller country subdivision — The subdivision of a country.setSellerDepartmentName(String value) Sets BT-41-0 Seller contact point — A contact point for a legal entity or person.setSellerElectronicAddress(String value) Sets BT-34 Seller electronic address — Identifies the Seller's electronic address to which a business document may be delivered.Sets BT-34-1 Seller electronic address identification scheme identifier — The identification scheme identifier of the Seller electronic addressSets BT-30 Seller legal registration identifier — An identifier issued by an official registrar that identifies the Seller as a legal entity or person.Sets BT-30-1 Seller legal registration identifier identification scheme identifier — The identification scheme identifier of the Seller legal registration identifier.Sets BT-28 Seller trading name — A name by which the Seller is known, other than Seller name (also known as Business name).setSellerName(String value) Sets BT-27 Seller name — The full formal name by which the Seller is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.setSellerPersonName(String value) Sets BT-41 Seller contact point — A contact point for a legal entity or person.setSellerPostCode(String value) Sets BT-38 Seller post code — The identifier for an addressable group of properties according to the relevant postal service.Sets BT-64 Tax representative address line 1 — The main address line in an address.Sets BT-65 Tax representative address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.Sets BT-164 Tax representative address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.Sets BT-66 Tax representative city — The common name of the city, town or village, where the tax representative address is located.Sets BT-69 Tax representative country code — A code that identifies the country.Sets BT-68 Tax representative country subdivision — The subdivision of a country.Sets BT-62 Seller tax representative name — The full name of the Seller's tax representative party.Sets BT-67 Tax representative post code — The identifier for an addressable group of properties according to the relevant postal service.Sets BT-107 Sum of allowances on document level — Sum of all allowances on document level in the Invoice.Sets BT-108 Sum of charges on document level — Sum of all charges on document level in the Invoice.Sets BT-106 Sum of Invoice line net amount — Sum of all Invoice line net amounts in the Invoice.Sets BT-6 VAT accounting currency code — The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller.voidtoJUnitJavaSourceCode(PrintStream out, String packageName, String className, String referenceFilesDirectory) Creates JUnit Java source code that will construct an Invoice instance identical with this Invoice from API calls and compare the produced XML against a reference file.voidtoXML(PrintWriter out) Serializes to a Factur-X XML document that matches the profile specific XML Schema.Methods inherited from class AbstractInvoice
fromPDFFile, fromXMLFile, getXMLAsDataURL, joinVeryLongString, main, parseDate, setRecompute, toXML
-
Constructor Details
-
Invoice
public Invoice(String invoiceNumber, Codes.InvoiceTypeCode invoiceTypeCode, LocalDate invoiceIssueDate, String sellerName, Codes.CountryCodeList sellerCountryCode, String buyerName, Codes.CountryCodeList buyerCountryCode, Codes.Currency invoiceCurrencyCode) Creates a newInvoicecarrying the profile's mandatory business terms.- Parameters:
invoiceNumber- BT-1 Invoice number — A unique identification of the Invoice.Usage: The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller . It may be based on one or more series of numbers, which may include alphanumeric characters. No identification scheme is to be used.
Conditions (CIUS): CHORUSPRO: the invoice number is limited to 20 characters
Rule: BR-2: An Invoice shall have an Invoice number (BT-1).
FR: Numéro de facture — Identification unique de la Facture.
invoiceTypeCode- BT-3 Invoice type code — A code specifying the functional type of the Invoice.Usage: Commercial invoices and credit notes are defined according the entries in UNTDID 1001 [6]. Other entries of UNTDID 1001 [6] with specific invoices or credit notes may be used if applicable.
Conditions (CIUS): The types of documents used are:380: Commercial Invoice381: Credit note384: Corrected invoice389: Self-billied invoice (created by the buyer on behalf of the supplier)261: Self billed credit note (not accepted by CHORUSPRO)386: Prepayment invoice751: Invoice information for accounting purposes (not accepted by CHORUSPRO)
Rule: BR-4: An Invoice shall have an Invoice type code (BT-3).
FR: Type de facture en code — Code spécifiant le type fonctionnel de la Facture.
invoiceIssueDate- BT-2 Invoice issue date — The date when the Invoice was issued.Conditions (CIUS): CHORUSPRO: the issue date must be before or equal to the deposit date.
Rule: BR-3: An Invoice shall have an Invoice issue date (BT-2).
FR: Date d'émission de la facture — Date à laquelle la Facture a été émise.
sellerName- BT-27 Seller name — The full formal name by which the Seller is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.Rule: BR-6: An Invoice shall contain the Seller name (BT-27).
FR: Raison sociale du vendeur — Dénomination officielle complète sous laquelle le Vendeur est inscrit dans le registre national des personnes morales ou en tant qu'Assujetti, ou alors exerce ses activités en tant que personne ou groupe de personnes.
sellerCountryCode- BT-40 Seller country code — A code that identifies the country.Usage: If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-9: The Seller postal address (BG-5) shall contain a Seller country code (BT-40).
FR: Code de pays du vendeur — Code d'identification du pays.
buyerName- BT-44 Buyer name — The full name of the Buyer.Conditions (CIUS): CHORUS PRO: this field is limied to 99 characters.
Rule: BR-7: An Invoice shall contain the Buyer name (BT-44).
FR: Raison sociale de l'acheteur — Nom complet de l'Acheteur.
buyerCountryCode- BT-55 Buyer country code — A code that identifies the country.Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-11: The Buyer postal address shall contain a Buyer country code (BT-55).
FR: Code de pays de l'acheteur — Code d'identification du pays.
invoiceCurrencyCode- BT-5 Invoice currency code — The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency.Usage: Only one currency shall be used in the Invoice, except for the Total VAT amount in accounting currency (BT-111) in accordance with article 230 of Directive 2006/112/EC on VAT.The lists of valid currencies are registered with the ISO 4217 Maintenance Agency "Codes for the representation of currencies and funds".
Conditions (CIUS): CHORUS PRO: Invoices and credit notes or Chorus Pro are mono-currencies only.
Rule: BR-5: An Invoice shall have an Invoice currency code (BT-5).
FR: Code de devise de facturation — Devise dans laquelle tous les montants de la Facture sont exprimés, à l'exception du montant total de la TVA dans la devise de comptabilisation.
- Since:
- 1.09.2/2.5.2
-
Invoice
@Deprecated public Invoice(IdentifierType invoiceNumber, Codes.InvoiceTypeCode invoiceTypeCode, LocalDate invoiceIssueDate, Codes.Currency invoiceCurrencyCode) Deprecated.Creates an Invoice object- Parameters:
invoiceNumber- BT-1:Invoice numberA unique identification of the Invoice.
The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller. It may be based on one or more series of numbers, which may include alphanumeric characters. No identification scheme is to be used.
CHORUSPRO: the invoice number is limited to 20 characters
BR-2: An Invoice shall have an Invoice number (BT-1).
invoiceTypeCode- BT-3:Invoice type codeA code specifying the functional type of the Invoice.
Commercial invoices and credit notes are defined according the entries in UNTDID 1001 [6].Other entries of UNTDID 1001 [6] with specific invoices or credit notes may be used if applicable.
The types of documents used are:380: Commercial Invoice381: Credit note384: Corrected invoice389: Self-billied invoice (created by the buyer on behalf of the supplier)261: Self billed credit note (not accepted by CHORUSPRO)386: Prepayment invoice751: Invoice information for accounting purposes (not accepted by CHORUSPRO)
BR-4: An Invoice shall have an Invoice type code (BT-3).
invoiceIssueDate- BT-2:Invoice issue dateThe date when the Invoice was issued.
CHORUSPRO: the issue date must be before or equal to the deposit date.
BR-3: An Invoice shall have an Invoice issue date (BT-2).
invoiceCurrencyCode- BT-5:Invoice currency codeThe currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency.
Only one currency shall be used in the Invoice, except for the Invoice total VAT amount in accounting currency (BT-111) in accordance with article 230 of Directive 2006/112/EC on VAT [2].The lists of valid currencies are registered with the ISO 4217 Maintenance Agency “Codes for the representation of currencies and funds”.
CHORUS PRO: Invoices and credit notes or Chorus Pro are mono-currencies only.
BR-5: An Invoice shall have an Invoice currency code (BT-5).
- Since:
- 1.0.06/2.2
-
-
Method Details
-
setInvoiceNumber
Sets BT-1 Invoice number — A unique identification of the Invoice.Usage: The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller . It may be based on one or more series of numbers, which may include alphanumeric characters. No identification scheme is to be used.
Conditions (CIUS): CHORUSPRO: the invoice number is limited to 20 characters
Rule: BR-2: An Invoice shall have an Invoice number (BT-1).
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IDFR: Numéro de facture — Identification unique de la Facture.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setBuyerReference
Sets BT-10 Buyer reference — An identifier assigned by the Buyer used for internal routing purposes.Usage: The identifier is defined by the Buyer (e.g. contact ID, department, office id, project code), but provided by the Seller in the Invoice.
Conditions (CIUS): CHORUS PRO: for the public sector, it is the "Service Exécutant". It is mandatory for some buyers. It must belong to the Chorus Pro repository. It is limited to 100 characters.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerReferenceFR: Référence de l’acheteur — Identifiant attribué par l'Acheteur et destiné au routage de la facture en interne.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSumOfInvoiceLineNetAmount
Sets BT-106 Sum of Invoice line net amount — Sum of all Invoice line net amounts in the Invoice.Rule: BR-12: An Invoice shall have the Sum of Invoice line net amount (BT-106).BR-CO-10: Sum of Invoice line net amount (BT-106) = ∑ Invoice line net amount (BT-131).For EXTENDED profile only, BR-CO-10 is replaced by BR-FXEXT-CO-10, which add a tolerance of 0,01 euro per line, document level charge and allowance in calculation.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:LineTotalAmountFR: Somme du montant net des lignes de facture — Somme du montant net de toutes les lignes de la Facture.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
- API Note:
- This is a computed value: by default it is computed from the invoice contents, and a
value supplied through this method is ignored. There is normally no reason to call this method.
Calling this setter stores the value, but
getSumOfInvoiceLineNetAmount()returns that stored value if and only if recomputation is disabled -- that is,Invoice.setRecompute(false)has been called and is in effect at the momentgetSumOfInvoiceLineNetAmount()is invoked; otherwisegetSumOfInvoiceLineNetAmount()returns the freshly computed value and the stored value is ignored.Because
toXML()reads this value throughgetSumOfInvoiceLineNetAmount(), a value set here appears in the generated XML if and only ifInvoice.setRecompute(false)is called beforetoXML().
-
setSumOfAllowancesOnDocumentLevel
Sets BT-107 Sum of allowances on document level — Sum of all allowances on document level in the Invoice.Usage: Allowances on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.
Rule: BR-CO-11: Sum of allowances on document level (BT-107) = ∑ Document level allowance amount (BT-92).For EXTENDED profile only, BR-CO-11 is replaced by BR-FXEXT-CO-11, which add a tolerance of 0,01 euro per line, document level charge and allowance in calculation.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:AllowanceTotalAmountFR: Somme des remises au niveau du document — Somme de toutes les remises au niveau du document de la Facture.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
- API Note:
- This is a computed value: by default it is computed from the invoice contents, and a
value supplied through this method is ignored. There is normally no reason to call this method.
Calling this setter stores the value, but
getSumOfAllowancesOnDocumentLevel()returns that stored value if and only if recomputation is disabled -- that is,Invoice.setRecompute(false)has been called and is in effect at the momentgetSumOfAllowancesOnDocumentLevel()is invoked; otherwisegetSumOfAllowancesOnDocumentLevel()returns the freshly computed value and the stored value is ignored.Because
toXML()reads this value throughgetSumOfAllowancesOnDocumentLevel(), a value set here appears in the generated XML if and only ifInvoice.setRecompute(false)is called beforetoXML().
-
setSumOfChargesOnDocumentLevel
Sets BT-108 Sum of charges on document level — Sum of all charges on document level in the Invoice.Usage: Charges on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.
Rule: BR-CO-12: Sum of charges on document level (BT-108) = ∑ Document level charge amount (BT-99).For EXTENDED profile only, BR-CO-12 is replaced by BR-FXEXT-CO-12, which add a tolerance of 0,01 euro per line, document level charge and allowance in calculation.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:ChargeTotalAmountFR: Somme des charges ou frais au niveau du document — Somme de toutes les charges ou frais au niveau du document de la Facture.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
- API Note:
- This is a computed value: by default it is computed from the invoice contents, and a
value supplied through this method is ignored. There is normally no reason to call this method.
Calling this setter stores the value, but
getSumOfChargesOnDocumentLevel()returns that stored value if and only if recomputation is disabled -- that is,Invoice.setRecompute(false)has been called and is in effect at the momentgetSumOfChargesOnDocumentLevel()is invoked; otherwisegetSumOfChargesOnDocumentLevel()returns the freshly computed value and the stored value is ignored.Because
toXML()reads this value throughgetSumOfChargesOnDocumentLevel(), a value set here appears in the generated XML if and only ifInvoice.setRecompute(false)is called beforetoXML().
-
setInvoiceTotalAmountWithoutVAT
Sets BT-109 Invoice total amount without VAT — The total amount of the Invoice without VAT.Usage: The Invoice total amount without VAT is the Sum of Invoice line net amount minus Sum of allowances on document level plus Sum of charges on document level.
Rule: BR-13: An Invoice shall have the Invoice total amount without VAT (BT-109).BR-CO-13: Invoice total amount without VAT (BT-109) = ∑ Invoice line net amount (BT-131) - Sum of allowances on document level (BT-107) + Sum of charges on document level (BT-108).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxBasisTotalAmountFR: Montant total de la facture hors TVA — Montant total de la Facture, sans la TVA.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
- API Note:
- This is a computed value: by default it is computed from the invoice contents, and a
value supplied through this method is ignored. There is normally no reason to call this method.
Calling this setter stores the value, but
getInvoiceTotalAmountWithoutVAT()returns that stored value if and only if recomputation is disabled -- that is,Invoice.setRecompute(false)has been called and is in effect at the momentgetInvoiceTotalAmountWithoutVAT()is invoked; otherwisegetInvoiceTotalAmountWithoutVAT()returns the freshly computed value and the stored value is ignored.Because
toXML()reads this value throughgetInvoiceTotalAmountWithoutVAT(), a value set here appears in the generated XML if and only ifInvoice.setRecompute(false)is called beforetoXML().
-
setProjectReference
Sets BT-11 Project reference — The identification of the project the invoice refers to.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:IDFR: Référence au projet — Identification du projet auquel la facture fait référence
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setProjectName
Sets BT-11-0 Project name — The identification of the project the invoice refers toUsage: Value : "Project Reference"
Rule: Use "Project reference" as default value for Name.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:NameFR: Nom — Nom du projet référencé
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setInvoiceTotalAmountWithVAT
Sets BT-112 Invoice total amount with VAT — The total amount of the Invoice with VAT.Usage: The Invoice total amount with VAT is the Invoice total amount without VAT plus the Invoice total VAT amount.
Rule: BR-14: An Invoice shall have the Invoice total amount with VAT (BT-112).BR-CO-15: Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110).For EXTENDED profile only, BR-CO-15 is replaced by BR-FXEXT-CO-15, which add a tolerance of 0,01 euro per line, document level charge and allowance in calculation.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:GrandTotalAmountFR: Montant total de la facture avec TVA comprise — Montant total de la Facture, avec la TVA.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
- API Note:
- This is a computed value: by default it is computed from the invoice contents, and a
value supplied through this method is ignored. There is normally no reason to call this method.
Calling this setter stores the value, but
getInvoiceTotalAmountWithVAT()returns that stored value if and only if recomputation is disabled -- that is,Invoice.setRecompute(false)has been called and is in effect at the momentgetInvoiceTotalAmountWithVAT()is invoked; otherwisegetInvoiceTotalAmountWithVAT()returns the freshly computed value and the stored value is ignored.Because
toXML()reads this value throughgetInvoiceTotalAmountWithVAT(), a value set here appears in the generated XML if and only ifInvoice.setRecompute(false)is called beforetoXML().
-
setPaidAmount
Sets BT-113 Paid amount — The sum of amounts which have been paid in advance.Usage: This amount is subtracted from the invoice total amount with VAT to calculate the amount due for payment.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TotalPrepaidAmountFR: Montant payé — Somme des montants qui ont été payés par anticipation.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setRoundingAmount
Sets BT-114 Rounding amount — The amount to be added to the invoice total to round the amount to be paid.Conditions (CIUS): This case is not applied in France.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:RoundingAmountFR: Montant de l'arrondi — Montant à ajouter au montant total de la facture pour arrondir le montant à payer.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setAmountDueForPayment
Sets BT-115 Amount due for payment — The outstanding amount that is requested to be paid.Usage: This amount is the Invoice total amount with VAT minus the paid amount that has been paid in advance. The amount is zero in case of a fully paid Invoice. The amount may be negative; in that case the Seller owes the amount to the Buyer.
Rule: BR-15: An Invoice shall have the Amount due for payment (BT- 115).BR-CO-16: Amount due for payment (BT-115) = Invoice total amount with VAT (BT-112) -Paid amount (BT-113) + Rounding amount (BT-114).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:DuePayableAmountFR: Montant à payer — Encours dont le paiement est demandé.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
- API Note:
- This is a computed value: by default it is computed from the invoice contents, and a
value supplied through this method is ignored. There is normally no reason to call this method.
Calling this setter stores the value, but
getAmountDueForPayment()returns that stored value if and only if recomputation is disabled -- that is,Invoice.setRecompute(false)has been called and is in effect at the momentgetAmountDueForPayment()is invoked; otherwisegetAmountDueForPayment()returns the freshly computed value and the stored value is ignored.Because
toXML()reads this value throughgetAmountDueForPayment(), a value set here appears in the generated XML if and only ifInvoice.setRecompute(false)is called beforetoXML().
-
setSellerAddressLine3
Sets BT-162 Seller address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineThreeFR: Adresse du vendeur - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerAddressLine3
Sets BT-163 Buyer address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineThreeFR: Adresse de l'acheteur - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerTaxRepresentativeAddressLine3
Sets BT-164 Tax representative address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineThreeFR: Adresse du représentant fiscal - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setDeliverToAddressLine3
Sets BT-165 Deliver to address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineThreeFR: Adresse de livraison - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerAccountingReference
Sets BT-19 Buyer accounting reference — A textual value that specifies where to book the relevant data into the Buyer's financial accounts.Conditions (CIUS): CHORUS PRO: not used
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:IDFR: Référence comptable de l'acheteur — Valeur textuelle spécifiant où imputer les données pertinentes dans les comptes comptables de l'Acheteur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setInvoiceIssueDate
Sets BT-2 Invoice issue date — The date when the Invoice was issued.Conditions (CIUS): CHORUSPRO: the issue date must be before or equal to the deposit date.
Rule: BR-3: An Invoice shall have an Invoice issue date (BT-2).
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IssueDateTime/udt:DateTimeStringFR: Date d'émission de la facture — Date à laquelle la Facture a été émise.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setPaymentTerms
Sets BT-20 Payment terms — A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).Usage: This element may contain multiple lines and multiple terms.
Rule: BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DescriptionFR: Conditions de paiement — Description textuelle des conditions de paiement applicables au montant à payer (y compris la description des pénalités éventuelles).
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBusinessProcessType
Sets BT-23 Business process type — Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.Usage: To be specifid by the Buyer.
Conditions (CIUS): CHORUSPRO: this data makes it possible to inform the "cadre de facturation" (billing framework, which could be invoice from agent, co-contractor, subcontractor, invoicing part of a public works contract, etc.). The codes to be used are defined in the CHORUSPRO specifications: A1 (invoice deposit), A2 (prepaid invoice deposit), ... By default (in the absence of this field), the case A1 is applied.
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:BusinessProcessSpecifiedDocumentContextParameter/ram:IDFR: Identifiant de type de processus métier — Identifie le contexte de processus métier dans lequel se déroule l'opération. Permet à l'Acheteur de traiter la Facture de manière appropriée.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerName
Sets BT-27 Seller name — The full formal name by which the Seller is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.Rule: BR-6: An Invoice shall contain the Seller name (BT-27).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:NameFR: Raison sociale du vendeur — Dénomination officielle complète sous laquelle le Vendeur est inscrit dans le registre national des personnes morales ou en tant qu'Assujetti, ou alors exerce ses activités en tant que personne ou groupe de personnes.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerLegalOrganizationTradingName
Sets BT-28 Seller trading name — A name by which the Seller is known, other than Seller name (also known as Business name).Usage: This may be used if different from the Seller name.
Conditions (CIUS): CHORUS PRO: this field is limied to 99 characters.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessNameFR: Appellation commerciale du vendeur — Nom sous lequel le Vendeur est connu, autre que la Raison sociale du vendeur (également appelée Dénomination commerciale).
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setInvoiceTypeCode
Sets BT-3 Invoice type code — A code specifying the functional type of the Invoice.Usage: Commercial invoices and credit notes are defined according the entries in UNTDID 1001 [6]. Other entries of UNTDID 1001 [6] with specific invoices or credit notes may be used if applicable.
Conditions (CIUS): The types of documents used are:380: Commercial Invoice381: Credit note384: Corrected invoice389: Self-billied invoice (created by the buyer on behalf of the supplier)261: Self billed credit note (not accepted by CHORUSPRO)386: Prepayment invoice751: Invoice information for accounting purposes (not accepted by CHORUSPRO)
Rule: BR-4: An Invoice shall have an Invoice type code (BT-3).
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:TypeCodeFR: Type de facture en code — Code spécifiant le type fonctionnel de la Facture.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerLegalOrganizationIdentifer
Sets BT-30 Seller legal registration identifier — An identifier issued by an official registrar that identifies the Seller as a legal entity or person.Usage: If no identification scheme is specified, it must be known by Buyer and Seller.
Rule: BR-CO-26: In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:IDFR: Identifiant d’enregistrement légal du vendeur — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie le Vendeur comme une entité juridique ou une personne morale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setSellerLegalOrganizationSchemeIdentiferAttribute
Sets BT-30-1 Seller legal registration identifier identification scheme identifier — The identification scheme identifier of the Seller legal registration identifier.Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.
Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeIDFR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'enregistrement légal du vendeur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerAdditionalLegalInformation
Sets BT-33 Seller additional legal information — Additional legal information relevant for the Seller.Usage: Such as share capital.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DescriptionFR: Informations juridiques additionnelles sur le vendeur — Informations juridiques additionnelles sur le Vendeur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerElectronicAddress
Sets BT-34 Seller electronic address — Identifies the Seller's electronic address to which a business document may be delivered.Rule: BR-62: The Seller electronic address (BT-34) shall have a Scheme identifier.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:URIUniversalCommunication/ram:URIIDFR: Adresse électronique du vendeur — Identifie l'adresse électronique du Vendeur à laquelle un document commercial peut être transmis.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setSellerElectronicAddressScheme
Sets BT-34-1 Seller electronic address identification scheme identifier — The identification scheme identifier of the Seller electronic addressUsage: The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeIDFR: Identifiant du schéma — Identifiant du schéma d'identification de l'adresse électronique du vendeur
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerAddressLine1
Sets BT-35 Seller address line 1 — The main address line in an address.Usage: Usually the street name and number or post office box.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineOneFR: Adresse du vendeur - Ligne 1 — Ligne principale d'une adresse.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerAddressLine2
Sets BT-36 Seller address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineTwoFR: Adresse du vendeur - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerCity
Sets BT-37 Seller city — The common name of the city, town or village, where the Seller address is located.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CityNameFR: Localité du vendeur — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse du Vendeur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerPostCode
Sets BT-38 Seller post code — The identifier for an addressable group of properties according to the relevant postal service.Usage: Such as a ZIP code or a post code.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:PostcodeCodeFR: Code postal du vendeur — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerCountrySubdivision
Sets BT-39 Seller country subdivision — The subdivision of a country.Usage: Such as a region, a county, a state, a province, etc.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionNameFR: Subdivision du pays du vendeur — Subdivision d'un pays.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerCountryCode
Sets BT-40 Seller country code — A code that identifies the country.Usage: If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-9: The Seller postal address (BG-5) shall contain a Seller country code (BT-40).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CountryIDFR: Code de pays du vendeur — Code d'identification du pays.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerPersonName
Sets BT-41 Seller contact point — A contact point for a legal entity or person.Usage: Such as person name, contact identification, department or office identification.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DefinedTradeContact/ram:PersonNameFR: Point de contact vendeur — Point de contact correspondant à une entité juridique ou à une personne morale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerDepartmentName
Sets BT-41-0 Seller contact point — A contact point for a legal entity or person.Usage: Such as person name, contact identification, department or office identification : Department Name
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DefinedTradeContact/ram:DepartmentNameFR: Point de contact vendeur — Point de contact correspondant à une entité juridique ou à une personne morale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerContactTelephoneNumber
Sets BT-42 Seller contact telephone number — A phone number for the contact point.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DefinedTradeContact/ram:TelephoneUniversalCommunication/ram:CompleteNumberFR: Numéro de téléphone du contact vendeur — Numéro de téléphone du point de contact.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerContactEmailAddress
Sets BT-43 Seller contact email address — An e-mail address for the contact point.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DefinedTradeContact/ram:EmailURIUniversalCommunication/ram:URIIDFR: Adresse électronique du contact vendeur — Adresse e-mail du point de contact.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerName
Sets BT-44 Buyer name — The full name of the Buyer.Conditions (CIUS): CHORUS PRO: this field is limied to 99 characters.
Rule: BR-7: An Invoice shall contain the Buyer name (BT-44).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:NameFR: Raison sociale de l'acheteur — Nom complet de l'Acheteur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerLegalOrganizationTradingName
Sets BT-45 Buyer trading name — A name by which the Buyer is known, other than Buyer name (also known as Business name).Usage: This may be used if different from the Buyer name.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessNameFR: Nom commercial de l'acheteur — Nom par lequel l'Acheteur est connu, autre que la raison sociale de l'Acheteur (également appelé Nom de l'entreprise).
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerIdentifier
Sets BT-46 Buyer identifier — An identifier of the Buyer.Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Seller assigned identifier of the Buyer.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:IDFR: Identifiant de l'acheteur — Identification de l'Acheteur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setBuyerLegalOrganizationIdentifer
Sets BT-47 Buyer legal registration identifier — An identifier issued by an official registrar that identifies the Buyer as a legal entity or person.Usage: If no identification scheme is specified, it should be known by Buyer and Seller, e.g. the identifier that is exclusively used in the applicable legal environment.
Conditions (CIUS): CHORUSPRO: the identifier of the buyer (public entity) is mandatory and is always a SIRET number
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:IDFR: Identifiant d’enregistrement légal de l'acheteur — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie l'Acheteur comme une entité juridique ou une personne morale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setBuyerLegalOrganizationSchemeIdentiferAttribute
Sets BT-47-1 scheme identifier attribute — The identification scheme identifier of the Buyer legal registration identifier.Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.
Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeIDFR: Identifiant d’enregistrement légal de l'acheteur — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie l'Acheteur comme une entité juridique ou une personne morale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerElectronicAddress
Sets BT-49 Buyer electronic address — Identifies the Buyer's electronic address to which the invoice is delivered.Rule: BR-63: The Buyer electronic address (BT-49) shall have a Scheme identifier.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:URIUniversalCommunication/ram:URIIDFR: Adresse électronique de l'acheteur — Identifie l'adresse électronique de l'Acheteur à laquelle il convient qu'un document commercial soit transmis.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setBuyerElectronicAddressScheme
Sets BT-49-1 scheme identifier attribute — The identification scheme identifier of the Buyer electronic address.Usage: The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeIDFR: Identifiant du schéma — Identifiant du schéma de l'adresse électronique de l'acheteur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setInvoiceCurrencyCode
Sets BT-5 Invoice currency code — The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency.Usage: Only one currency shall be used in the Invoice, except for the Total VAT amount in accounting currency (BT-111) in accordance with article 230 of Directive 2006/112/EC on VAT.The lists of valid currencies are registered with the ISO 4217 Maintenance Agency "Codes for the representation of currencies and funds".
Conditions (CIUS): CHORUS PRO: Invoices and credit notes or Chorus Pro are mono-currencies only.
Rule: BR-5: An Invoice shall have an Invoice currency code (BT-5).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceCurrencyCodeFR: Code de devise de facturation — Devise dans laquelle tous les montants de la Facture sont exprimés, à l'exception du montant total de la TVA dans la devise de comptabilisation.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerAddressLine1
Sets BT-50 Buyer address line 1 — The main address line in an address.Usage: Usually the street name and number or post office box.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineOneFR: Adresse de l'acheteur - Ligne 1 — Ligne principale d'une adresse.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerAddressLine2
Sets BT-51 Buyer address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineTwoFR: Adresse de l'acheteur - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerCity
Sets BT-52 Buyer city — The common name of the city, town or village, where the Buyer's address is located.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CityNameFR: Localité de l'acheteur — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse de l'Acheteur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerPostCode
Sets BT-53 Buyer post code — The identifier for an addressable group of properties according to the relevant postal service.Usage: Such as a ZIP code or a post code.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:PostcodeCodeFR: Code postal de l'acheteur — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerCountrySubdivision
Sets BT-54 Buyer country subdivision — The subdivision of a country.Usage: Such as a region, a county, a state, a province, etc.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionNameFR: Subdivision du pays de l'acheteur — Subdivision d'un pays.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerCountryCode
Sets BT-55 Buyer country code — A code that identifies the country.Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-11: The Buyer postal address shall contain a Buyer country code (BT-55).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CountryIDFR: Code de pays de l'acheteur — Code d'identification du pays.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerPersonName
Sets BT-56 Buyer contact point — A contact point for a legal entity or person.Usage: Such as person name, contact identification, department or office identification : Person Name
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:DefinedTradeContact/ram:PersonNameFR: Point de contact acheteur — Point de contact correspondant à une entité juridique ou à une personne morale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerDepartmentName
Sets BT-56-0 Buyer contact point.Usage: Such as person name, contact identification, department or office identification : Department Name
Conditions (CIUS): For CHORUSPRO, it corresponds to the name of the "Service Exécutant" which is stated in BT-10
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:DefinedTradeContact/ram:DepartmentNameFR: 0
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerContactTelephoneNumber
Sets BT-57 Buyer contact telephone number — A phone number for the contact point.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:DefinedTradeContact/ram:TelephoneUniversalCommunication/ram:CompleteNumberFR: Numéro de téléphone du contact acheteur — Numéro de téléphone du point de contact.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBuyerContactEmailAddress
Sets BT-58 Buyer contact email address — An e-mail address for the contact point.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:DefinedTradeContact/ram:EmailURIUniversalCommunication/ram:URIIDFR: Adresse électronique du contact acheteur — Adresse e-mail du point de contact.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setPayeeName
Sets BT-59 Payee name — The name of the Payee.Usage: Shall be used when the Payee is different from the Seller (but may also be the Seller name).
Conditions (CIUS): If the PAYEE party block is present, the name of the Payee is mandatory
Rule: BR-17: The Payee name (BT-59) shall be provided in the Invoice, if the Payee (BG-10) is different from the Seller (BG-4).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:NameFR: Nom du bénéficiaire — Nom du Bénéficiaire.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setVATAccountingCurrencyCode
Sets BT-6 VAT accounting currency code — The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller.Usage: Shall be used in combination with the Total VAT amount in accounting currency (BT-111) when the VAT accounting currency code differs from the Invoice currency code.The lists of valid currencies are registered with the ISO 4217 Maintenance Agency "Codes for the representation of currencies and funds". Please refer to Article 230 of the Council Directive 2006/112/EC [2] for more information.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxCurrencyCodeFR: Devise de comptabilisation de la TVA — Devise utilisée pour la comptabilisation et la déclaration de la TVA, acceptée ou exigée dans le pays du Vendeur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setPayeeIdentifier
Sets BT-60 Payee identifier Scheme identifier — An identifier for the Payee.Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Buyer or Seller assigned identifier.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:IDFR: Identifiant du bénéficiaire — Identification du Bénéficiaire.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setPayeeLegalOrganizationIdentifer
Sets BT-61 Payee legal registration identifier Scheme identifier — An identifier issued by an official registrar that identifies the Payee as a legal entity or person.Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. the identifier that is exclusively used in the applicable legal environment.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:IDFR: Identifiant d’enregistrement légal du bénéficiaire — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie le Bénéficiaire comme une entité juridique ou une personne morale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setPayeeLegalOrganizationSchemeIdentiferAttribute
Sets BT-61-1 Scheme identifier — The identification scheme identifier of the Payee legal registration identifier.Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.
Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeIDFR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'enregistrement légal du bénéficiaire
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerTaxRepresentativeName
Sets BT-62 Seller tax representative name — The full name of the Seller's tax representative party.Rule: BR-18: The Seller tax representative name (BT-62) shall be provided in the Invoice, if the Seller (BG-4) has a Seller tax representative party (BG-11).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:NameFR: Nom du représentant fiscal du vendeur — Nom complet de la partie représentant fiscalement le Vendeur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerTaxRepresentativeAddressLine1
Sets BT-64 Tax representative address line 1 — The main address line in an address.Usage: Usually the street name and number or the post office box.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineOneFR: Adresse du représentant fiscal - Ligne 1 — Ligne principale d'une adresse.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerTaxRepresentativeAddressLine2
Sets BT-65 Tax representative address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineTwoFR: Adresse du représentant fiscal - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerTaxRepresentativeCity
Sets BT-66 Tax representative city — The common name of the city, town or village, where the tax representative address is located.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CityNameFR: Localité du représentant fiscal — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse du Représentant fiscal.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerTaxRepresentativePostCode
Sets BT-67 Tax representative post code — The identifier for an addressable group of properties according to the relevant postal service.Usage: Such as a ZIP code or a post code.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:PostcodeCodeFR: Code postal du représentant fiscal — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerTaxRepresentativeCountrySubdivision
Sets BT-68 Tax representative country subdivision — The subdivision of a country.Usage: Such as a region, a county, a state, a province, etc.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionNameFR: Subdivision du pays du représentant fiscal — Subdivision d'un pays.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setSellerTaxRepresentativeCountryCode
Sets BT-69 Tax representative country code — A code that identifies the country.Usage: Country where VAT is liable. The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-20: The Seller tax representative postal address (BG-12) shall contain a Tax representative country code (BT-69), if the Seller (BG-4) has a Seller tax representative party (BG-11).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CountryIDFR: Code de pays du représentant fiscal — Code d'identification du pays.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setDeliverToName
Sets BT-70 Deliver to party name — The name of the party to which the goods and services are delivered.Usage: Shall be used if the Deliver to party is different from the Buyer.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:NameFR: Nom de l’intervenant à livrer — Nom de la partie à laquelle les biens et services sont livrés.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setDeliverToIdentifier
Sets BT-71 Deliver to location identifier — An identifier for the location at which the goods and services are delivered.Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Buyer or Seller assigned identifier.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:IDFR: Identifiant de l'établissement de livraison — Identifiant de l'établissement où les biens et services sont livrés.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setActualDeliveryDate
Sets BT-72 Actual delivery date — the date on which the supply of goods or services was made or completed.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeStringFR: Date effective de livraison — Date à laquelle la livraison est effectuée.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setInvoicingPeriodStartDate
Sets BT-73 Invoicing period start date — The date when the Invoice period starts.Usage: The initial date of delivery of goods or services.
Conditions (CIUS): This date must be less than or equal to the period end date (BT-74), if it exists
Rule: BR-CO-19: If Invoicing period (BG-14) is used, the Invoicing period start date (BT-73) or the Invoicing period end date (BT-74) shall be filled, or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeStringFR: Date de début de période de facturation — Date à laquelle commence la période de facturation.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setInvoicingPeriodEndDate
Sets BT-74 Invoicing period end date — The date when the Invoice period ends.Usage: The date on which the delivery of goods or services was completed.
Conditions (CIUS): This date must be greater than or equal to the period start date (BT-73), if it exists
Rule: BR-29: If both Invoicing period start date (BT-73) and Invoicing period end date (BT-74) are given then the Invoicing period end date (BT-74) shall be later or equal to the Invoicing period start date (BT-73).BR-CO-19: If Invoicing period (BG-14) is used, the Invoicing period start date (BT-73) or the Invoicing period end date (BT-74) shall be filled, or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeStringFR: Date de fin de période de facturation — Date à laquelle se termine la période de facturation.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setDeliverToAddressLine1
Sets BT-75 Deliver to address line 1 — The main address line in an address.Usage: Usually the street name and number.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOneFR: Adresse de livraison - Ligne 1 — Ligne principale d'une adresse.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setDeliverToAddressLine2
Sets BT-76 Deliver to address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineTwoFR: Adresse de livraison - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setDeliverToCity
Sets BT-77 Deliver to city — The common name of the city, town or village, where the deliver to address is located.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CityNameFR: Localité de livraison — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse de livraison.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setDeliverToPostCode
Sets BT-78 Deliver to post code — The identifier for an addressable group of properties according to the relevant postal service.Usage: Such as a ZIP code or a post code.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCodeFR: Code postal de livraison — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setDeliverToCountrySubdivision
Sets BT-79 Deliver to country subdivision — The subdivision of a country.Usage: Such as a region, a county, a state, a province, etc.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionNameFR: Subdivision du pays de livraison — Subdivision d'un pays.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setDeliverToCountryCode
Sets BT-80 Deliver to country code — A code that identifies the country.Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-57: Each Deliver to address (BG-15) shall contain a Deliver to country code (BT-80).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountryIDFR: Code du pays de livraison — Code d'identification du pays.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setRemittanceInformation
Sets BT-83 Remittance information — A textual value used to establish a link between the payment and the Invoice, issued by the Seller.Usage: Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. When specifying the textual value, which is commonly the invoice number of the invoice being paid, but may be another seller reference, the buyer should indicate this reference in his payment order when executing the payment. In a payment transaction this reference is transferred back to the Seller as Remittance Information.In order to allow for automatic processing of cross-border SEPA payments, only Latin characters should be used in this field, with a maximum of 140 characters. Referencesection 1.4 of the SEPA credit transfer and SEPA direct debit scheme implementation guides [13] and [14] for details of the allowed characters. Other rules may apply for SEPA payments within national borders.If remittance information is structured according to the ISO 11649:2009 standard [16] for Structured RF Creditor Reference, it shall be mapped to the Structured Remittance Information Creditor Reference field in SEPA payments messages.If remittance information is structured according to the EACT standard for automated reconciliation [17], it shall be mapped to the Unstructured Remittance Information field in SEPA payments messages.”If remittance information is to be mapped to the End To End Identification field or to the Structured Remittance Information Creditor Reference field in SEPA payments messages, then in addition to the Latin character set restriction, the content shall not start or end with a '/' and the content shall not contain '//'s. See reference [15].
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PaymentReferenceFR: Référence de paiement — Valeur textuelle utilisée pour établir un lien entre le paiement et la Facture, émise par le Vendeur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setMandateReferenceIdentifier
Sets BT-89 Mandate reference identifier — Unique identifier assigned by the Payee for referencing the direct debit mandate.Usage: Used in order to pre-notify the Buyer of a SEPA direct debit.
Conditions (CIUS): This is the RUM (Unique Mandate Reference) for SEPA direct debits
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DirectDebitMandateIDFR: Identifiant de référence de mandat — Identifiant unique attribué par le Bénéficiaire, utilisé comme référence pour le mandat de prélèvement automatique.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
setPaymentDueDate
Sets BT-9 Payment due date — The date when the payment is due.Usage: The payment due date reflects the due date of the net payment. For partial payments it states the first net due date. The corresponding description of more complex payment terms can be stated in BT-20 Payment terms.
Rule: BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DueDateDateTime/udt:DateTimeStringFR: Date d'échéance — Date à laquelle le paiement est dû.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.0.06/2.2
-
setBankAssignedCreditorIdentifier
Sets BT-90 Bank assigned creditor identifier — Unique banking reference identifier of the Payee or Seller assigned by the Payee or Seller bank.Usage: Used in order to pre-notify the Buyer of a SEPA direct debit.
Conditions (CIUS): This is the ICS for SEPA direct debits
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:CreditorReferenceIDFR: Identifiant bancaire du créancier — Identifiant de référence bancaire unique du Bénéficiaire ou du Vendeur, attribué par la banque du Bénéficiaire ou du Vendeur.
- Parameters:
value- the value to set- Returns:
- this
Invoicefor chaining - Since:
- 1.09.2/2.5.2
-
getInvoiceNumber
Returns BT-1 Invoice number — A unique identification of the Invoice.Usage: The sequential number required in Article 226(2) of the directive 2006/112/EC [2], to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller . It may be based on one or more series of numbers, which may include alphanumeric characters. No identification scheme is to be used.
Conditions (CIUS): CHORUSPRO: the invoice number is limited to 20 characters
Rule: BR-2: An Invoice shall have an Invoice number (BT-1).
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IDFR: Numéro de facture — Identification unique de la Facture.
- Returns:
- the
BT-1value - Since:
- 1.09.2/2.5.2
-
getBuyerReference
Returns BT-10 Buyer reference — An identifier assigned by the Buyer used for internal routing purposes.Usage: The identifier is defined by the Buyer (e.g. contact ID, department, office id, project code), but provided by the Seller in the Invoice.
Conditions (CIUS): CHORUS PRO: for the public sector, it is the "Service Exécutant". It is mandatory for some buyers. It must belong to the Chorus Pro repository. It is limited to 100 characters.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerReferenceFR: Référence de l’acheteur — Identifiant attribué par l'Acheteur et destiné au routage de la facture en interne.
- Returns:
- the
BT-10value - Since:
- 1.0.06/2.2
-
getProjectReference
Returns BT-11 Project reference — The identification of the project the invoice refers to.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:IDFR: Référence au projet — Identification du projet auquel la facture fait référence
- Returns:
- the
BT-11value - Since:
- 1.09.2/2.5.2
-
getProjectName
Returns BT-11-0 Project name — The identification of the project the invoice refers toUsage: Value : "Project Reference"
Rule: Use "Project reference" as default value for Name.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:NameFR: Nom — Nom du projet référencé
- Returns:
- the
BT-11-0value - Since:
- 1.0.06/2.2
-
getPaidAmount
Returns BT-113 Paid amount — The sum of amounts which have been paid in advance.Usage: This amount is subtracted from the invoice total amount with VAT to calculate the amount due for payment.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TotalPrepaidAmountFR: Montant payé — Somme des montants qui ont été payés par anticipation.
- Returns:
- the
BT-113value - Since:
- 1.0.06/2.2
-
getRoundingAmount
Returns BT-114 Rounding amount — The amount to be added to the invoice total to round the amount to be paid.Conditions (CIUS): This case is not applied in France.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:RoundingAmountFR: Montant de l'arrondi — Montant à ajouter au montant total de la facture pour arrondir le montant à payer.
- Returns:
- the
BT-114value - Since:
- 1.0.06/2.2
-
getSellerAddressLine3
Returns BT-162 Seller address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineThreeFR: Adresse du vendeur - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Returns:
- the
BT-162value - Since:
- 1.0.06/2.2
-
getBuyerAddressLine3
Returns BT-163 Buyer address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineThreeFR: Adresse de l'acheteur - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Returns:
- the
BT-163value - Since:
- 1.0.06/2.2
-
getSellerTaxRepresentativeAddressLine3
Returns BT-164 Tax representative address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineThreeFR: Adresse du représentant fiscal - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Returns:
- the
BT-164value - Since:
- 1.0.06/2.2
-
getDeliverToAddressLine3
Returns BT-165 Deliver to address line 3 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineThreeFR: Adresse de livraison - Ligne 3 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Returns:
- the
BT-165value - Since:
- 1.0.06/2.2
-
getBuyerAccountingReference
Returns BT-19 Buyer accounting reference — A textual value that specifies where to book the relevant data into the Buyer's financial accounts.Conditions (CIUS): CHORUS PRO: not used
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:IDFR: Référence comptable de l'acheteur — Valeur textuelle spécifiant où imputer les données pertinentes dans les comptes comptables de l'Acheteur.
- Returns:
- the
BT-19value - Since:
- 1.0.06/2.2
-
getInvoiceIssueDate
Returns BT-2 Invoice issue date — The date when the Invoice was issued.Conditions (CIUS): CHORUSPRO: the issue date must be before or equal to the deposit date.
Rule: BR-3: An Invoice shall have an Invoice issue date (BT-2).
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IssueDateTime/udt:DateTimeStringFR: Date d'émission de la facture — Date à laquelle la Facture a été émise.
- Returns:
- the
BT-2value - Since:
- 1.0.06/2.2
-
getDateFormat
Returns BT-2-0 date format.Usage: Only value "102"
Rule: Only value "102"
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IssueDateTime/udt:DateTimeString/@formatFR: Format de la date
- Returns:
- the
BT-2-0value - Throws:
ComputationException- Since:
- 1.0.06/2.2
-
getPaymentTerms
Returns BT-20 Payment terms — A textual description of the payment terms that apply to the amount due for payment (Including description of possible penalties).Usage: This element may contain multiple lines and multiple terms.
Rule: BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DescriptionFR: Conditions de paiement — Description textuelle des conditions de paiement applicables au montant à payer (y compris la description des pénalités éventuelles).
- Returns:
- the
BT-20value - Since:
- 1.0.06/2.2
-
getBusinessProcessType
Returns BT-23 Business process type — Identifies the business process context in which the transaction appears, to enable the Buyer to process the Invoice in an appropriate way.Usage: To be specifid by the Buyer.
Conditions (CIUS): CHORUSPRO: this data makes it possible to inform the "cadre de facturation" (billing framework, which could be invoice from agent, co-contractor, subcontractor, invoicing part of a public works contract, etc.). The codes to be used are defined in the CHORUSPRO specifications: A1 (invoice deposit), A2 (prepaid invoice deposit), ... By default (in the absence of this field), the case A1 is applied.
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:BusinessProcessSpecifiedDocumentContextParameter/ram:IDFR: Identifiant de type de processus métier — Identifie le contexte de processus métier dans lequel se déroule l'opération. Permet à l'Acheteur de traiter la Facture de manière appropriée.
- Returns:
- the
BT-23value - Since:
- 1.0.06/2.2
-
getSpecificationIdentifier
Returns BT-24 Specification identifier — An identification of the specification containing the total set of rules regarding semantic content, cardinalities and business rules to which the data contained in the instance document conforms.Usage: This identifies compiance or conformance to this document. Conformant invoices specify: urn:cen.eu:en16931:2017. Invoices, compliant to a user specification may identify that user specification here. No identification scheme is to be used.
Conditions (CIUS): For profile Minimum : urn:factur-x.eu:1p0:minimumFor profile BASIC WL : urn:factur-x.eu:1p0:basicwlFor profile BASIC : urn:cen.eu:en16931:2017#compliant#urn:factur-x.eu:1p0:basicFor Profile EN 16931 (Comfort) : urn:cen.eu:en16931:2017For Profile EXTENDED : urn:cen.eu:en16931:2017#conformant#urn:factur-x.eu:1p0:extended
Rule: BR-1: An Invoice shall have a Specification identifier (BT-24).
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:GuidelineSpecifiedDocumentContextParameter/ram:IDFR: Identification de spécification — Identification de la spécification contenant la totalité des règles concernant le contenu sémantique, les cardinalités et les règles opérationnelles auxquelles se conforment les données contenues dans l’instance de document.
- Returns:
- the
BT-24value - Throws:
ComputationException- Since:
- 1.09.2/2.5.2
-
getSellerName
Returns BT-27 Seller name — The full formal name by which the Seller is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons.Rule: BR-6: An Invoice shall contain the Seller name (BT-27).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:NameFR: Raison sociale du vendeur — Dénomination officielle complète sous laquelle le Vendeur est inscrit dans le registre national des personnes morales ou en tant qu'Assujetti, ou alors exerce ses activités en tant que personne ou groupe de personnes.
- Returns:
- the
BT-27value - Since:
- 1.0.06/2.2
-
getSellerLegalOrganizationTradingName
Returns BT-28 Seller trading name — A name by which the Seller is known, other than Seller name (also known as Business name).Usage: This may be used if different from the Seller name.
Conditions (CIUS): CHORUS PRO: this field is limied to 99 characters.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessNameFR: Appellation commerciale du vendeur — Nom sous lequel le Vendeur est connu, autre que la Raison sociale du vendeur (également appelée Dénomination commerciale).
- Returns:
- the
BT-28value - Since:
- 1.0.06/2.2
-
getInvoiceTypeCode
Returns BT-3 Invoice type code — A code specifying the functional type of the Invoice.Usage: Commercial invoices and credit notes are defined according the entries in UNTDID 1001 [6]. Other entries of UNTDID 1001 [6] with specific invoices or credit notes may be used if applicable.
Conditions (CIUS): The types of documents used are:380: Commercial Invoice381: Credit note384: Corrected invoice389: Self-billied invoice (created by the buyer on behalf of the supplier)261: Self billed credit note (not accepted by CHORUSPRO)386: Prepayment invoice751: Invoice information for accounting purposes (not accepted by CHORUSPRO)
Rule: BR-4: An Invoice shall have an Invoice type code (BT-3).
XPath:
/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:TypeCodeFR: Type de facture en code — Code spécifiant le type fonctionnel de la Facture.
- Returns:
- the
BT-3value - Since:
- 1.0.06/2.2
-
getSellerLegalOrganizationIdentifer
Returns BT-30 Seller legal registration identifier — An identifier issued by an official registrar that identifies the Seller as a legal entity or person.Usage: If no identification scheme is specified, it must be known by Buyer and Seller.
Rule: BR-CO-26: In order for the buyer to automatically identify a supplier, the Seller identifier (BT-29), the Seller legal registration identifier (BT-30) and/or the Seller VAT identifier (BT-31) shall be present.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:IDFR: Identifiant d’enregistrement légal du vendeur — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie le Vendeur comme une entité juridique ou une personne morale.
- Returns:
- the
BT-30value - Since:
- 1.09.2/2.5.2
-
getSellerLegalOrganizationSchemeIdentiferAttribute
Returns BT-30-1 Seller legal registration identifier identification scheme identifier — The identification scheme identifier of the Seller legal registration identifier.Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.
Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeIDFR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'enregistrement légal du vendeur.
- Returns:
- the
BT-30-1value - Since:
- 1.0.06/2.2
-
getSellerAdditionalLegalInformation
Returns BT-33 Seller additional legal information — Additional legal information relevant for the Seller.Usage: Such as share capital.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DescriptionFR: Informations juridiques additionnelles sur le vendeur — Informations juridiques additionnelles sur le Vendeur.
- Returns:
- the
BT-33value - Since:
- 1.0.06/2.2
-
getSellerElectronicAddress
Returns BT-34 Seller electronic address — Identifies the Seller's electronic address to which a business document may be delivered.Rule: BR-62: The Seller electronic address (BT-34) shall have a Scheme identifier.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:URIUniversalCommunication/ram:URIIDFR: Adresse électronique du vendeur — Identifie l'adresse électronique du Vendeur à laquelle un document commercial peut être transmis.
- Returns:
- the
BT-34value - Since:
- 1.09.2/2.5.2
-
getSellerElectronicAddressScheme
Returns BT-34-1 Seller electronic address identification scheme identifier — The identification scheme identifier of the Seller electronic addressUsage: The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeIDFR: Identifiant du schéma — Identifiant du schéma d'identification de l'adresse électronique du vendeur
- Returns:
- the
BT-34-1value - Since:
- 1.0.06/2.2
-
getSellerAddressLine1
Returns BT-35 Seller address line 1 — The main address line in an address.Usage: Usually the street name and number or post office box.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineOneFR: Adresse du vendeur - Ligne 1 — Ligne principale d'une adresse.
- Returns:
- the
BT-35value - Since:
- 1.0.06/2.2
-
getSellerAddressLine2
Returns BT-36 Seller address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineTwoFR: Adresse du vendeur - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Returns:
- the
BT-36value - Since:
- 1.0.06/2.2
-
getSellerCity
Returns BT-37 Seller city — The common name of the city, town or village, where the Seller address is located.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CityNameFR: Localité du vendeur — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse du Vendeur.
- Returns:
- the
BT-37value - Since:
- 1.0.06/2.2
-
getSellerPostCode
Returns BT-38 Seller post code — The identifier for an addressable group of properties according to the relevant postal service.Usage: Such as a ZIP code or a post code.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:PostcodeCodeFR: Code postal du vendeur — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.
- Returns:
- the
BT-38value - Since:
- 1.0.06/2.2
-
getSellerCountrySubdivision
Returns BT-39 Seller country subdivision — The subdivision of a country.Usage: Such as a region, a county, a state, a province, etc.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionNameFR: Subdivision du pays du vendeur — Subdivision d'un pays.
- Returns:
- the
BT-39value - Since:
- 1.0.06/2.2
-
getSellerCountryCode
Returns BT-40 Seller country code — A code that identifies the country.Usage: If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-9: The Seller postal address (BG-5) shall contain a Seller country code (BT-40).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CountryIDFR: Code de pays du vendeur — Code d'identification du pays.
- Returns:
- the
BT-40value - Since:
- 1.0.06/2.2
-
getSellerPersonName
Returns BT-41 Seller contact point — A contact point for a legal entity or person.Usage: Such as person name, contact identification, department or office identification.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DefinedTradeContact/ram:PersonNameFR: Point de contact vendeur — Point de contact correspondant à une entité juridique ou à une personne morale.
- Returns:
- the
BT-41value - Since:
- 1.0.06/2.2
-
getSellerDepartmentName
Returns BT-41-0 Seller contact point — A contact point for a legal entity or person.Usage: Such as person name, contact identification, department or office identification : Department Name
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DefinedTradeContact/ram:DepartmentNameFR: Point de contact vendeur — Point de contact correspondant à une entité juridique ou à une personne morale.
- Returns:
- the
BT-41-0value - Since:
- 1.0.06/2.2
-
getSellerContactTelephoneNumber
Returns BT-42 Seller contact telephone number — A phone number for the contact point.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DefinedTradeContact/ram:TelephoneUniversalCommunication/ram:CompleteNumberFR: Numéro de téléphone du contact vendeur — Numéro de téléphone du point de contact.
- Returns:
- the
BT-42value - Since:
- 1.0.06/2.2
-
getSellerContactEmailAddress
Returns BT-43 Seller contact email address — An e-mail address for the contact point.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:DefinedTradeContact/ram:EmailURIUniversalCommunication/ram:URIIDFR: Adresse électronique du contact vendeur — Adresse e-mail du point de contact.
- Returns:
- the
BT-43value - Since:
- 1.0.06/2.2
-
getBuyerName
Returns BT-44 Buyer name — The full name of the Buyer.Conditions (CIUS): CHORUS PRO: this field is limied to 99 characters.
Rule: BR-7: An Invoice shall contain the Buyer name (BT-44).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:NameFR: Raison sociale de l'acheteur — Nom complet de l'Acheteur.
- Returns:
- the
BT-44value - Since:
- 1.0.06/2.2
-
getBuyerLegalOrganizationTradingName
Returns BT-45 Buyer trading name — A name by which the Buyer is known, other than Buyer name (also known as Business name).Usage: This may be used if different from the Buyer name.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessNameFR: Nom commercial de l'acheteur — Nom par lequel l'Acheteur est connu, autre que la raison sociale de l'Acheteur (également appelé Nom de l'entreprise).
- Returns:
- the
BT-45value - Since:
- 1.0.06/2.2
-
getBuyerIdentifier
Returns BT-46 Buyer identifier — An identifier of the Buyer.Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Seller assigned identifier of the Buyer.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:IDFR: Identifiant de l'acheteur — Identification de l'Acheteur.
- Returns:
- the
BT-46value - Since:
- 1.09.2/2.5.2
-
getBuyerLegalOrganizationIdentifer
Returns BT-47 Buyer legal registration identifier — An identifier issued by an official registrar that identifies the Buyer as a legal entity or person.Usage: If no identification scheme is specified, it should be known by Buyer and Seller, e.g. the identifier that is exclusively used in the applicable legal environment.
Conditions (CIUS): CHORUSPRO: the identifier of the buyer (public entity) is mandatory and is always a SIRET number
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:IDFR: Identifiant d’enregistrement légal de l'acheteur — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie l'Acheteur comme une entité juridique ou une personne morale.
- Returns:
- the
BT-47value - Since:
- 1.09.2/2.5.2
-
getBuyerLegalOrganizationSchemeIdentiferAttribute
Returns BT-47-1 scheme identifier attribute — The identification scheme identifier of the Buyer legal registration identifier.Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.
Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeIDFR: Identifiant d’enregistrement légal de l'acheteur — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie l'Acheteur comme une entité juridique ou une personne morale.
- Returns:
- the
BT-47-1value - Since:
- 1.0.06/2.2
-
getBuyerElectronicAddress
Returns BT-49 Buyer electronic address — Identifies the Buyer's electronic address to which the invoice is delivered.Rule: BR-63: The Buyer electronic address (BT-49) shall have a Scheme identifier.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:URIUniversalCommunication/ram:URIIDFR: Adresse électronique de l'acheteur — Identifie l'adresse électronique de l'Acheteur à laquelle il convient qu'un document commercial soit transmis.
- Returns:
- the
BT-49value - Since:
- 1.09.2/2.5.2
-
getBuyerElectronicAddressScheme
Returns BT-49-1 scheme identifier attribute — The identification scheme identifier of the Buyer electronic address.Usage: The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeIDFR: Identifiant du schéma — Identifiant du schéma de l'adresse électronique de l'acheteur.
- Returns:
- the
BT-49-1value - Since:
- 1.0.06/2.2
-
getInvoiceCurrencyCode
Returns BT-5 Invoice currency code — The currency in which all Invoice amounts are given, except for the Total VAT amount in accounting currency.Usage: Only one currency shall be used in the Invoice, except for the Total VAT amount in accounting currency (BT-111) in accordance with article 230 of Directive 2006/112/EC on VAT.The lists of valid currencies are registered with the ISO 4217 Maintenance Agency "Codes for the representation of currencies and funds".
Conditions (CIUS): CHORUS PRO: Invoices and credit notes or Chorus Pro are mono-currencies only.
Rule: BR-5: An Invoice shall have an Invoice currency code (BT-5).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceCurrencyCodeFR: Code de devise de facturation — Devise dans laquelle tous les montants de la Facture sont exprimés, à l'exception du montant total de la TVA dans la devise de comptabilisation.
- Returns:
- the
BT-5value - Since:
- 1.0.06/2.2
-
getBuyerAddressLine1
Returns BT-50 Buyer address line 1 — The main address line in an address.Usage: Usually the street name and number or post office box.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineOneFR: Adresse de l'acheteur - Ligne 1 — Ligne principale d'une adresse.
- Returns:
- the
BT-50value - Since:
- 1.0.06/2.2
-
getBuyerAddressLine2
Returns BT-51 Buyer address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineTwoFR: Adresse de l'acheteur - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Returns:
- the
BT-51value - Since:
- 1.0.06/2.2
-
getBuyerCity
Returns BT-52 Buyer city — The common name of the city, town or village, where the Buyer's address is located.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CityNameFR: Localité de l'acheteur — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse de l'Acheteur.
- Returns:
- the
BT-52value - Since:
- 1.0.06/2.2
-
getBuyerPostCode
Returns BT-53 Buyer post code — The identifier for an addressable group of properties according to the relevant postal service.Usage: Such as a ZIP code or a post code.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:PostcodeCodeFR: Code postal de l'acheteur — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.
- Returns:
- the
BT-53value - Since:
- 1.0.06/2.2
-
getBuyerCountrySubdivision
Returns BT-54 Buyer country subdivision — The subdivision of a country.Usage: Such as a region, a county, a state, a province, etc.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionNameFR: Subdivision du pays de l'acheteur — Subdivision d'un pays.
- Returns:
- the
BT-54value - Since:
- 1.0.06/2.2
-
getBuyerCountryCode
Returns BT-55 Buyer country code — A code that identifies the country.Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-11: The Buyer postal address shall contain a Buyer country code (BT-55).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CountryIDFR: Code de pays de l'acheteur — Code d'identification du pays.
- Returns:
- the
BT-55value - Since:
- 1.0.06/2.2
-
getBuyerPersonName
Returns BT-56 Buyer contact point — A contact point for a legal entity or person.Usage: Such as person name, contact identification, department or office identification : Person Name
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:DefinedTradeContact/ram:PersonNameFR: Point de contact acheteur — Point de contact correspondant à une entité juridique ou à une personne morale.
- Returns:
- the
BT-56value - Since:
- 1.0.06/2.2
-
getBuyerDepartmentName
Returns BT-56-0 Buyer contact point.Usage: Such as person name, contact identification, department or office identification : Department Name
Conditions (CIUS): For CHORUSPRO, it corresponds to the name of the "Service Exécutant" which is stated in BT-10
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:DefinedTradeContact/ram:DepartmentNameFR: 0
- Returns:
- the
BT-56-0value - Since:
- 1.0.06/2.2
-
getBuyerContactTelephoneNumber
Returns BT-57 Buyer contact telephone number — A phone number for the contact point.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:DefinedTradeContact/ram:TelephoneUniversalCommunication/ram:CompleteNumberFR: Numéro de téléphone du contact acheteur — Numéro de téléphone du point de contact.
- Returns:
- the
BT-57value - Since:
- 1.0.06/2.2
-
getBuyerContactEmailAddress
Returns BT-58 Buyer contact email address — An e-mail address for the contact point.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:DefinedTradeContact/ram:EmailURIUniversalCommunication/ram:URIIDFR: Adresse électronique du contact acheteur — Adresse e-mail du point de contact.
- Returns:
- the
BT-58value - Since:
- 1.0.06/2.2
-
getPayeeName
Returns BT-59 Payee name — The name of the Payee.Usage: Shall be used when the Payee is different from the Seller (but may also be the Seller name).
Conditions (CIUS): If the PAYEE party block is present, the name of the Payee is mandatory
Rule: BR-17: The Payee name (BT-59) shall be provided in the Invoice, if the Payee (BG-10) is different from the Seller (BG-4).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:NameFR: Nom du bénéficiaire — Nom du Bénéficiaire.
- Returns:
- the
BT-59value - Since:
- 1.0.06/2.2
-
getVATAccountingCurrencyCode
Returns BT-6 VAT accounting currency code — The currency used for VAT accounting and reporting purposes as accepted or required in the country of the Seller.Usage: Shall be used in combination with the Total VAT amount in accounting currency (BT-111) when the VAT accounting currency code differs from the Invoice currency code.The lists of valid currencies are registered with the ISO 4217 Maintenance Agency "Codes for the representation of currencies and funds". Please refer to Article 230 of the Council Directive 2006/112/EC [2] for more information.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxCurrencyCodeFR: Devise de comptabilisation de la TVA — Devise utilisée pour la comptabilisation et la déclaration de la TVA, acceptée ou exigée dans le pays du Vendeur.
- Returns:
- the
BT-6value - Since:
- 1.0.06/2.2
-
getPayeeIdentifier
Returns BT-60 Payee identifier Scheme identifier — An identifier for the Payee.Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Buyer or Seller assigned identifier.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:IDFR: Identifiant du bénéficiaire — Identification du Bénéficiaire.
- Returns:
- the
BT-60value - Since:
- 1.09.2/2.5.2
-
getPayeeLegalOrganizationIdentifer
Returns BT-61 Payee legal registration identifier Scheme identifier — An identifier issued by an official registrar that identifies the Payee as a legal entity or person.Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. the identifier that is exclusively used in the applicable legal environment.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:IDFR: Identifiant d’enregistrement légal du bénéficiaire — Identifiant délivré par un organisme d’enregistrement officiel, qui identifie le Bénéficiaire comme une entité juridique ou une personne morale.
- Returns:
- the
BT-61value - Since:
- 1.09.2/2.5.2
-
getPayeeLegalOrganizationSchemeIdentiferAttribute
Returns BT-61-1 Scheme identifier — The identification scheme identifier of the Payee legal registration identifier.Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.
Conditions (CIUS): For a SIREN or a SIRET, the value of this field is "0002"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeIDFR: Identifiant du schéma — Identifiant du schéma de l'identifiant d'enregistrement légal du bénéficiaire
- Returns:
- the
BT-61-1value - Since:
- 1.0.06/2.2
-
getSellerTaxRepresentativeName
Returns BT-62 Seller tax representative name — The full name of the Seller's tax representative party.Rule: BR-18: The Seller tax representative name (BT-62) shall be provided in the Invoice, if the Seller (BG-4) has a Seller tax representative party (BG-11).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:NameFR: Nom du représentant fiscal du vendeur — Nom complet de la partie représentant fiscalement le Vendeur.
- Returns:
- the
BT-62value - Since:
- 1.0.06/2.2
-
getSellerTaxRepresentativeAddressLine1
Returns BT-64 Tax representative address line 1 — The main address line in an address.Usage: Usually the street name and number or the post office box.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineOneFR: Adresse du représentant fiscal - Ligne 1 — Ligne principale d'une adresse.
- Returns:
- the
BT-64value - Since:
- 1.0.06/2.2
-
getSellerTaxRepresentativeAddressLine2
Returns BT-65 Tax representative address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineTwoFR: Adresse du représentant fiscal - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Returns:
- the
BT-65value - Since:
- 1.0.06/2.2
-
getSellerTaxRepresentativeCity
Returns BT-66 Tax representative city — The common name of the city, town or village, where the tax representative address is located.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CityNameFR: Localité du représentant fiscal — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse du Représentant fiscal.
- Returns:
- the
BT-66value - Since:
- 1.0.06/2.2
-
getSellerTaxRepresentativePostCode
Returns BT-67 Tax representative post code — The identifier for an addressable group of properties according to the relevant postal service.Usage: Such as a ZIP code or a post code.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:PostcodeCodeFR: Code postal du représentant fiscal — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.
- Returns:
- the
BT-67value - Since:
- 1.0.06/2.2
-
getSellerTaxRepresentativeCountrySubdivision
Returns BT-68 Tax representative country subdivision — The subdivision of a country.Usage: Such as a region, a county, a state, a province, etc.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionNameFR: Subdivision du pays du représentant fiscal — Subdivision d'un pays.
- Returns:
- the
BT-68value - Since:
- 1.0.06/2.2
-
getSellerTaxRepresentativeCountryCode
Returns BT-69 Tax representative country code — A code that identifies the country.Usage: Country where VAT is liable. The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-20: The Seller tax representative postal address (BG-12) shall contain a Tax representative country code (BT-69), if the Seller (BG-4) has a Seller tax representative party (BG-11).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CountryIDFR: Code de pays du représentant fiscal — Code d'identification du pays.
- Returns:
- the
BT-69value - Since:
- 1.0.06/2.2
-
getDeliverToName
Returns BT-70 Deliver to party name — The name of the party to which the goods and services are delivered.Usage: Shall be used if the Deliver to party is different from the Buyer.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:NameFR: Nom de l’intervenant à livrer — Nom de la partie à laquelle les biens et services sont livrés.
- Returns:
- the
BT-70value - Since:
- 1.0.06/2.2
-
getDeliverToIdentifier
Returns BT-71 Deliver to location identifier — An identifier for the location at which the goods and services are delivered.Usage: If no scheme is specified, it should be known by Buyer and Seller, e.g. a previously exchanged Buyer or Seller assigned identifier.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:IDFR: Identifiant de l'établissement de livraison — Identifiant de l'établissement où les biens et services sont livrés.
- Returns:
- the
BT-71value - Since:
- 1.09.2/2.5.2
-
getActualDeliveryDate
Returns BT-72 Actual delivery date — the date on which the supply of goods or services was made or completed.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeStringFR: Date effective de livraison — Date à laquelle la livraison est effectuée.
- Returns:
- the
BT-72value - Since:
- 1.0.06/2.2
-
getActualDeliveryDateFormat
Returns BT-72-0 Date format.Usage: Value = 102
Rule: Only value "102"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString/@formatFR: Date format
- Returns:
- the
BT-72-0value - Throws:
ComputationException- Since:
- 1.0.06/2.2
-
getInvoicingPeriodStartDate
Returns BT-73 Invoicing period start date — The date when the Invoice period starts.Usage: The initial date of delivery of goods or services.
Conditions (CIUS): This date must be less than or equal to the period end date (BT-74), if it exists
Rule: BR-CO-19: If Invoicing period (BG-14) is used, the Invoicing period start date (BT-73) or the Invoicing period end date (BT-74) shall be filled, or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeStringFR: Date de début de période de facturation — Date à laquelle commence la période de facturation.
- Returns:
- the
BT-73value - Since:
- 1.0.06/2.2
-
getInvoicingPeriodStartDateFormat
Returns BT-73-0 Date format.Usage: Only value "102"
Rule: Only value "102"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString/@format- Returns:
- the
BT-73-0value - Throws:
ComputationException- Since:
- 1.0.06/2.2
-
getInvoicingPeriodEndDate
Returns BT-74 Invoicing period end date — The date when the Invoice period ends.Usage: The date on which the delivery of goods or services was completed.
Conditions (CIUS): This date must be greater than or equal to the period start date (BT-73), if it exists
Rule: BR-29: If both Invoicing period start date (BT-73) and Invoicing period end date (BT-74) are given then the Invoicing period end date (BT-74) shall be later or equal to the Invoicing period start date (BT-73).BR-CO-19: If Invoicing period (BG-14) is used, the Invoicing period start date (BT-73) or the Invoicing period end date (BT-74) shall be filled, or both.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeStringFR: Date de fin de période de facturation — Date à laquelle se termine la période de facturation.
- Returns:
- the
BT-74value - Since:
- 1.0.06/2.2
-
getInvoicingPeriodEndDateFormat
Returns BT-74-0 Date format.Usage: Only value "102"
Rule: Only value "102"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString/@format- Returns:
- the
BT-74-0value - Throws:
ComputationException- Since:
- 1.0.06/2.2
-
getDeliverToAddressLine1
Returns BT-75 Deliver to address line 1 — The main address line in an address.Usage: Usually the street name and number.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOneFR: Adresse de livraison - Ligne 1 — Ligne principale d'une adresse.
- Returns:
- the
BT-75value - Since:
- 1.0.06/2.2
-
getDeliverToAddressLine2
Returns BT-76 Deliver to address line 2 — An additional address line in an address that can be used to give further details supplementing the main line.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineTwoFR: Adresse de livraison - Ligne 2 — Ligne supplémentaire d'une adresse, qui peut être utilisée pour donner des précisions et compléter la ligne principale.
- Returns:
- the
BT-76value - Since:
- 1.0.06/2.2
-
getDeliverToCity
Returns BT-77 Deliver to city — The common name of the city, town or village, where the deliver to address is located.XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CityNameFR: Localité de livraison — Nom usuel de la commune, ville ou village, dans laquelle se trouve l'adresse de livraison.
- Returns:
- the
BT-77value - Since:
- 1.0.06/2.2
-
getDeliverToPostCode
Returns BT-78 Deliver to post code — The identifier for an addressable group of properties according to the relevant postal service.Usage: Such as a ZIP code or a post code.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCodeFR: Code postal de livraison — Identifiant d'un groupe adressable de propriétés, conforme au service postal concerné.
- Returns:
- the
BT-78value - Since:
- 1.0.06/2.2
-
getDeliverToCountrySubdivision
Returns BT-79 Deliver to country subdivision — The subdivision of a country.Usage: Such as a region, a county, a state, a province, etc.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountrySubDivisionNameFR: Subdivision du pays de livraison — Subdivision d'un pays.
- Returns:
- the
BT-79value - Since:
- 1.0.06/2.2
-
getDeliverToCountryCode
Returns BT-80 Deliver to country code — A code that identifies the country.Usage: The lists of valid countries are registered with the ISO 3166-1 Maintenance agency, "Codes for the representation of names of countries and their subdivisions".
Rule: BR-57: Each Deliver to address (BG-15) shall contain a Deliver to country code (BT-80).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountryIDFR: Code du pays de livraison — Code d'identification du pays.
- Returns:
- the
BT-80value - Since:
- 1.0.06/2.2
-
getRemittanceInformation
Returns BT-83 Remittance information — A textual value used to establish a link between the payment and the Invoice, issued by the Seller.Usage: Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. When specifying the textual value, which is commonly the invoice number of the invoice being paid, but may be another seller reference, the buyer should indicate this reference in his payment order when executing the payment. In a payment transaction this reference is transferred back to the Seller as Remittance Information.In order to allow for automatic processing of cross-border SEPA payments, only Latin characters should be used in this field, with a maximum of 140 characters. Referencesection 1.4 of the SEPA credit transfer and SEPA direct debit scheme implementation guides [13] and [14] for details of the allowed characters. Other rules may apply for SEPA payments within national borders.If remittance information is structured according to the ISO 11649:2009 standard [16] for Structured RF Creditor Reference, it shall be mapped to the Structured Remittance Information Creditor Reference field in SEPA payments messages.If remittance information is structured according to the EACT standard for automated reconciliation [17], it shall be mapped to the Unstructured Remittance Information field in SEPA payments messages.”If remittance information is to be mapped to the End To End Identification field or to the Structured Remittance Information Creditor Reference field in SEPA payments messages, then in addition to the Latin character set restriction, the content shall not start or end with a '/' and the content shall not contain '//'s. See reference [15].
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PaymentReferenceFR: Référence de paiement — Valeur textuelle utilisée pour établir un lien entre le paiement et la Facture, émise par le Vendeur.
- Returns:
- the
BT-83value - Since:
- 1.0.06/2.2
-
getMandateReferenceIdentifier
Returns BT-89 Mandate reference identifier — Unique identifier assigned by the Payee for referencing the direct debit mandate.Usage: Used in order to pre-notify the Buyer of a SEPA direct debit.
Conditions (CIUS): This is the RUM (Unique Mandate Reference) for SEPA direct debits
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DirectDebitMandateIDFR: Identifiant de référence de mandat — Identifiant unique attribué par le Bénéficiaire, utilisé comme référence pour le mandat de prélèvement automatique.
- Returns:
- the
BT-89value - Since:
- 1.09.2/2.5.2
-
getPaymentDueDate
Returns BT-9 Payment due date — The date when the payment is due.Usage: The payment due date reflects the due date of the net payment. For partial payments it states the first net due date. The corresponding description of more complex payment terms can be stated in BT-20 Payment terms.
Rule: BR-CO-25: In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DueDateDateTime/udt:DateTimeStringFR: Date d'échéance — Date à laquelle le paiement est dû.
- Returns:
- the
BT-9value - Since:
- 1.0.06/2.2
-
getFormat
Returns BT-9-0 Format.Usage: Only value "102"
Rule: Only value "102"
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradePaymentTerms/ram:DueDateDateTime/udt:DateTimeString/@formatFR: Date, format
- Returns:
- the
BT-9-0value - Throws:
ComputationException- Since:
- 1.0.06/2.2
-
getBankAssignedCreditorIdentifier
Returns BT-90 Bank assigned creditor identifier — Unique banking reference identifier of the Payee or Seller assigned by the Payee or Seller bank.Usage: Used in order to pre-notify the Buyer of a SEPA direct debit.
Conditions (CIUS): This is the ICS for SEPA direct debits
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:CreditorReferenceIDFR: Identifiant bancaire du créancier — Identifiant de référence bancaire unique du Bénéficiaire ou du Vendeur, attribué par la banque du Bénéficiaire ou du Vendeur.
- Returns:
- the
BT-90value - Since:
- 1.09.2/2.5.2
-
appendNewInvoiceNote
Creates, appends and returns a newInvoiceNote(BG-1 INVOICE NOTE).- Parameters:
invoiceNote- 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.
FR: Note de facture — Sujet de la note en texte suivant.
- Returns:
- the new
InvoiceNote - Since:
- 1.09.2/2.5.2
-
appendNewInvoiceNote
Deprecated. -
getInvoiceNotes
-
appendNewInvoiceLine
public InvoiceLine appendNewInvoiceLine(String invoiceLineIdentifier, String itemName, Codes.UnitOfMeasure invoicedQuantityUnitOfMeasureCode, Quantity invoicedQuantity, Codes.VATCategoryCode invoicedItemVATCategoryCode) Creates, appends and returns a newInvoiceLine(BG-25 INVOICE LINE).- Parameters:
invoiceLineIdentifier- BT-126 Invoice line identifier — A unique identifier for the individual line within the Invoice.Rule: BR-21: Each Invoice line (BG-25) shall have an Invoice line identifier (BT-126).
FR: Identifiant de ligne de facture — Identifiant unique d'une ligne au sein de la Facture.
itemName- BT-153 Item name — A name for an item.Rule: BR-25: Each Invoice line (BG-25) shall contain the Item name (BT- 153).
FR: Nom de l'article — Nom d'un article.
invoicedQuantityUnitOfMeasureCode- BT-130 Invoiced quantity unit of measure code — The unit of measure that applies to the invoiced quantity.Usage: The unit of measure shall be chosen from the lists in UN/ECE Recommendation N°. 20 “Codes for Units of Measure Used in International Trade” [7] and UN/ECE Recommendation N° 21 “Codes for Passengers, Types of Cargo, Packages and Packaging Materials (with Complementary Codes for Package Names)” [19] applying the method described in UN/ECE Rec N° 20 Intro 2.a). Note that in most cases it is not needed for Buyers and Sellers to implement these lists fully in their software. Sellers need only to support the units needed for their goods and services; Buyers only need to verify that the units used in the Invoice are equal to the units used in other documents (such as Contract, Catalogue, Order and Despatch advice).
Conditions (CIUS): In particular, the most common units of measurement are:LTR = litre (1 dm3)MTQ = cubic meterKGM = kilogramMTR = meterC62 = unitTNE = ton
Rule: BR-23: An Invoice line (BG-25) shall have an Invoiced quantity unit of measure code (BT-130).
FR: Unité de mesure de la quantité facturée — Unité de mesure applicable à la quantité facturée.
invoicedQuantity- BT-129 Invoiced quantity — The quantity of items (goods or services) that is charged in the Invoice line.Conditions (CIUS): CHORUS PRO: Invoiced quantity is supported on 10 digits maximum.
Rule: BR-22: Each Invoice line (BG-25) shall have an Invoiced quantity (BT-129).
FR: Quantité facturée — Quantité d'articles (biens ou services) prise en compte dans la ligne de Facture.
invoicedItemVATCategoryCode- BT-151 Invoiced item VAT category code — The VAT category code for the invoiced item.Usage: The following entries of UNTDID 5305 [6] are used (further clarification between brackets):- Standard rate (Liable for VAT in a standard way)- Zero rated goods (Liable for VAT with a percentage rate of zero)- Exempt from tax (VAT/IGIC/IPSI)- VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)- VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)- Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)- Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)- Canary Islands General Indirect Tax (Liable for IGIC tax)- Liable for IPSI (Ceuta/Melilla tax)
Conditions (CIUS): The VAT category codes are as follows:S = Standard VAT rateZ = Zero rated goodsE = VAT exemptAE = Reverse chargeK = Intra-Community supply (specific reverse charge)G = Exempt VAT for Export outside EUO = Outside VAT scopeL = Canary IslandsM = Ceuta and Mellila
Rule: BR-CO-4: Each Invoice line (BG-25) shall be categorized with an Invoiced item VAT category code (BT-151).
FR: Code de type de TVA de l'article facturé — Code de type de TVA applicable à l'article facturé.
- Returns:
- the new
InvoiceLine - Since:
- 1.09.2/2.5.2
-
getInvoiceLines
-
appendNewSellerIdentifierSchemeIdentifier
public SellerIdentifierSchemeIdentifier appendNewSellerIdentifierSchemeIdentifier(Codes.SchemeIdentifier sellerIdentifierIdentificationSchemeIdentifier, String sellerIdentifierSchemeIdentifier) Creates, appends and returns a newSellerIdentifierSchemeIdentifier(BT-29-0 Seller identifier (Global ID)).- Parameters:
sellerIdentifierIdentificationSchemeIdentifier- BT-29-1 Seller identifier identification scheme identifier — Scheme identifierUsage: The identification scheme identifier shall be chosen from the entries of the list published by the ISO 6523 maintenance agency.
Conditions (CIUS): In particular, the following codes can be used:0021 : SWIFT0060 : DUNS0088 : GLN0177 : ODETTE
FR: Identifiant du schéma — Identifiant du schéma de l'identifiant du vendeur.
sellerIdentifierSchemeIdentifier- BT-29-0 Seller identifier (Global ID) — An identification of the Seller.Usage: GloablID, if global identifier exists and can be stated in @schemeID, ID else
Conditions (CIUS): If the seller has a GlobalID, he can qualify it with this attribute. Otherwise, he uses the ID.
Rule: GloablID, if global identifier exists and can be stated in @schemeID, ID else
FR: Identifiant du vendeur (Global ID) — Identifiant du schéma de l'identifiant global
- Returns:
- the new
SellerIdentifierSchemeIdentifier - Since:
- 1.09.2/2.5.2
-
appendNewSellerIdentifierSchemeIdentifier
Deprecated. -
getSellerIdentifierSchemeIdentifiers
-
appendNewSellerVATIdentifier
-
getSellerVATIdentifiers
-
appendNewSellerTaxRegistrationIdentifier
-
getSellerTaxRegistrationIdentifiers
-
appendNewBuyerIdentifierSchemeIdentifier
public BuyerIdentifierSchemeIdentifier appendNewBuyerIdentifierSchemeIdentifier(Codes.SchemeIdentifier buyerIdentifierIdentificationSchemeIdentifier, String buyerIdentifierSchemeIdentifier) Creates, appends and returns a newBuyerIdentifierSchemeIdentifier(BT-46-0 Buyer identifier).- Parameters:
buyerIdentifierIdentificationSchemeIdentifier- BT-46-1 scheme identifier attribute (if GlobalID) — The identification scheme identifier of the Buyer identifier.Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.
FR: Attribut de l'Identifiant du schéma (si GlobalID) — Identifiant du schéma de l'identifiant de l'acheteur
buyerIdentifierSchemeIdentifier- BT-46-0 Buyer identifierUsage: GloablID, if global identifier exists and can be stated in @schemeID, ID else
Rule: GloablID, if global identifier exists and can be stated in @schemeID, ID else
FR: Identifiant de l'acheteurIdentifiant du schéma (GlobalID)
- Returns:
- the new
BuyerIdentifierSchemeIdentifier - Since:
- 1.09.2/2.5.2
-
appendNewBuyerIdentifierSchemeIdentifier
Deprecated. -
getBuyerIdentifierSchemeIdentifiers
-
appendNewBuyerVATIdentifier
Creates, appends and returns a newBuyerVATIdentifier(BT-48-00 (BUYER VAT IDENTIFIER)).- Parameters:
buyerVATIdentifier- BT-48 Buyer VAT identifier — The Buyer's VAT identifier (also known as Buyer VAT identification number).Usage: VAT number prefixed by a country code based on EN ISO 3166-1 "Codes for the representation of names of countries and their subdivisions"
Conditions (CIUS): CHORUSPRO: If entered, ChorusPro will not integrate the VAT ID of the buyer because it is the SIRET number that is used to identify a buyer for public entities (BT-47)
Rule: BR-CO-9: The Seller VAT identifier (BT-31), the Seller tax representative VAT identifier (BT-63) and the Buyer VAT identifier (BT-48) shall have a prefix in accordance with ISO code ISO 3166-1 alpha-2 by which the country of issue may be identified. Nevertheless, Greece may use the prefix ‘EL’.
FR: Identifiant à la TVA de l'acheteur — Identifiant à la TVA de l'Acheteur (également appelé Numéro d'identification à la TVA de l'acheteur).
- Returns:
- the new
BuyerVATIdentifier - Since:
- 1.09.2/2.5.2
-
appendNewBuyerVATIdentifier
Deprecated. -
getBuyerVATIdentifiers
-
appendNewSellerTaxRepresentativeVATIdentifier
public SellerTaxRepresentativeVATIdentifier appendNewSellerTaxRepresentativeVATIdentifier(String sellerTaxRepresentativeVATIdentifier) Creates, appends and returns a newSellerTaxRepresentativeVATIdentifier(BT-63-00 (SELLER TAX REPRESENTATIVE VAT IDENTIFIER)).- Parameters:
sellerTaxRepresentativeVATIdentifier- BT-63 Seller tax representative VAT identifier — The VAT identifier of the Seller's tax representative party.Usage: VAT number prefixed by a country code based on EN ISO 3166-1 "Codes for the representation of names of countries and their subdivisions".
Rule: BR-56: Each Seller tax representative party (BG-11) shall have a Seller tax representative VAT identifier (BT-63).BR-CO-9: The Seller VAT identifier (BT-31), the Seller tax representative VAT identifier (BT-63) and the Buyer VAT identifier (BT-48) shall have a prefix in accordance with ISO code ISO 3166-1 alpha-2 by which the country of issue may be identified. Nevertheless, Greece may use the prefix ‘EL’.
FR: Identifiant à la TVA du représentant fiscal du vendeur — Identifiant à la TVA de la partie représentant fiscalement le Vendeur.
- Returns:
- the new
SellerTaxRepresentativeVATIdentifier - Since:
- 1.09.2/2.5.2
-
appendNewSellerTaxRepresentativeVATIdentifier
@Deprecated public SellerTaxRepresentativeVATIdentifier appendNewSellerTaxRepresentativeVATIdentifier()Deprecated. -
getSellerTaxRepresentativeVATIdentifiers
-
appendNewSalesOrderReference
Creates, appends and returns a newSalesOrderReference(BT-14-00 (SALES ORDER REFERENCE)).- Parameters:
salesOrderReference- BT-14 Sales order reference — An identifier of a referenced sales order, issued by the Seller.FR: Identifiant d'un bon de commande de vente — Identifiant d'un bon de commande référencé, généré par le Vendeur.
- Returns:
- the new
SalesOrderReference - Since:
- 1.09.2/2.5.2
-
appendNewSalesOrderReference
Deprecated. -
getSalesOrderReferences
-
appendNewPurchaseOrderReference
Creates, appends and returns a newPurchaseOrderReference(BT-13-00 (PURCHASE ORDER REFERENCE)).- Parameters:
purchaseOrderReference- BT-13 Purchase order reference — An identifier of a referenced purchase order, issued by the Buyer.Conditions (CIUS): CHORUS PRO: for the public sector, this is the "Engagement Juridique" (Legal Commitment). It is mandatory for some buyers. You should refer to the ChorusPro Directory to identify these public entity buyers that make it mandatory.
FR: Identifiant de bon de commande — Identifiant d'un bon de commande référencé, généré par l'Acheteur.
- Returns:
- the new
PurchaseOrderReference - Since:
- 1.09.2/2.5.2
-
appendNewPurchaseOrderReference
Deprecated. -
getPurchaseOrderReferences
-
appendNewContractReference
Creates, appends and returns a newContractReference(BT-12-00 (CONTRACT REFERENCE)).- Parameters:
contractReference- BT-12 Contract reference — The identification of a contract.Usage: The contract identifier should be unique in the context of the specific trading relationship and for a defined time period.
Conditions (CIUS): CHORUSPRO : This is the "numéro de Marché" (contract number)
FR: Identifiant de contrat — Identifiant d'un contrat.
- Returns:
- the new
ContractReference - Since:
- 1.09.2/2.5.2
-
appendNewContractReference
Deprecated. -
getContractReferences
-
appendNewAdditionalSupportingDocuments
@Deprecated public AdditionalSupportingDocuments appendNewAdditionalSupportingDocuments(String supportingDocumentReference, Codes.SupportingDocumentTypeCode typeCode) Deprecated.legacy merged factory -- theram:TypeCoderole discriminator is a caller argument. Use the per-role factories that fix it internally:appendNewAdditionalSupportingDocument()(916),appendNewTenderOrLotReference()(50),appendNewInvoicedObjectIdentifier()(130).Creates, appends and returns a newAdditionalSupportingDocuments(BG-24 ADDITIONAL SUPPORTING DOCUMENTS).- Parameters:
supportingDocumentReference- 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).
FR: Identifiant de document justificatif — Identifiant du document justificatif.
typeCode- BT-122-0Usage: 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
- Returns:
- the new
AdditionalSupportingDocuments - Since:
- 1.09.2/2.5.2
-
appendNewAdditionalSupportingDocuments
Deprecated. -
getAdditionalSupportingDocuments
-
appendNewAdditionalSupportingDocument
public AdditionalSupportingDocuments appendNewAdditionalSupportingDocument(String supportingDocumentReference) -
appendNewTenderOrLotReference
-
getTenderOrLotReferences
-
appendNewInvoicedObjectIdentifier
-
getInvoicedObjectIdentifiers
-
appendNewDeliverToIdentifierSchemeIdentifier
public DeliverToIdentifierSchemeIdentifier appendNewDeliverToIdentifierSchemeIdentifier(Codes.SchemeIdentifier deliverToIdentifierIdentificationSchemeIdentifier, String deliverToIdentifierSchemeIdentifier) Creates, appends and returns a newDeliverToIdentifierSchemeIdentifier(BT-71-0 Deliver to location identifier Scheme identifier (GlobalID)).- Parameters:
deliverToIdentifierIdentificationSchemeIdentifier- BT-71-1 Scheme identifier (for GlobalID) — The identification scheme identifier of the Deliver to location identifier.Usage: "To be chosen from UNTDID 3035, for instance:DL: FactorDS: DistributorMOP: Market operator"1
FR: Identifiant du schéma — Identifiant du schéma de l'identifiant de l'établissement de livraison
deliverToIdentifierSchemeIdentifier- BT-71-0 Deliver to location identifier Scheme identifier (GlobalID)Usage: GloablID, if global identifier exists and can be stated in @schemeID, ID else
Rule: GloablID, if global identifier exists and can be stated in @schemeID, ID else
- Returns:
- the new
DeliverToIdentifierSchemeIdentifier - Since:
- 1.09.2/2.5.2
-
appendNewDeliverToIdentifierSchemeIdentifier
@Deprecated public DeliverToIdentifierSchemeIdentifier appendNewDeliverToIdentifierSchemeIdentifier()Deprecated. -
getDeliverToIdentifierSchemeIdentifiers
-
appendNewDespatchAdviceReference
Creates, appends and returns a newDespatchAdviceReference(BT-16-00 (DESPATCH ADVICE REFERENCE)).- Parameters:
despatchAdviceReference- BT-16 Despatch advice reference — An identifier of a referenced despatch advice.Conditions (CIUS): CHORUS PRO : not used
FR: Identifiant d'avis d'expédition — Identifiant d'un avis d'expédition référencé.
- Returns:
- the new
DespatchAdviceReference - Since:
- 1.09.2/2.5.2
-
appendNewDespatchAdviceReference
Deprecated. -
getDespatchAdviceReferences
-
appendNewReceivingAdviceReference
Creates, appends and returns a newReceivingAdviceReference(BT-15-00 (RECEIVING ADVICE REFERENCE)).- Parameters:
receivingAdviceReference- BT-15 Receiving advice reference — An identifier of a referenced receiving advice.FR: Identifiant d'avis de réception — Identifiant d'un avis de réception référencé.
- Returns:
- the new
ReceivingAdviceReference - Since:
- 1.09.2/2.5.2
-
appendNewReceivingAdviceReference
Deprecated. -
getReceivingAdviceReferences
-
appendNewPayeeIdentifierSchemeIdentifier
public PayeeIdentifierSchemeIdentifier appendNewPayeeIdentifierSchemeIdentifier(Codes.SchemeIdentifier payeeIdentifierIdentificationSchemeIdentifier, String payeeIdentifierSchemeIdentifier) Creates, appends and returns a newPayeeIdentifierSchemeIdentifier(BT-60-0 Payee scheme identifier).- Parameters:
payeeIdentifierIdentificationSchemeIdentifier- BT-60-1 Scheme identifier — The identification scheme identifier of the Payee identifier.Usage: If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.
FR: Identifiant du schéma — Identifiant du schéma de l'identifiant du bénéficiaire
payeeIdentifierSchemeIdentifier- BT-60-0 Payee scheme identifierUsage: GloablID, if global identifier exists and can be stated in @schemeID, ID else
Rule: GloablID, if global identifier exists and can be stated in @schemeID, ID else
FR: Identifiant du bénéficiaire
- Returns:
- the new
PayeeIdentifierSchemeIdentifier - Since:
- 1.09.2/2.5.2
-
appendNewPayeeIdentifierSchemeIdentifier
Deprecated. -
getPayeeIdentifierSchemeIdentifiers
-
appendNewPaymentInstructions
public PaymentInstructions appendNewPaymentInstructions(Codes.PaymentMeansCode paymentMeansTypeCode) Creates, appends and returns a newPaymentInstructions(BG-16 PAYMENT INSTRUCTIONS).- Parameters:
paymentMeansTypeCode- BT-81 Payment means type code — The means, expressed as code, for how a payment is expected to be or has been settled.Usage: Entries from the UNTDID 4461 code list [6] shall be used. Distinction should be madebetween SEPA and non-SEPA payments, and between credit payments, direct debits, card payments and other instruments.
Conditions (CIUS): In particular, the following codes can be used:10: Species20: Check30: Transfer (includes SEPA transfer for CHORUSPRO)42: Payment on bank account48: Payment by credit card49: Direct debit (includes SEPA Direct Debit for CHORUSPRO)57 : Standing Agreement58: SEPA transfer (not used for CHORUSPRO: code 30)59: SEPA Direct Debit (not used for CHORUSPRO: code 49)97: ReportZZZ: agreed amoung trading partners on interim basis
Rule: BR-49: A Payment instruction (BG-16) shall specify the Payment means type code (BT-81).
FR: Code de type de moyen de paiement — Code indiquant le mode selon lequel un paiement doit être ou a été effectué.
- Returns:
- the new
PaymentInstructions - Since:
- 1.09.2/2.5.2
-
getPaymentInstructions
-
appendNewVATBreakdown
Creates, appends and returns a newVATBreakdown(BG-23 VAT BREAKDOWN).- Parameters:
vATCategoryCode- BT-118 VAT category code — Coded identification of a VAT category.Usage: The following entries of UNTDID 5305 [6] are used (further clarification between brackets):- Standard rate (Liable for VAT in a standard way)- Zero rated goods (Liable for VAT with a percentage rate of zero)- Exempt from tax (VAT/IGIC/IPSI)- VAT Reverse Charge (Reverse charge VAT/IGIC/IPSI rules apply)- VAT exempt for intra community supply of goods (VAT/IGIC/IPSI not levied due to Intra-community supply rules)- Free export item, tax not charged (VAT/IGIC/IPSI not levied due to export outside of the EU)- Services outside scope of tax (Sale is not subject to VAT/IGIC/IPSI)- Canary Islands General Indirect Tax (Liable for IGIC tax)- Liable for IPSI (Ceuta/Melilla tax)
Conditions (CIUS): The VAT category codes are as follows:S = Standard VAT rateZ = Zero rated goodsE = VAT exemptAE = Reverse chargeK = Intra-Community supply (specific reverse charge)G = Exempt VAT for Export outside EUO = Outside VAT scopeL = Canary IslandsM = Ceuta and Mellila
Rule: BR-47: Each VAT breakdown (BG-23) shall be defined through a VAT category code (BT-118).For EXTENDED profile only, BR-O-11, BR-O-12, BR-O-13 and BR-O-14 are not applied.
FR: Code de type de TVA — Identification codée d’un type de TVA.
- Returns:
- the new
VATBreakdown - Since:
- 1.0.06/2.2
-
getVATBreakdowns
-
appendNewDocumentLevelAllowance
-
getDocumentLevelAllowances
-
appendNewDocumentLevelCharge
-
getDocumentLevelCharges
-
appendNewInvoiceTotalVATAmount
Creates, appends and returns a newInvoiceTotalVATAmount(BT-110 Invoice total VAT amount).- Returns:
- the new
InvoiceTotalVATAmount - Since:
- 1.0.06/2.2
-
getInvoiceTotalVATAmounts
-
setNewInvoiceTotalVATAmountInInvoiceCurrency
-
getInvoiceTotalVATAmountInInvoiceCurrency
-
setNewInvoiceTotalVATAmountInAccountingCurrency
-
getInvoiceTotalVATAmountInAccountingCurrency
-
appendNewPrecedingInvoiceReference
public PrecedingInvoiceReference appendNewPrecedingInvoiceReference(String precedingInvoiceReference) Creates, appends and returns a newPrecedingInvoiceReference(BG-3 PRECEDING INVOICE REFERENCE).- Parameters:
precedingInvoiceReference- BT-25 Preceding Invoice reference — The identification of an Invoice that was previously sent by the Seller.Rule: BR-55: Each Preceding Invoice reference (BG-3) shall contain a Preceding Invoice reference (BT-25).
FR: Numéro de facture antérieure — Numéro de facture antérieure Identification d'une Facture précédemment envoyée par le Vendeur.
- Returns:
- the new
PrecedingInvoiceReference - Since:
- 1.09.2/2.5.2
-
appendNewPrecedingInvoiceReference
Deprecated. -
getPrecedingInvoiceReferences
-
addSellerIdentifier
-
getSellerIdentifiers
-
toXML
Description copied from class:AbstractInvoiceSerializes to a Factur-X XML document that matches the profile specific XML Schema.- Specified by:
toXMLin classAbstractInvoice- Parameters:
out- the print stream to write to- Throws:
IOExceptionFacturXException
-
getProfile
- Specified by:
getProfilein classAbstractInvoice
-
initForUnitTest
public void initForUnitTest() -
toJUnitJavaSourceCode
public void toJUnitJavaSourceCode(PrintStream out, String packageName, String className, String referenceFilesDirectory) throws FacturXException Description copied from class:AbstractInvoiceCreates JUnit Java source code that will construct an Invoice instance identical with this Invoice from API calls and compare the produced XML against a reference file.- Specified by:
toJUnitJavaSourceCodein classAbstractInvoice- Parameters:
out- the print stream to write topackageName- the package name to use in the package declarationclassName- the name to use as class name for the test classreferenceFilesDirectory- the directory in which the test expects the reference output xml file that is namedclassName+".xml"- Throws:
FacturXException
-
getSumOfInvoiceLineNetAmount
Returns BT-106 Sum of Invoice line net amount — Sum of all Invoice line net amounts in the Invoice.Rule: BR-12: An Invoice shall have the Sum of Invoice line net amount (BT-106).BR-CO-10: Sum of Invoice line net amount (BT-106) = ∑ Invoice line net amount (BT-131).For EXTENDED profile only, BR-CO-10 is replaced by BR-FXEXT-CO-10, which add a tolerance of 0,01 euro per line, document level charge and allowance in calculation.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:LineTotalAmountFR: Somme du montant net des lignes de facture — Somme du montant net de toutes les lignes de la Facture.
- Returns:
- the
BT-106value - Throws:
ComputationException- Since:
- 1.0.06/2.2
- API Note:
- This value is normally computed by the API. A value assigned through the corresponding setter is
returned here only if
Invoice.setRecompute(false)has been called and is in effect at the moment this getter is invoked; otherwise this getter returns the freshly computed value, which is also whattoXML()writes.
-
getSumOfAllowancesOnDocumentLevel
Returns BT-107 Sum of allowances on document level — Sum of all allowances on document level in the Invoice.Usage: Allowances on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.
Rule: BR-CO-11: Sum of allowances on document level (BT-107) = ∑ Document level allowance amount (BT-92).For EXTENDED profile only, BR-CO-11 is replaced by BR-FXEXT-CO-11, which add a tolerance of 0,01 euro per line, document level charge and allowance in calculation.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:AllowanceTotalAmountFR: Somme des remises au niveau du document — Somme de toutes les remises au niveau du document de la Facture.
- Returns:
- the
BT-107value - Throws:
ComputationException- Since:
- 1.0.06/2.2
- API Note:
- This value is normally computed by the API. A value assigned through the corresponding setter is
returned here only if
Invoice.setRecompute(false)has been called and is in effect at the moment this getter is invoked; otherwise this getter returns the freshly computed value, which is also whattoXML()writes.
-
getSumOfChargesOnDocumentLevel
Returns BT-108 Sum of charges on document level — Sum of all charges on document level in the Invoice.Usage: Charges on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.
Rule: BR-CO-12: Sum of charges on document level (BT-108) = ∑ Document level charge amount (BT-99).For EXTENDED profile only, BR-CO-12 is replaced by BR-FXEXT-CO-12, which add a tolerance of 0,01 euro per line, document level charge and allowance in calculation.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:ChargeTotalAmountFR: Somme des charges ou frais au niveau du document — Somme de toutes les charges ou frais au niveau du document de la Facture.
- Returns:
- the
BT-108value - Throws:
ComputationException- Since:
- 1.0.06/2.2
- API Note:
- This value is normally computed by the API. A value assigned through the corresponding setter is
returned here only if
Invoice.setRecompute(false)has been called and is in effect at the moment this getter is invoked; otherwise this getter returns the freshly computed value, which is also whattoXML()writes.
-
getInvoiceTotalAmountWithoutVAT
Returns BT-109 Invoice total amount without VAT — The total amount of the Invoice without VAT.Usage: The Invoice total amount without VAT is the Sum of Invoice line net amount minus Sum of allowances on document level plus Sum of charges on document level.
Rule: BR-13: An Invoice shall have the Invoice total amount without VAT (BT-109).BR-CO-13: Invoice total amount without VAT (BT-109) = ∑ Invoice line net amount (BT-131) - Sum of allowances on document level (BT-107) + Sum of charges on document level (BT-108).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TaxBasisTotalAmountFR: Montant total de la facture hors TVA — Montant total de la Facture, sans la TVA.
- Returns:
- the
BT-109value - Throws:
ComputationException- Since:
- 1.0.06/2.2
- API Note:
- This value is normally computed by the API. A value assigned through the corresponding setter is
returned here only if
Invoice.setRecompute(false)has been called and is in effect at the moment this getter is invoked; otherwise this getter returns the freshly computed value, which is also whattoXML()writes.
-
getInvoiceTotalAmountWithVAT
Returns BT-112 Invoice total amount with VAT — The total amount of the Invoice with VAT.Usage: The Invoice total amount with VAT is the Invoice total amount without VAT plus the Invoice total VAT amount.
Rule: BR-14: An Invoice shall have the Invoice total amount with VAT (BT-112).BR-CO-15: Invoice total amount with VAT (BT-112) = Invoice total amount without VAT (BT-109) + Invoice total VAT amount (BT-110).For EXTENDED profile only, BR-CO-15 is replaced by BR-FXEXT-CO-15, which add a tolerance of 0,01 euro per line, document level charge and allowance in calculation.
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:GrandTotalAmountFR: Montant total de la facture avec TVA comprise — Montant total de la Facture, avec la TVA.
- Returns:
- the
BT-112value - Throws:
ComputationException- Since:
- 1.0.06/2.2
- API Note:
- This value is normally computed by the API. A value assigned through the corresponding setter is
returned here only if
Invoice.setRecompute(false)has been called and is in effect at the moment this getter is invoked; otherwise this getter returns the freshly computed value, which is also whattoXML()writes.
-
getAmountDueForPayment
Returns BT-115 Amount due for payment — The outstanding amount that is requested to be paid.Usage: This amount is the Invoice total amount with VAT minus the paid amount that has been paid in advance. The amount is zero in case of a fully paid Invoice. The amount may be negative; in that case the Seller owes the amount to the Buyer.
Rule: BR-15: An Invoice shall have the Amount due for payment (BT- 115).BR-CO-16: Amount due for payment (BT-115) = Invoice total amount with VAT (BT-112) -Paid amount (BT-113) + Rounding amount (BT-114).
XPath:
/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:DuePayableAmountFR: Montant à payer — Encours dont le paiement est demandé.
- Returns:
- the
BT-115value - Throws:
ComputationException- Since:
- 1.0.06/2.2
- API Note:
- This value is normally computed by the API. A value assigned through the corresponding setter is
returned here only if
Invoice.setRecompute(false)has been called and is in effect at the moment this getter is invoked; otherwise this getter returns the freshly computed value, which is also whattoXML()writes.
-
Invoice(String, Codes.InvoiceTypeCode, LocalDate, String, Codes.CountryCodeList, String, Codes.CountryCodeList, Codes.Currency).