Class Invoice


  • public class Invoice
    extends Object
    BG-0:Invoice

    Cross Industry Invoice

    XPath:/rsm:CrossIndustryInvoice

    • Constructor Detail

      • Invoice

        public Invoice​(Identifier invoiceNumber,
                       Codes.InvoiceTypeCode invoiceTypeCode,
                       LocalDate invoiceIssueDate,
                       Codes.Currency invoiceCurrencyCode)
        Creates an Invoice object
        Parameters:
        invoiceNumber - BT-1:Invoice number

        A 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 code

        A 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 date

        The 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 code

        The 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).

    • Method Detail

      • setRecompute

        public void setRecompute​(boolean value)
        Controls the computation of computed fields like InvoiceTotalAmountWithoutVAT.getInvoiceTotalAmountWithoutVAT() By default the values are always computed but in the case that the values were explicitly set (e.g. after creating and instance via fromXML(String,boolean)), it might be desirable to obtain the explicitly set values instead.
        Parameters:
        value - whether or not to ignore explicitly set values of computed fields and work with computed values instead
      • initForUnitTest

        public void initForUnitTest()
        Initializes in a way so that lists that have mandatory entries like VATBreakdowns are empty and need to be explicitly filled.
      • appendNewLanguageIdentifier

        public LanguageIdentifier appendNewLanguageIdentifier()
        Creates a LanguageIdentifier object and appends it to the list obtainable by a call to get getLanguageIdentifiers()
        Returns:
        LanguageIdentifier
      • appendNewInvoiceNote

        public InvoiceNote appendNewInvoiceNote()
        Creates an InvoiceNote object and appends it to the list obtainable by a call to get getInvoiceNotes()
        Returns:
        InvoiceNote
      • appendNewInvoiceLine

        public InvoiceLine appendNewInvoiceLine​(Identifier invoiceLineIdentifier,
                                                String itemName,
                                                Codes.UnitOfMeasure invoicedQuantityUnitOfMeasureCode,
                                                Quantity invoicedQuantity)
        Creates an InvoiceLine object and appends it to the list obtainable by a call to get getInvoiceLines()
        Parameters:
        invoiceLineIdentifier - BT-126:Invoice line identifier

        A unique identifier for the individual line within the Invoice.

        BR-21: Each Invoice line (BG-25) shall have an Invoice line identifier (BT-126).

        itemName - BT-153:Item name

        A name for an item.

        BR-25: Each Invoice line (BG-25) shall contain the Item name (BT- 153).

        invoicedQuantityUnitOfMeasureCode - BT-130:Invoiced quantity unit of measure code

        The unit of measure that applies to the invoiced quantity.

        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).

        In particular, the most common units of measurement are:LTR = Liter (1 dm3)MTQ = cubic meterKGM = KilogramMTR = MeterC62 = UnitTNE = Tonne

        BR-23: An Invoice line (BG-25) shall have an Invoiced quantity unit of measure code (BT-130).

        invoicedQuantity - BT-129:Invoiced quantity

        The quantity of items (goods or services) that is charged in the Invoice line.

        CHORUS PRO: Invoiced quantity is fulfilled on 10 digits maximum.

        BR-22: Each Invoice line (BG-25) shall have an Invoiced quantity (BT-129).

        Returns:
        InvoiceLine
      • appendNewSellerIdentifier

        public SellerIdentifier appendNewSellerIdentifier()
        Creates a SellerIdentifier object and appends it to the list obtainable by a call to get getSellerIdentifiers()
        Returns:
        SellerIdentifier
      • appendNewSeller

        public Seller appendNewSeller()
        Creates a Seller object and appends it to the list obtainable by a call to get getSellers()
        Returns:
        Seller
      • appendNewSellerVATIdentifier

        public SellerVATIdentifier appendNewSellerVATIdentifier()
        Creates a SellerVATIdentifier object and appends it to the list obtainable by a call to get getSellerVATIdentifiers()
        Returns:
        SellerVATIdentifier
      • appendNewBuyerIdentifier

        public BuyerIdentifier appendNewBuyerIdentifier()
        Creates a BuyerIdentifier object and appends it to the list obtainable by a call to get getBuyerIdentifiers()
        Returns:
        BuyerIdentifier
      • appendNewBuyer

        public Buyer appendNewBuyer()
        Creates a Buyer object and appends it to the list obtainable by a call to get getBuyers()
        Returns:
        Buyer
      • appendNewBuyerCountrySubdivision

        public BuyerCountrySubdivision appendNewBuyerCountrySubdivision()
        Creates a BuyerCountrySubdivision object and appends it to the list obtainable by a call to get getBuyerCountrySubdivisions()
        Returns:
        BuyerCountrySubdivision
      • appendNewBuyerVATIdentifier

        public BuyerVATIdentifier appendNewBuyerVATIdentifier()
        Creates a BuyerVATIdentifier object and appends it to the list obtainable by a call to get getBuyerVATIdentifiers()
        Returns:
        BuyerVATIdentifier
      • appendNewSalesAgentIdentifier

        public SalesAgentIdentifier appendNewSalesAgentIdentifier()
        Creates a SalesAgentIdentifier object and appends it to the list obtainable by a call to get getSalesAgentIdentifiers()
        Returns:
        SalesAgentIdentifier
      • appendNewSalesAgent

        public SalesAgent appendNewSalesAgent()
        Creates a SalesAgent object and appends it to the list obtainable by a call to get getSalesAgents()
        Returns:
        SalesAgent
      • appendNewSalesAgentVATIdentifier

        public SalesAgentVATIdentifier appendNewSalesAgentVATIdentifier()
        Creates a SalesAgentVATIdentifier object and appends it to the list obtainable by a call to get getSalesAgentVATIdentifiers()
        Returns:
        SalesAgentVATIdentifier
      • appendNewBuyerTaxRepresentative

        public BuyerTaxRepresentative appendNewBuyerTaxRepresentative()
        Creates a BuyerTaxRepresentative object and appends it to the list obtainable by a call to get getBuyerTaxRepresentatives()
        Returns:
        BuyerTaxRepresentative
      • appendNewSellerTaxRepresentative

        public SellerTaxRepresentative appendNewSellerTaxRepresentative()
        Creates a SellerTaxRepresentative object and appends it to the list obtainable by a call to get getSellerTaxRepresentatives()
        Returns:
        SellerTaxRepresentative
      • appendNewProductEndUser

        public ProductEndUser appendNewProductEndUser()
        Creates a ProductEndUser object and appends it to the list obtainable by a call to get getProductEndUsers()
        Returns:
        ProductEndUser
      • appendNewSalesOrderReference

        public SalesOrderReference appendNewSalesOrderReference()
        Creates a SalesOrderReference object and appends it to the list obtainable by a call to get getSalesOrderReferences()
        Returns:
        SalesOrderReference
      • appendNewPurchaseOrderReference

        public PurchaseOrderReference appendNewPurchaseOrderReference()
        Creates a PurchaseOrderReference object and appends it to the list obtainable by a call to get getPurchaseOrderReferences()
        Returns:
        PurchaseOrderReference
      • appendNewContractReference

        public ContractReference appendNewContractReference()
        Creates a ContractReference object and appends it to the list obtainable by a call to get getContractReferences()
        Returns:
        ContractReference
      • appendNewBuyerAgentIdentifier

        public BuyerAgentIdentifier appendNewBuyerAgentIdentifier()
        Creates a BuyerAgentIdentifier object and appends it to the list obtainable by a call to get getBuyerAgentIdentifiers()
        Returns:
        BuyerAgentIdentifier
      • appendNewBuyerAgent

        public BuyerAgent appendNewBuyerAgent()
        Creates a BuyerAgent object and appends it to the list obtainable by a call to get getBuyerAgents()
        Returns:
        BuyerAgent
      • appendNewBuyerAgentVATIdentifier

        public BuyerAgentVATIdentifier appendNewBuyerAgentVATIdentifier()
        Creates a BuyerAgentVATIdentifier object and appends it to the list obtainable by a call to get getBuyerAgentVATIdentifiers()
        Returns:
        BuyerAgentVATIdentifier
      • appendNewDeliverToIdentifier

        public DeliverToIdentifier appendNewDeliverToIdentifier()
        Creates a DeliverToIdentifier object and appends it to the list obtainable by a call to get getDeliverToIdentifiers()
        Returns:
        DeliverToIdentifier
      • appendNewDeliverTo

        public DeliverTo appendNewDeliverTo()
        Creates a DeliverTo object and appends it to the list obtainable by a call to get getDeliverTos()
        Returns:
        DeliverTo
      • appendNewUltimateShipTo

        public UltimateShipTo appendNewUltimateShipTo()
        Creates an UltimateShipTo object and appends it to the list obtainable by a call to get getUltimateShipTos()
        Returns:
        UltimateShipTo
      • appendNewShipFromIdentifier

        public ShipFromIdentifier appendNewShipFromIdentifier()
        Creates a ShipFromIdentifier object and appends it to the list obtainable by a call to get getShipFromIdentifiers()
        Returns:
        ShipFromIdentifier
      • appendNewShipFrom

        public ShipFrom appendNewShipFrom()
        Creates a ShipFrom object and appends it to the list obtainable by a call to get getShipFroms()
        Returns:
        ShipFrom
      • appendNewDespatchAdviceReference

        public DespatchAdviceReference appendNewDespatchAdviceReference()
        Creates a DespatchAdviceReference object and appends it to the list obtainable by a call to get getDespatchAdviceReferences()
        Returns:
        DespatchAdviceReference
      • appendNewInvoicerIdentifier

        public InvoicerIdentifier appendNewInvoicerIdentifier()
        Creates an InvoicerIdentifier object and appends it to the list obtainable by a call to get getInvoicerIdentifiers()
        Returns:
        InvoicerIdentifier
      • appendNewInvoicer

        public Invoicer appendNewInvoicer()
        Creates an Invoicer object and appends it to the list obtainable by a call to get getInvoicers()
        Returns:
        Invoicer
      • appendNewInvoicerTradeVATID

        public InvoicerTradeVATID appendNewInvoicerTradeVATID()
        Creates an InvoicerTradeVATID object and appends it to the list obtainable by a call to get getInvoicerTradeVATIDs()
        Returns:
        InvoicerTradeVATID
      • appendNewInvoiceeIdentifier

        public InvoiceeIdentifier appendNewInvoiceeIdentifier()
        Creates an InvoiceeIdentifier object and appends it to the list obtainable by a call to get getInvoiceeIdentifiers()
        Returns:
        InvoiceeIdentifier
      • appendNewInvoicee

        public Invoicee appendNewInvoicee()
        Creates an Invoicee object and appends it to the list obtainable by a call to get getInvoicees()
        Returns:
        Invoicee
      • appendNewInvoiceeTradeVATID

        public InvoiceeTradeVATID appendNewInvoiceeTradeVATID()
        Creates an InvoiceeTradeVATID object and appends it to the list obtainable by a call to get getInvoiceeTradeVATIDs()
        Returns:
        InvoiceeTradeVATID
      • appendNewPayeeIdentifier

        public PayeeIdentifier appendNewPayeeIdentifier()
        Creates a PayeeIdentifier object and appends it to the list obtainable by a call to get getPayeeIdentifiers()
        Returns:
        PayeeIdentifier
      • appendNewPayee

        public Payee appendNewPayee()
        Creates a Payee object and appends it to the list obtainable by a call to get getPayees()
        Returns:
        Payee
      • appendNewPayeeCountrySubdivision

        public PayeeCountrySubdivision appendNewPayeeCountrySubdivision()
        Creates a PayeeCountrySubdivision object and appends it to the list obtainable by a call to get getPayeeCountrySubdivisions()
        Returns:
        PayeeCountrySubdivision
      • appendNewPayerIdentifier

        public PayerIdentifier appendNewPayerIdentifier()
        Creates a PayerIdentifier object and appends it to the list obtainable by a call to get getPayerIdentifiers()
        Returns:
        PayerIdentifier
      • appendNewPayer

        public Payer appendNewPayer()
        Creates a Payer object and appends it to the list obtainable by a call to get getPayers()
        Returns:
        Payer
      • appendNewPayerCountrySubdivision

        public PayerCountrySubdivision appendNewPayerCountrySubdivision()
        Creates a PayerCountrySubdivision object and appends it to the list obtainable by a call to get getPayerCountrySubdivisions()
        Returns:
        PayerCountrySubdivision
      • appendNewPaymentInstructions

        public PaymentInstructions appendNewPaymentInstructions()
        Creates a PaymentInstructions object and appends it to the list obtainable by a call to get getPaymentInstructions()
        Returns:
        PaymentInstructions
      • appendNewVATBreakdown

        public VATBreakdown appendNewVATBreakdown​(Codes.VATCategoryCode vATCategoryCode)
        Creates a VATBreakdown object and appends it to the list obtainable by a call to get getVATBreakdowns()
        Parameters:
        vATCategoryCode - BT-118:VAT category code

        Coded identification of a VAT category.

        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)

        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

        BR-47: Each VAT breakdown (BG-23) shall be defined through a VAT category code (BT-118).

        Returns:
        VATBreakdown
      • appendNewDocumentLevelAllowances

        public DocumentLevelAllowances appendNewDocumentLevelAllowances()
        Creates a DocumentLevelAllowances object and appends it to the list obtainable by a call to get getDocumentLevelAllowances()
        Returns:
        DocumentLevelAllowances
      • appendNewPaymentTerms

        public PaymentTerms appendNewPaymentTerms()
        Creates a PaymentTerms object and appends it to the list obtainable by a call to get getPaymentTerms()
        Returns:
        PaymentTerms
      • appendNewInvoiceTotalAmountWithoutVAT

        public InvoiceTotalAmountWithoutVAT appendNewInvoiceTotalAmountWithoutVAT​(Codes.Currency currencyCode)
        Creates an InvoiceTotalAmountWithoutVAT object and appends it to the list obtainable by a call to get getInvoiceTotalAmountWithoutVATs() Please note that by default every invoice already has one InvoiceTotalAmountWithoutVAT object}.
        Parameters:
        currencyCode - EXT:Currency code
        Returns:
        InvoiceTotalAmountWithoutVAT
      • appendNewInvoiceTotalVATAmount

        public InvoiceTotalVATAmount appendNewInvoiceTotalVATAmount()
        Creates an InvoiceTotalVATAmount object and appends it to the list obtainable by a call to get getInvoiceTotalVATAmounts() Please note that by default every invoice already has one InvoiceTotalVATAmount object for the currency of the invoice getInvoiceCurrencyCode().
        Returns:
        InvoiceTotalVATAmount
      • appendNewInvoiceTotalAmountWithVAT

        public InvoiceTotalAmountWithVAT appendNewInvoiceTotalAmountWithVAT​(Codes.Currency currencyCode)
        Creates an InvoiceTotalAmountWithVAT object and appends it to the list obtainable by a call to get getInvoiceTotalAmountWithVATs() Please note that by default every invoice already has one InvoiceTotalAmountWithVAT object}.
        Parameters:
        currencyCode - EXT:Currency code
        Returns:
        InvoiceTotalAmountWithVAT
      • appendNewAdvancePayment

        public AdvancePayment appendNewAdvancePayment()
        Creates an AdvancePayment object and appends it to the list obtainable by a call to get getAdvancePayments()
        Returns:
        AdvancePayment
      • setTestIndicator

        public Invoice setTestIndicator​(Boolean value)
        Parameters:
        value - EXT:Indicator

        Indicates if the invoice document is a test one

        To be used only in case of a test invoice, with value = true

        XPath:/rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:TestIndicator/udt:Indicator

        Returns:
        Invoice
      • setBusinessProcessType

        public Invoice setBusinessProcessType​(String value)
        Parameters:
        value - 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.

        To be specified by the Buyer.

        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:ID

        Returns:
        Invoice
      • setInvoiceNumber

        public Invoice setInvoiceNumber​(Identifier value)
        Parameters:
        value - BT-1:Invoice number

        A 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).

        XPath:/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:ID

        Returns:
        Invoice
      • setName

        public Invoice setName​(String value)
        Parameters:
        value - EXT:Document name (free text)

        XPath:/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:Name

        Returns:
        Invoice
      • setInvoiceTypeCode

        public Invoice setInvoiceTypeCode​(Codes.InvoiceTypeCode value)
        Parameters:
        value - BT-3:Invoice type code

        A 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).

        XPath:/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:TypeCode

        Returns:
        Invoice
      • setInvoiceIssueDate

        public Invoice setInvoiceIssueDate​(LocalDate value)
        Parameters:
        value - BT-2:Invoice issue date

        The 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).

        XPath:/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IssueDateTime/udt:DateTimeString

        Returns:
        Invoice
      • setCopyIndicator

        public Invoice setCopyIndicator​(Boolean value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:CopyIndicator/udt:Indicator

        Returns:
        Invoice
      • setCompleteDateTime

        public Invoice setCompleteDateTime​(String value)
        Parameters:
        value - EXT:Contractual due date of the invoice, Value

        XPath:/rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:EffectiveSpecifiedPeriod/ram:CompleteDateTime/udt:DateTimeString

        Returns:
        Invoice
      • setBuyerReference

        public Invoice setBuyerReference​(String value)
        Parameters:
        value - BT-10:Buyer reference

        An identifier assigned by the Buyer used for internal routing purposes.

        The identifier is defined by the Buyer (e.g. contact ID, department, office id, project code), but provided by the Seller in the Invoice.

        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:BuyerReference

        Returns:
        Invoice
      • setSellerName

        public Invoice setSellerName​(String value)
        Parameters:
        value - 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.

        BR-6: An Invoice shall contain the Seller name (BT-27).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:Name

        Returns:
        Invoice
      • setSellerAdditionalLegalInformation

        public Invoice setSellerAdditionalLegalInformation​(String value)
        Parameters:
        value - BT-33:Seller additional legal information

        Additional legal information relevant for the Seller.

        Such as share capital.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:Description

        Returns:
        Invoice
      • setSellerLegalOrganizationSchemeIdentiferAttribute

        public Invoice setSellerLegalOrganizationSchemeIdentiferAttribute​(Codes.SchemeIdentifier value)
        Parameters:
        value - BT-30-1:Seller legal registration identifier identification scheme identifier

        The identification scheme identifier of the Seller legal registration identifier.

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        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/@schemeID

        Returns:
        Invoice
      • setSellerLegalOrganizationIdentifer

        public Invoice setSellerLegalOrganizationIdentifer​(Identifier value)
        Parameters:
        value - BT-30:Seller legal registration identifier

        An identifier issued by an official registrar that identifies the Seller as a legal entity or person.

        If no identification scheme is specified, it should be known by Buyer and Seller.

        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:ID

        Returns:
        Invoice
      • setSellerLegalOrganizationTradingName

        public Invoice setSellerLegalOrganizationTradingName​(String value)
        Parameters:
        value - BT-28:Seller trading name

        A name by which the Seller is known, other than Seller name (also known as Business name).

        This may be used if different from the Seller name.

        CHORUS PRO: this field is limied to 99 characters.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setSellerLegalOrganizationPostCode

        public Invoice setSellerLegalOrganizationPostCode​(String value)
        Parameters:
        value - EXT:Postcode Code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setSellerLegalOrganizationAddressLine1

        public Invoice setSellerLegalOrganizationAddressLine1​(String value)
        Parameters:
        value - EXT:Line One

        The main address line in an address.

        Usually the street name and number or post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setSellerLegalOrganizationAddressLine2

        public Invoice setSellerLegalOrganizationAddressLine2​(String value)
        Parameters:
        value - EXT:Line Two

        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:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setSellerLegalOrganizationAddressLine3

        public Invoice setSellerLegalOrganizationAddressLine3​(String value)
        Parameters:
        value - EXT:Line Three

        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:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setSellerLegalOrganizationCity

        public Invoice setSellerLegalOrganizationCity​(String value)
        Parameters:
        value - EXT:City Name

        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:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setSellerLegalOrganizationCountryCode

        public Invoice setSellerLegalOrganizationCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country ID

        A code that identifies the country.

        If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setSellerPostCode

        public Invoice setSellerPostCode​(String value)
        Parameters:
        value - BT-38:Seller post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setSellerAddressLine1

        public Invoice setSellerAddressLine1​(String value)
        Parameters:
        value - BT-35:Seller address line 1

        The main address line in an address.

        Usually the street name and number or post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setSellerAddressLine2

        public Invoice setSellerAddressLine2​(String value)
        Parameters:
        value - 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:LineTwo

        Returns:
        Invoice
      • setSellerAddressLine3

        public Invoice setSellerAddressLine3​(String value)
        Parameters:
        value - 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:LineThree

        Returns:
        Invoice
      • setSellerCity

        public Invoice setSellerCity​(String value)
        Parameters:
        value - 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:CityName

        Returns:
        Invoice
      • setSellerCountryCode

        public Invoice setSellerCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - BT-40:Seller country code

        A code that identifies the country.

        If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        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:CountryID

        Returns:
        Invoice
      • setSellerElectronicAddressScheme

        public Invoice setSellerElectronicAddressScheme​(Codes.ElectronicAddressScheme value)
        Parameters:
        value - BT-34-1:Seller electronic address identification scheme identifier

        The identification scheme identifier of the Seller electronic address

        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/@schemeID

        Returns:
        Invoice
      • setSellerElectronicAddress

        public Invoice setSellerElectronicAddress​(Identifier value)
        Parameters:
        value - BT-34:Seller electronic address

        Identifies the Seller's electronic address to which the application level response to the invoice may be delivered.The identification scheme identifier of the Seller electronic address.

        The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

        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:URIID

        Returns:
        Invoice
      • setBuyerName

        public Invoice setBuyerName​(String value)
        Parameters:
        value - BT-44:Buyer name

        The full name of the Buyer.

        CHORUS PRO: this field is limied to 99 characters.

        BR-7: An Invoice shall contain the Buyer name (BT-44).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:Name

        Returns:
        Invoice
      • setBuyerLegalOrganizationSchemeIdentiferAttribute

        public Invoice setBuyerLegalOrganizationSchemeIdentiferAttribute​(Codes.SchemeIdentifier value)
        Parameters:
        value - BT-47-1:scheme identifier attribute

        Scheme identifier for Buyer legal identifier

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        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/@schemeID

        Returns:
        Invoice
      • setBuyerLegalOrganizationIdentifer

        public Invoice setBuyerLegalOrganizationIdentifer​(Identifier value)
        Parameters:
        value - BT-47:Buyer legal registration identifier

        An identifier issued by an official registrar that identifies the Buyer as a legal entity or person.The identification scheme identifier of the Buyer legal registration identifier.

        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.If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        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:ID

        Returns:
        Invoice
      • setBuyerLegalOrganizationTradingName

        public Invoice setBuyerLegalOrganizationTradingName​(String value)
        Parameters:
        value - BT-45:Buyer trading name

        A name by which the Buyer is known, other than Buyer name (also known as Business name).

        This may be used if different from the Buyer name.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setBuyerLegalOrganizationPostCode

        public Invoice setBuyerLegalOrganizationPostCode​(String value)
        Parameters:
        value - EXT:Postcode Code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setBuyerLegalOrganizationAddressLine1

        public Invoice setBuyerLegalOrganizationAddressLine1​(String value)
        Parameters:
        value - EXT:Line One

        The main address line in an address.

        Usually the street name and number or post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setBuyerLegalOrganizationAddressLine2

        public Invoice setBuyerLegalOrganizationAddressLine2​(String value)
        Parameters:
        value - EXT:Line Two

        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:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setBuyerLegalOrganizationAddressLine3

        public Invoice setBuyerLegalOrganizationAddressLine3​(String value)
        Parameters:
        value - EXT:Line Three

        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:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setBuyerLegalOrganizationCity

        public Invoice setBuyerLegalOrganizationCity​(String value)
        Parameters:
        value - EXT:City Name

        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:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setBuyerLegalOrganizationCountryCode

        public Invoice setBuyerLegalOrganizationCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country ID

        A code that identifies the country.

        The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setBuyerPostCode

        public Invoice setBuyerPostCode​(String value)
        Parameters:
        value - BT-53:Buyer post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setBuyerAddressLine1

        public Invoice setBuyerAddressLine1​(String value)
        Parameters:
        value - BT-50:Buyer address line 1

        The main address line in an address.

        Usually the street name and number or post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setBuyerAddressLine2

        public Invoice setBuyerAddressLine2​(String value)
        Parameters:
        value - 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:LineTwo

        Returns:
        Invoice
      • setBuyerAddressLine3

        public Invoice setBuyerAddressLine3​(String value)
        Parameters:
        value - 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:LineThree

        Returns:
        Invoice
      • setBuyerCity

        public Invoice setBuyerCity​(String value)
        Parameters:
        value - 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:CityName

        Returns:
        Invoice
      • setBuyerCountryCode

        public Invoice setBuyerCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - BT-55:Buyer country code

        A code that identifies the country.

        The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        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:CountryID

        Returns:
        Invoice
      • setBuyerElectronicAddressScheme

        public Invoice setBuyerElectronicAddressScheme​(Codes.ElectronicAddressScheme value)
        Parameters:
        value - BT-49-1:scheme identifier attribute

        Scheme identifier for Buyer electronic address

        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/@schemeID

        Returns:
        Invoice
      • setBuyerElectronicAddress

        public Invoice setBuyerElectronicAddress​(Identifier value)
        Parameters:
        value - BT-49:Buyer electronic address

        Identifies the Buyer's electronic address to which the invoice is delivered.

        The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

        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:URIID

        Returns:
        Invoice
      • setSalesAgentName

        public Invoice setSalesAgentName​(String value)
        Parameters:
        value - EXT:Sales Agent name

        The full name of the Sales Agent

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:Name

        Returns:
        Invoice
      • setRoleCode

        public Invoice setRoleCode​(String value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:RoleCode

        Returns:
        Invoice
      • setSalesAgentLegalOrganizationSchemeIdentiferAttribute

        public Invoice setSalesAgentLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:schemeID

        Scheme identifier for Sales Agentlegal identifier

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setSalesAgentLegalOrganizationIdentifer

        public Invoice setSalesAgentLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:ID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setSalesAgentLegalOrganizationTradingName

        public Invoice setSalesAgentLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:TradingBusinessName

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setSalesAgentLegalOrganizationPostCode

        public Invoice setSalesAgentLegalOrganizationPostCode​(String value)
        Parameters:
        value - EXT:Post code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setSalesAgentLegalOrganizationAddressLine1

        public Invoice setSalesAgentLegalOrganizationAddressLine1​(String value)
        Parameters:
        value - EXT:Address Line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setSalesAgentLegalOrganizationAddressLine2

        public Invoice setSalesAgentLegalOrganizationAddressLine2​(String value)
        Parameters:
        value - EXT:Address Line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setSalesAgentLegalOrganizationAddressLine3

        public Invoice setSalesAgentLegalOrganizationAddressLine3​(String value)
        Parameters:
        value - EXT:Address Line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setSalesAgentLegalOrganizationCity

        public Invoice setSalesAgentLegalOrganizationCity​(String value)
        Parameters:
        value - EXT:City

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setSalesAgentLegalOrganizationCountryCode

        public Invoice setSalesAgentLegalOrganizationCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country Code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setSalesAgentPostCode

        public Invoice setSalesAgentPostCode​(String value)
        Parameters:
        value - EXT:Sales Agent post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setSalesAgentAddressLine1

        public Invoice setSalesAgentAddressLine1​(String value)
        Parameters:
        value - EXT:Sales Agent address line 1

        The main address line in an address.

        Usually the street name and number or the post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setSalesAgentAddressLine2

        public Invoice setSalesAgentAddressLine2​(String value)
        Parameters:
        value - EXT:Sales Agent 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:SalesAgentTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setSalesAgentAddressLine3

        public Invoice setSalesAgentAddressLine3​(String value)
        Parameters:
        value - EXT:Sales Agent 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:SalesAgentTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setSalesAgentCity

        public Invoice setSalesAgentCity​(String value)
        Parameters:
        value - EXT:Sales Agent 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:SalesAgentTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setSalesAgentCountryCode

        public Invoice setSalesAgentCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Sales Agent country code

        A code that identifies the country.

        Country where VAT is liable. The lists of valid countries are registered with theEN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setSalesAgentElectronicAddressScheme

        public Invoice setSalesAgentElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:schemeID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setSalesAgentElectronicAddress

        public Invoice setSalesAgentElectronicAddress​(String value)
        Parameters:
        value - EXT:Sales Agent Electronic Address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setBuyerTaxRepresentativeName

        public Invoice setBuyerTaxRepresentativeName​(String value)
        Parameters:
        value - EXT:BUYER tax representative name

        The full name of the BUYER's tax representative party.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:Name

        Returns:
        Invoice
      • setBuyerTaxRepresentativeRoleCode

        public Invoice setBuyerTaxRepresentativeRoleCode​(String value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:RoleCode

        Returns:
        Invoice
      • setBuyerTaxRepresentativeLegalOrganizationSchemeIdentiferAttribute

        public Invoice setBuyerTaxRepresentativeLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setBuyerTaxRepresentativeLegalOrganizationIdentifer

        public Invoice setBuyerTaxRepresentativeLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setBuyerTaxRepresentativeLegalOrganizationTradingName

        public Invoice setBuyerTaxRepresentativeLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setBuyerTaxRepresentativeLegalOrganizationPostCode

        public Invoice setBuyerTaxRepresentativeLegalOrganizationPostCode​(String value)
        Parameters:
        value - EXT:Post code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setBuyerTaxRepresentativeLegalOrganizationAddressLine1

        public Invoice setBuyerTaxRepresentativeLegalOrganizationAddressLine1​(String value)
        Parameters:
        value - EXT:Address Line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setBuyerTaxRepresentativeLegalOrganizationAddressLine2

        public Invoice setBuyerTaxRepresentativeLegalOrganizationAddressLine2​(String value)
        Parameters:
        value - EXT:Address Line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setBuyerTaxRepresentativeLegalOrganizationAddressLine3

        public Invoice setBuyerTaxRepresentativeLegalOrganizationAddressLine3​(String value)
        Parameters:
        value - EXT:Address Line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setBuyerTaxRepresentativeLegalOrganizationCity

        public Invoice setBuyerTaxRepresentativeLegalOrganizationCity​(String value)
        Parameters:
        value - EXT:City

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setBuyerTaxRepresentativeLegalOrganizationCountryCode

        public Invoice setBuyerTaxRepresentativeLegalOrganizationCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country Code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setBuyerTaxRepresentativePostCode

        public Invoice setBuyerTaxRepresentativePostCode​(String value)
        Parameters:
        value - EXT:Tax representative post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setBuyerTaxRepresentativeAddressLine1

        public Invoice setBuyerTaxRepresentativeAddressLine1​(String value)
        Parameters:
        value - EXT:Tax representative address line 1

        The main address line in an address.

        Usually the street name and number or the post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setBuyerTaxRepresentativeAddressLine2

        public Invoice setBuyerTaxRepresentativeAddressLine2​(String value)
        Parameters:
        value - EXT: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:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setBuyerTaxRepresentativeAddressLine3

        public Invoice setBuyerTaxRepresentativeAddressLine3​(String value)
        Parameters:
        value - EXT: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:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setBuyerTaxRepresentativeCity

        public Invoice setBuyerTaxRepresentativeCity​(String value)
        Parameters:
        value - EXT: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:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setBuyerTaxRepresentativeCountryCode

        public Invoice setBuyerTaxRepresentativeCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Tax representative country code

        A code that identifies the country.

        Country where VAT is liable. The lists of valid countries are registered with theEN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        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:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setBuyerTaxRepresentativeElectronicAddressScheme

        public Invoice setBuyerTaxRepresentativeElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:Electronic Address Type

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setBuyerTaxRepresentativeElectronicAddress

        public Invoice setBuyerTaxRepresentativeElectronicAddress​(String value)
        Parameters:
        value - EXT:Electronic address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setSellerTaxRepresentativeName

        public Invoice setSellerTaxRepresentativeName​(String value)
        Parameters:
        value - BT-62:Seller tax representative name

        The full name of the Seller's tax representative party.

        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:Name

        Returns:
        Invoice
      • setSellerTaxRepresentativeLegalOrganizationSchemeIdentiferAttribute

        public Invoice setSellerTaxRepresentativeLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:Scheme identifier attribute

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setSellerTaxRepresentativeLegalOrganizationIdentifer

        public Invoice setSellerTaxRepresentativeLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setSellerTaxRepresentativeLegalOrganizationTradingName

        public Invoice setSellerTaxRepresentativeLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setSellerTaxRepresentativeLegalOrganizationPostCode

        public Invoice setSellerTaxRepresentativeLegalOrganizationPostCode​(String value)
        Parameters:
        value - EXT:Post code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setSellerTaxRepresentativeLegalOrganizationAddressLine1

        public Invoice setSellerTaxRepresentativeLegalOrganizationAddressLine1​(String value)
        Parameters:
        value - EXT:Address Line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setSellerTaxRepresentativeLegalOrganizationAddressLine2

        public Invoice setSellerTaxRepresentativeLegalOrganizationAddressLine2​(String value)
        Parameters:
        value - EXT:Address Line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setSellerTaxRepresentativeLegalOrganizationAddressLine3

        public Invoice setSellerTaxRepresentativeLegalOrganizationAddressLine3​(String value)
        Parameters:
        value - EXT:Address Line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setSellerTaxRepresentativeLegalOrganizationCity

        public Invoice setSellerTaxRepresentativeLegalOrganizationCity​(String value)
        Parameters:
        value - EXT:City

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setSellerTaxRepresentativeLegalOrganizationCountryCode

        public Invoice setSellerTaxRepresentativeLegalOrganizationCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country Code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setSellerTaxRepresentativePostCode

        public Invoice setSellerTaxRepresentativePostCode​(String value)
        Parameters:
        value - BT-67:Tax representative post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setSellerTaxRepresentativeAddressLine1

        public Invoice setSellerTaxRepresentativeAddressLine1​(String value)
        Parameters:
        value - BT-64:Tax representative address line 1

        The main address line in an address.

        Usually the street name and number or the post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setSellerTaxRepresentativeAddressLine2

        public Invoice setSellerTaxRepresentativeAddressLine2​(String value)
        Parameters:
        value - 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:LineTwo

        Returns:
        Invoice
      • setSellerTaxRepresentativeAddressLine3

        public Invoice setSellerTaxRepresentativeAddressLine3​(String value)
        Parameters:
        value - 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:LineThree

        Returns:
        Invoice
      • setSellerTaxRepresentativeCity

        public Invoice setSellerTaxRepresentativeCity​(String value)
        Parameters:
        value - 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:CityName

        Returns:
        Invoice
      • setSellerTaxRepresentativeCountryCode

        public Invoice setSellerTaxRepresentativeCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - BT-69:Tax representative country code

        A code that identifies the country.

        Country where VAT is liable. The lists of valid countries are registered with theEN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        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:CountryID

        Returns:
        Invoice
      • setSellerTaxRepresentativeElectronicAddressScheme

        public Invoice setSellerTaxRepresentativeElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:Electronic Address Type Scheme identifier attribute

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setSellerTaxRepresentativeElectronicAddress

        public Invoice setSellerTaxRepresentativeElectronicAddress​(String value)
        Parameters:
        value - EXT:Electronic address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setProductEndUserName

        public Invoice setProductEndUserName​(String value)
        Parameters:
        value - EXT:Deviating end user identifier Name / Company Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:Name

        Returns:
        Invoice
      • setProductEndUserLegalOrganizationSchemeIdentiferAttribute

        public Invoice setProductEndUserLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:Scheme identifier attribute

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setProductEndUserLegalOrganizationIdentifer

        public Invoice setProductEndUserLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:Company Registration Number

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setProductEndUserLegalOrganizationTradingName

        public Invoice setProductEndUserLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setProductEndUserPostCode

        public Invoice setProductEndUserPostCode​(String value)
        Parameters:
        value - EXT:Post Code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setProductEndUserAddressLine1

        public Invoice setProductEndUserAddressLine1​(String value)
        Parameters:
        value - EXT:Address Line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setProductEndUserAddressLine2

        public Invoice setProductEndUserAddressLine2​(String value)
        Parameters:
        value - EXT:Address Line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setProductEndUserAddressLine3

        public Invoice setProductEndUserAddressLine3​(String value)
        Parameters:
        value - EXT:Address Line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setProductEndUserCity

        public Invoice setProductEndUserCity​(String value)
        Parameters:
        value - EXT:City

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setProductEndUserCountryCode

        public Invoice setProductEndUserCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country Code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setProductEndUserElectronicAddressScheme

        public Invoice setProductEndUserElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:Electronic Address Type Scheme identifier attribute

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setProductEndUserElectronicAddress

        public Invoice setProductEndUserElectronicAddress​(String value)
        Parameters:
        value - EXT:Electronic address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setDeliveryTypeCode

        public Invoice setDeliveryTypeCode​(String value)
        Parameters:
        value - EXT:Delivery condition (Code)

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ApplicableTradeDeliveryTerms/ram:DeliveryTypeCode

        Returns:
        Invoice
      • setBuyerAgentRoleCode

        public Invoice setBuyerAgentRoleCode​(String value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:RoleCode

        Returns:
        Invoice
      • setBuyerAgentLegalOrganizationSchemeIdentiferAttribute

        public Invoice setBuyerAgentLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:schemeID

        Scheme identifier for BUYER Agentlegal identifier

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setBuyerAgentLegalOrganizationIdentifer

        public Invoice setBuyerAgentLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:ID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setBuyerAgentLegalOrganizationTradingName

        public Invoice setBuyerAgentLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:TradingBusinessName

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setBuyerAgentLegalOrganizationPostCode

        public Invoice setBuyerAgentLegalOrganizationPostCode​(String value)
        Parameters:
        value - EXT:Post code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setBuyerAgentLegalOrganizationAddressLine1

        public Invoice setBuyerAgentLegalOrganizationAddressLine1​(String value)
        Parameters:
        value - EXT:Address Line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setBuyerAgentLegalOrganizationAddressLine2

        public Invoice setBuyerAgentLegalOrganizationAddressLine2​(String value)
        Parameters:
        value - EXT:Address Line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setBuyerAgentLegalOrganizationAddressLine3

        public Invoice setBuyerAgentLegalOrganizationAddressLine3​(String value)
        Parameters:
        value - EXT:Address Line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setBuyerAgentLegalOrganizationCity

        public Invoice setBuyerAgentLegalOrganizationCity​(String value)
        Parameters:
        value - EXT:City

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setBuyerAgentLegalOrganizationCountryCode

        public Invoice setBuyerAgentLegalOrganizationCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country Code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setBuyerAgentPostCode

        public Invoice setBuyerAgentPostCode​(String value)
        Parameters:
        value - EXT:Buyer Agent post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setBuyerAgentAddressLine1

        public Invoice setBuyerAgentAddressLine1​(String value)
        Parameters:
        value - EXT:Buyer Agent address line 1

        The main address line in an address.

        Usually the street name and number or the post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setBuyerAgentAddressLine2

        public Invoice setBuyerAgentAddressLine2​(String value)
        Parameters:
        value - EXT:Buyer Agent 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:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setBuyerAgentAddressLine3

        public Invoice setBuyerAgentAddressLine3​(String value)
        Parameters:
        value - EXT:Buyer Agent 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:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setBuyerAgentCity

        public Invoice setBuyerAgentCity​(String value)
        Parameters:
        value - EXT:Buyer Agent 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:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setBuyerAgentCountryCode

        public Invoice setBuyerAgentCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Buyer Agent country code

        A code that identifies the country.

        Country where VAT is liable. The lists of valid countries are registered with theEN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setBuyerAgentElectronicAddressScheme

        public Invoice setBuyerAgentElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:schemeID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setBuyerAgentElectronicAddress

        public Invoice setBuyerAgentElectronicAddress​(String value)
        Parameters:
        value - EXT:Buyer Agent Electronic Address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setProjectReference

        public Invoice setProjectReference​(DocumentReference value)
        Parameters:
        value - BT-11:Project reference

        The identification of the project the invoice refers to

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:ID

        Returns:
        Invoice
      • setProjectName

        public Invoice setProjectName​(String value)
        Parameters:
        value - BT-11-0:Project name

        Value : "Project Reference"

        Use "Project reference" as default value for Name.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:Name

        Returns:
        Invoice
      • setDeliverToName

        public Invoice setDeliverToName​(String value)
        Parameters:
        value - BT-70:Deliver to party name

        The name of the party to which the goods and services are delivered.

        Shall be used if the Deliver to party is different from the Buyer.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:Name

        Returns:
        Invoice
      • setDeliverToLegalOrganizationSchemeIdentiferAttribute

        public Invoice setDeliverToLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:Scheme identifier attribute

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setDeliverToLegalOrganizationIdentifer

        public Invoice setDeliverToLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:Company Registration Number

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setDeliverToLegalOrganizationTradingName

        public Invoice setDeliverToLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setDeliverToPostCode

        public Invoice setDeliverToPostCode​(String value)
        Parameters:
        value - BT-78:Deliver to post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setDeliverToAddressLine1

        public Invoice setDeliverToAddressLine1​(String value)
        Parameters:
        value - BT-75:Deliver to address line 1

        The main address line in an address.

        Usually the street name and number.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setDeliverToAddressLine2

        public Invoice setDeliverToAddressLine2​(String value)
        Parameters:
        value - 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:LineTwo

        Returns:
        Invoice
      • setDeliverToAddressLine3

        public Invoice setDeliverToAddressLine3​(String value)
        Parameters:
        value - 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:LineThree

        Returns:
        Invoice
      • setDeliverToCity

        public Invoice setDeliverToCity​(String value)
        Parameters:
        value - 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:CityName

        Returns:
        Invoice
      • setDeliverToCountryCode

        public Invoice setDeliverToCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - BT-80:Deliver to country code

        A code that identifies the country.

        The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        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:CountryID

        Returns:
        Invoice
      • setDeliverToElectronicAddressScheme

        public Invoice setDeliverToElectronicAddressScheme​(Codes.ElectronicAddressScheme value)
        Parameters:
        value - EXT:Electronic Address Type Electronic Address Type

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setDeliverToElectronicAddress

        public Invoice setDeliverToElectronicAddress​(String value)
        Parameters:
        value - EXT:Electronic address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setUltimateShipToName

        public Invoice setUltimateShipToName​(String value)
        Parameters:
        value - EXT:Final Recipient Name / Company Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:Name

        Returns:
        Invoice
      • setUltimateShipToLegalOrganizationSchemeIdentiferAttribute

        public Invoice setUltimateShipToLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:Scheme identifier attribute

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setUltimateShipToLegalOrganizationIdentifer

        public Invoice setUltimateShipToLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:Company Registration Number

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setUltimateShipToLegalOrganizationTradingName

        public Invoice setUltimateShipToLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setUltimateShipToPostCode

        public Invoice setUltimateShipToPostCode​(String value)
        Parameters:
        value - EXT:Final recipient post code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setUltimateShipToAddressLine1

        public Invoice setUltimateShipToAddressLine1​(String value)
        Parameters:
        value - EXT:Final recipient address line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setUltimateShipToAddressLine2

        public Invoice setUltimateShipToAddressLine2​(String value)
        Parameters:
        value - EXT:Final recipient address line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setUltimateShipToAddressLine3

        public Invoice setUltimateShipToAddressLine3​(String value)
        Parameters:
        value - EXT:Final recipient address line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setUltimateShipToCity

        public Invoice setUltimateShipToCity​(String value)
        Parameters:
        value - EXT:Final recipient city

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setUltimateShipToCountryCode

        public Invoice setUltimateShipToCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Final recipient country (Code)

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setUltimateShipToElectronicAddressScheme

        public Invoice setUltimateShipToElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:Electronic Address Type Electronic address type

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setUltimateShipToElectronicAddress

        public Invoice setUltimateShipToElectronicAddress​(String value)
        Parameters:
        value - EXT:Electronic address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setShipFromName

        public Invoice setShipFromName​(String value)
        Parameters:
        value - EXT:Deviating sender name / company name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:Name

        Returns:
        Invoice
      • setShipFromLegalOrganizationSchemeIdentiferAttribute

        public Invoice setShipFromLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:Scheme identifier attribute

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setShipFromLegalOrganizationIdentifer

        public Invoice setShipFromLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:Company Registration Number

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setShipFromLegalOrganizationTradingName

        public Invoice setShipFromLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setShipFromPostCode

        public Invoice setShipFromPostCode​(String value)
        Parameters:
        value - EXT:Sender post code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setShipFromAddressLine1

        public Invoice setShipFromAddressLine1​(String value)
        Parameters:
        value - EXT:Sender address line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setShipFromAddressLine2

        public Invoice setShipFromAddressLine2​(String value)
        Parameters:
        value - EXT:Sender address line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setShipFromAddressLine3

        public Invoice setShipFromAddressLine3​(String value)
        Parameters:
        value - EXT:Sender address line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setShipFromCity

        public Invoice setShipFromCity​(String value)
        Parameters:
        value - EXT:Sender city

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setShipFromCountryCode

        public Invoice setShipFromCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Sender country (Code)

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setShipFromElectronicAddressScheme

        public Invoice setShipFromElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:Electronic Address Type Electronic address type

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setShipFromElectronicAddress

        public Invoice setShipFromElectronicAddress​(String value)
        Parameters:
        value - EXT:Electronic address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setActualDeliveryDate

        public Invoice setActualDeliveryDate​(LocalDate value)
        Parameters:
        value - 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:DateTimeString

        Returns:
        Invoice
      • setBankAssignedCreditorIdentifier

        public Invoice setBankAssignedCreditorIdentifier​(Identifier value)
        Parameters:
        value - BT-90:Bank assigned creditor identifier

        Unique banking reference identifier of the Payee or Seller assigned by the Payee or Seller bank.

        Used in order to pre-notify the Buyer of a SEPA direct debit.

        This is the ICS for SEPA direct debits

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:CreditorReferenceID

        Returns:
        Invoice
      • setRemittanceInformation

        public Invoice setRemittanceInformation​(String value)
        Parameters:
        value - BT-83:Remittance information

        A textual value used to establish a link between the payment and the Invoice, issued by the Seller.

        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. Reference section 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.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PaymentReference

        Returns:
        Invoice
      • setVATAccountingCurrencyCode

        public Invoice setVATAccountingCurrencyCode​(Codes.Currency value)
        Parameters:
        value - 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.

        Shall be used in combination with the Invoice 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:TaxCurrencyCode

        Returns:
        Invoice
      • setInvoiceCurrencyCode

        public Invoice setInvoiceCurrencyCode​(Codes.Currency value)
        Parameters:
        value - BT-5:Invoice currency code

        The 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).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceCurrencyCode

        Returns:
        Invoice
      • setSellerReferenceNumber

        public Invoice setSellerReferenceNumber​(String value)
        Parameters:
        value - EXT:Seller reference number

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceIssuerReference

        Returns:
        Invoice
      • setInvoicerName

        public Invoice setInvoicerName​(String value)
        Parameters:
        value - EXT:Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:Name

        Returns:
        Invoice
      • setInvoicerLegalOrganizationSchemeIdentiferAttribute

        public Invoice setInvoicerLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:schemeID

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setInvoicerLegalOrganizationIdentifer

        public Invoice setInvoicerLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:ID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setInvoicerLegalOrganizationTradingName

        public Invoice setInvoicerLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setInvoicerPostCode

        public Invoice setInvoicerPostCode​(String value)
        Parameters:
        value - EXT:Postcode Code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setInvoicerAddressLine1

        public Invoice setInvoicerAddressLine1​(String value)
        Parameters:
        value - EXT:Line One

        The main address line in an address.

        Usually the street name and number or post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setInvoicerAddressLine2

        public Invoice setInvoicerAddressLine2​(String value)
        Parameters:
        value - EXT:Line Two

        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:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setInvoicerAddressLine3

        public Invoice setInvoicerAddressLine3​(String value)
        Parameters:
        value - EXT:Line Three

        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:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setInvoicerCity

        public Invoice setInvoicerCity​(String value)
        Parameters:
        value - EXT:City Name

        The common name of the city, town or village, where the Seller address is located.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setInvoicerCountryCode

        public Invoice setInvoicerCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country ID

        A code that identifies the country.

        If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setInvoicerElectronicAddressScheme

        public Invoice setInvoicerElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:schemeID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setInvoicerElectronicAddress

        public Invoice setInvoicerElectronicAddress​(String value)
        Parameters:
        value - EXT:URIID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setInvoiceeName

        public Invoice setInvoiceeName​(String value)
        Parameters:
        value - EXT:Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:Name

        Returns:
        Invoice
      • setInvoiceeLegalOrganizationSchemeIdentiferAttribute

        public Invoice setInvoiceeLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:schemeID

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setInvoiceeLegalOrganizationIdentifer

        public Invoice setInvoiceeLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:ID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setInvoiceeLegalOrganizationTradingName

        public Invoice setInvoiceeLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setInvoiceePostCode

        public Invoice setInvoiceePostCode​(String value)
        Parameters:
        value - EXT:Postcode Code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setInvoiceeAddressLine1

        public Invoice setInvoiceeAddressLine1​(String value)
        Parameters:
        value - EXT:Line One

        The main address line in an address.

        Usually the street name and number or post office box.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setInvoiceeAddressLine2

        public Invoice setInvoiceeAddressLine2​(String value)
        Parameters:
        value - EXT:Line Two

        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:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setInvoiceeAddressLine3

        public Invoice setInvoiceeAddressLine3​(String value)
        Parameters:
        value - EXT:Line Three

        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:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setInvoiceeCity

        public Invoice setInvoiceeCity​(String value)
        Parameters:
        value - EXT:City Name

        The common name of the city, town or village, where the Seller address is located.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setInvoiceeCountryCode

        public Invoice setInvoiceeCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country ID

        A code that identifies the country.

        If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setInvoiceeElectronicAddressScheme

        public Invoice setInvoiceeElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:schemeID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setInvoiceeElectronicAddress

        public Invoice setInvoiceeElectronicAddress​(String value)
        Parameters:
        value - EXT:URIID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setPayeeName

        public Invoice setPayeeName​(String value)
        Parameters:
        value - BT-59:Payee name

        The name of the Payee.

        Shall be used when the Payee is different from the Seller. The Payee name may however be the same as the Seller name.

        If the PAYEE party bock is present, the name of the Payee is mandatory

        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:Name

        Returns:
        Invoice
      • setPayeeLegalOrganizationSchemeIdentiferAttribute

        public Invoice setPayeeLegalOrganizationSchemeIdentiferAttribute​(Codes.SchemeIdentifier value)
        Parameters:
        value - BT-61-1:Scheme identifier

        The identification scheme identifier of the Payee legal registration identifier.

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        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/@schemeID

        Returns:
        Invoice
      • setPayeeLegalOrganizationIdentifer

        public Invoice setPayeeLegalOrganizationIdentifer​(Identifier value)
        Parameters:
        value - BT-61:Payee legal registration identifierScheme identifier

        An identifier issued by an official registrar that identifies the Payee as a legal entity or person.The identification scheme identifier of the Payee legal registration identifier.

        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.If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setPayeeLegalOrganizationTradingName

        public Invoice setPayeeLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setPayeePostCode

        public Invoice setPayeePostCode​(String value)
        Parameters:
        value - EXT:Payee post code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setPayeeAddressLine1

        public Invoice setPayeeAddressLine1​(String value)
        Parameters:
        value - EXT:Payee address line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setPayeeAddressLine2

        public Invoice setPayeeAddressLine2​(String value)
        Parameters:
        value - EXT:Payee address line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setPayeeAddressLine3

        public Invoice setPayeeAddressLine3​(String value)
        Parameters:
        value - EXT:Payee address line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setPayeeCity

        public Invoice setPayeeCity​(String value)
        Parameters:
        value - EXT:Payee city

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setPayeeCountryCode

        public Invoice setPayeeCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Payee country (Code)

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setPayeeElectronicAddressScheme

        public Invoice setPayeeElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:schemeID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setPayeeElectronicAddress

        public Invoice setPayeeElectronicAddress​(String value)
        Parameters:
        value - EXT:URIID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setPayerName

        public Invoice setPayerName​(String value)
        Parameters:
        value - EXT:Payer name

        The name of the Payer.

        Shall be used when the Payee is different from the Seller. The Payee name may however be the same as the Seller name.

        If the PAYEE party bock is present, the name of the Payee is mandatory

        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:PayerTradeParty/ram:Name

        Returns:
        Invoice
      • setPayerRoleCode

        public Invoice setPayerRoleCode​(String value)
        Parameters:
        value - EXT:Payer Role Code

        A code specifying the role of this trade party.

        To be chosen from the entries in UNCL 3035, for instance :AB : Buyer Agent / representativeMOP : Market operator

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:RoleCode

        Returns:
        Invoice
      • setPayerLegalOrganizationSchemeIdentiferAttribute

        public Invoice setPayerLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:Scheme identifier

        The identification scheme identifier of the Payer legal registration identifier.

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID

        Returns:
        Invoice
      • setPayerLegalOrganizationIdentifer

        public Invoice setPayerLegalOrganizationIdentifer​(Identifier value)
        Parameters:
        value - EXT:Payer legal registration identifierScheme identifier

        An identifier issued by an official registrar that identifies the Payer as a legal entity or person.The identification scheme identifier of the Payer legal registration identifier.

        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.If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        Invoice
      • setPayerLegalOrganizationTradingName

        public Invoice setPayerLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        Invoice
      • setPayerPostCode

        public Invoice setPayerPostCode​(String value)
        Parameters:
        value - EXT:Post code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        Invoice
      • setPayerAddressLine1

        public Invoice setPayerAddressLine1​(String value)
        Parameters:
        value - EXT:Address Line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        Invoice
      • setPayerAddressLine2

        public Invoice setPayerAddressLine2​(String value)
        Parameters:
        value - EXT:Address Line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        Invoice
      • setPayerAddressLine3

        public Invoice setPayerAddressLine3​(String value)
        Parameters:
        value - EXT:Address Line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        Invoice
      • setPayerCity

        public Invoice setPayerCity​(String value)
        Parameters:
        value - EXT:City

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        Invoice
      • setPayerCountryCode

        public Invoice setPayerCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country Code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        Invoice
      • setPayerElectronicAddressScheme

        public Invoice setPayerElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:schemeID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID

        Returns:
        Invoice
      • setPayerElectronicAddress

        public Invoice setPayerElectronicAddress​(String value)
        Parameters:
        value - EXT:URIID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        Invoice
      • setSourceCurrencyCode

        public Invoice setSourceCurrencyCode​(Codes.Currency value)
        Parameters:
        value - EXT:Source Currency Code

        The code specifying the source currency of a trade related currency conversion.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:SourceCurrencyCode

        Returns:
        Invoice
      • setTargetCurrencyCode

        public Invoice setTargetCurrencyCode​(Codes.Currency value)
        Parameters:
        value - EXT:Target Currency Code

        The code specifying the target currency of a trade related currency conversion.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:TargetCurrencyCode

        Returns:
        Invoice
      • setConversionRate

        public Invoice setConversionRate​(Decimal value)
        Parameters:
        value - EXT:Conversion Rate

        The rate factor used for conversion from the source currency to the target currency for trade purposes.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:ConversionRate

        Returns:
        Invoice
      • setConversionRateDateTime

        public Invoice setConversionRateDateTime​(String value)
        Parameters:
        value - EXT:Exchange rate date, value

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:ConversionRateDateTime/udt:DateTimeString

        Returns:
        Invoice
      • setDescription

        public Invoice setDescription​(String value)
        Parameters:
        value - EXT:Description

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:Description

        Returns:
        Invoice
      • setInvoicingPeriodStartDate

        public Invoice setInvoicingPeriodStartDate​(LocalDate value)
        Parameters:
        value - BT-73:Invoicing period start date

        The date when the Invoice period starts.

        The initial date of delivery of goods or services.

        This date must be less than or equal to the period end date (BT-74), if it exists

        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:DateTimeString

        Returns:
        Invoice
      • setInvoicingPeriodEndDate

        public Invoice setInvoicingPeriodEndDate​(LocalDate value)
        Parameters:
        value - BT-74:Invoicing period end date

        The date when the Invoice period ends.

        The date on which the delivery of goods or services was completed.

        This date must be greater than or equal to the period start date (BT-73), if it exists

        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:DateTimeString

        Returns:
        Invoice
      • setSumOfChargesOnDocumentLevel

        public Invoice setSumOfChargesOnDocumentLevel​(Amount value)
        Parameters:
        value - BT-108:Sum of charges on document level

        Sum of all charges on document level in the Invoice.

        Charges on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.

        BR-CO-12: Sum of charges on document level (BT-108) = ? Document level charge amount (BT-99).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:ChargeTotalAmount

        Returns:
        Invoice
      • setSumOfAllowancesOnDocumentLevel

        public Invoice setSumOfAllowancesOnDocumentLevel​(Amount value)
        Parameters:
        value - BT-107:Sum of allowances on document level

        Sum of all allowances on document level in the Invoice.

        Allowances on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.

        BR-CO-11: Sum of allowances on document level (BT-107) = ? Document level allowance amount (BT-92).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:AllowanceTotalAmount

        Returns:
        Invoice
      • setRoundingAmount

        public Invoice setRoundingAmount​(Amount value)
        Parameters:
        value - BT-114:Rounding amount

        The amount to be added to the invoice total to round the amount to be paid.

        This mechanism is not applied in France.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:RoundingAmount

        Returns:
        Invoice
      • setPaidAmount

        public Invoice setPaidAmount​(Amount value)
        Parameters:
        value - BT-113:Paid amount

        The sum of amounts which have been paid in advance.

        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:TotalPrepaidAmount

        Returns:
        Invoice
      • getTestIndicator

        public Boolean getTestIndicator()
        EXT:Indicator

        Indicates if the invoice document is a test one

        To be used only in case of a test invoice, with value = true

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:TestIndicator/udt:Indicator
      • getBusinessProcessType

        public String getBusinessProcessType()
        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.

        To be specified by the Buyer.

        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.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:BusinessProcessSpecifiedDocumentContextParameter/ram:ID
      • getSpecificationIdentifier

        public Identifier getSpecificationIdentifier()
                                              throws ComputationException
        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.

        This identifies compliance or conformance to this document. Compliant 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.

        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

        BR-1: An Invoice shall have a Specification identifier (BT-24).

        Returns:
        a computed value unless an explicit value has been set and setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocumentContext/ram:GuidelineSpecifiedDocumentContextParameter/ram:ID is returned
        Throws:
        ComputationException
      • getInvoiceNumber

        public Identifier getInvoiceNumber()
        BT-1:Invoice number

        A 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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:ID
      • getName

        public String getName()
        EXT:Document name (free text)
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:Name
      • getInvoiceTypeCode

        public Codes.InvoiceTypeCode getInvoiceTypeCode()
        BT-3:Invoice type code

        A 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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:TypeCode
      • getDateFormat

        public Codes.DateFormat getDateFormat()
                                       throws ComputationException
        BT-2-0:date format

        Value= 102

        Only value "102"

        Returns:
        a computed value unless an explicit value has been set and setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IssueDateTime/udt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getInvoiceIssueDate

        public LocalDate getInvoiceIssueDate()
        BT-2:Invoice issue date

        The 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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:IssueDateTime/udt:DateTimeString
      • getCopyIndicator

        public Boolean getCopyIndicator()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:CopyIndicator/udt:Indicator
      • getCompleteDateTimeFormat

        public Codes.DateFormat getCompleteDateTimeFormat()
                                                   throws ComputationException
        EXT:Date Format
        Returns:
        a computed value unless an explicit value has been set and setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:EffectiveSpecifiedPeriod/ram:CompleteDateTime/udt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getCompleteDateTime

        public String getCompleteDateTime()
        EXT:Contractual due date of the invoice, Value
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:ExchangedDocument/ram:EffectiveSpecifiedPeriod/ram:CompleteDateTime/udt:DateTimeString
      • getBuyerReference

        public String getBuyerReference()
        BT-10:Buyer reference

        An identifier assigned by the Buyer used for internal routing purposes.

        The identifier is defined by the Buyer (e.g. contact ID, department, office id, project code), but provided by the Seller in the Invoice.

        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.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerReference
      • getSellerName

        public String getSellerName()
        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.

        BR-6: An Invoice shall contain the Seller name (BT-27).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:Name
      • getSellerAdditionalLegalInformation

        public String getSellerAdditionalLegalInformation()
        BT-33:Seller additional legal information

        Additional legal information relevant for the Seller.

        Such as share capital.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:Description
      • getSellerLegalOrganizationSchemeIdentiferAttribute

        public Codes.SchemeIdentifier getSellerLegalOrganizationSchemeIdentiferAttribute()
        BT-30-1:Seller legal registration identifier identification scheme identifier

        The identification scheme identifier of the Seller legal registration identifier.

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getSellerLegalOrganizationIdentifer

        public Identifier getSellerLegalOrganizationIdentifer()
        BT-30:Seller legal registration identifier

        An identifier issued by an official registrar that identifies the Seller as a legal entity or person.

        If no identification scheme is specified, it should be known by Buyer and Seller.

        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.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getSellerLegalOrganizationTradingName

        public String getSellerLegalOrganizationTradingName()
        BT-28:Seller trading name

        A name by which the Seller is known, other than Seller name (also known as Business name).

        This may be used if different from the Seller name.

        CHORUS PRO: this field is limied to 99 characters.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getSellerLegalOrganizationPostCode

        public String getSellerLegalOrganizationPostCode()
        EXT:Postcode Code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode
      • getSellerLegalOrganizationAddressLine1

        public String getSellerLegalOrganizationAddressLine1()
        EXT:Line One

        The main address line in an address.

        Usually the street name and number or post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne
      • getSellerLegalOrganizationAddressLine2

        public String getSellerLegalOrganizationAddressLine2()
        EXT:Line Two

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo
      • getSellerLegalOrganizationAddressLine3

        public String getSellerLegalOrganizationAddressLine3()
        EXT:Line Three

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree
      • getSellerLegalOrganizationCity

        public String getSellerLegalOrganizationCity()
        EXT:City Name

        The common name of the city, town or village, where the Seller address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName
      • getSellerLegalOrganizationCountryCode

        public Codes.CountryCodeList getSellerLegalOrganizationCountryCode()
        EXT:Country ID

        A code that identifies the country.

        If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID
      • getSellerPostCode

        public String getSellerPostCode()
        BT-38:Seller post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getSellerAddressLine1

        public String getSellerAddressLine1()
        BT-35:Seller address line 1

        The main address line in an address.

        Usually the street name and number or post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getSellerAddressLine2

        public String getSellerAddressLine2()
        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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getSellerAddressLine3

        public String getSellerAddressLine3()
        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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getSellerCity

        public String getSellerCity()
        BT-37:Seller city

        The common name of the city, town or village, where the Seller address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CityName
      • getSellerCountryCode

        public Codes.CountryCodeList getSellerCountryCode()
        BT-40:Seller country code

        A code that identifies the country.

        If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        BR-9: The Seller postal address (BG-5) shall contain a Seller country code (BT-40).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getSellerElectronicAddressScheme

        public Codes.ElectronicAddressScheme getSellerElectronicAddressScheme()
        BT-34-1:Seller electronic address identification scheme identifier

        The identification scheme identifier of the Seller electronic address

        The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getSellerElectronicAddress

        public Identifier getSellerElectronicAddress()
        BT-34:Seller electronic address

        Identifies the Seller's electronic address to which the application level response to the invoice may be delivered.The identification scheme identifier of the Seller electronic address.

        The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

        BR-62: The Seller electronic address (BT-34) shall have a Scheme identifier.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getBuyerName

        public String getBuyerName()
        BT-44:Buyer name

        The full name of the Buyer.

        CHORUS PRO: this field is limied to 99 characters.

        BR-7: An Invoice shall contain the Buyer name (BT-44).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:Name
      • getBuyerLegalOrganizationSchemeIdentiferAttribute

        public Codes.SchemeIdentifier getBuyerLegalOrganizationSchemeIdentiferAttribute()
        BT-47-1:scheme identifier attribute

        Scheme identifier for Buyer legal identifier

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getBuyerLegalOrganizationIdentifer

        public Identifier getBuyerLegalOrganizationIdentifer()
        BT-47:Buyer legal registration identifier

        An identifier issued by an official registrar that identifies the Buyer as a legal entity or person.The identification scheme identifier of the Buyer legal registration identifier.

        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.If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        CHORUSPRO: the identifier of the buyer (public entity) is mandatory and is always a SIRET number

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getBuyerLegalOrganizationTradingName

        public String getBuyerLegalOrganizationTradingName()
        BT-45:Buyer trading name

        A name by which the Buyer is known, other than Buyer name (also known as Business name).

        This may be used if different from the Buyer name.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getBuyerLegalOrganizationPostCode

        public String getBuyerLegalOrganizationPostCode()
        EXT:Postcode Code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode
      • getBuyerLegalOrganizationAddressLine1

        public String getBuyerLegalOrganizationAddressLine1()
        EXT:Line One

        The main address line in an address.

        Usually the street name and number or post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne
      • getBuyerLegalOrganizationAddressLine2

        public String getBuyerLegalOrganizationAddressLine2()
        EXT:Line Two

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo
      • getBuyerLegalOrganizationAddressLine3

        public String getBuyerLegalOrganizationAddressLine3()
        EXT:Line Three

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree
      • getBuyerLegalOrganizationCity

        public String getBuyerLegalOrganizationCity()
        EXT:City Name

        The common name of the city, town or village, where the Buyer's address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName
      • getBuyerLegalOrganizationCountryCode

        public Codes.CountryCodeList getBuyerLegalOrganizationCountryCode()
        EXT:Country ID

        A code that identifies the country.

        The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID
      • getBuyerPostCode

        public String getBuyerPostCode()
        BT-53:Buyer post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getBuyerAddressLine1

        public String getBuyerAddressLine1()
        BT-50:Buyer address line 1

        The main address line in an address.

        Usually the street name and number or post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getBuyerAddressLine2

        public String getBuyerAddressLine2()
        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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getBuyerAddressLine3

        public String getBuyerAddressLine3()
        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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getBuyerCity

        public String getBuyerCity()
        BT-52:Buyer city

        The common name of the city, town or village, where the Buyer's address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CityName
      • getBuyerCountryCode

        public Codes.CountryCodeList getBuyerCountryCode()
        BT-55:Buyer country code

        A code that identifies the country.

        The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        BR-11: The Buyer postal address shall contain a Buyer country code (BT-55).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getBuyerElectronicAddressScheme

        public Codes.ElectronicAddressScheme getBuyerElectronicAddressScheme()
        BT-49-1:scheme identifier attribute

        Scheme identifier for Buyer electronic address

        The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getBuyerElectronicAddress

        public Identifier getBuyerElectronicAddress()
        BT-49:Buyer electronic address

        Identifies the Buyer's electronic address to which the invoice is delivered.

        The scheme identifier shall be chosen from a list to be maintained by the Connecting Europe Facility.

        BR-63: The Buyer electronic address (BT-49) shall have a Scheme identifier.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getSalesAgentName

        public String getSalesAgentName()
        EXT:Sales Agent name

        The full name of the Sales Agent

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:Name
      • getRoleCode

        public String getRoleCode()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:RoleCode
      • getSalesAgentLegalOrganizationSchemeIdentiferAttribute

        public String getSalesAgentLegalOrganizationSchemeIdentiferAttribute()
        EXT:schemeID

        Scheme identifier for Sales Agentlegal identifier

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getSalesAgentLegalOrganizationIdentifer

        public String getSalesAgentLegalOrganizationIdentifer()
        EXT:ID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getSalesAgentLegalOrganizationTradingName

        public String getSalesAgentLegalOrganizationTradingName()
        EXT:TradingBusinessName
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getSalesAgentLegalOrganizationPostCode

        public String getSalesAgentLegalOrganizationPostCode()
        EXT:Post code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode
      • getSalesAgentLegalOrganizationAddressLine1

        public String getSalesAgentLegalOrganizationAddressLine1()
        EXT:Address Line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne
      • getSalesAgentLegalOrganizationAddressLine2

        public String getSalesAgentLegalOrganizationAddressLine2()
        EXT:Address Line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo
      • getSalesAgentLegalOrganizationAddressLine3

        public String getSalesAgentLegalOrganizationAddressLine3()
        EXT:Address Line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree
      • getSalesAgentLegalOrganizationCity

        public String getSalesAgentLegalOrganizationCity()
        EXT:City
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName
      • getSalesAgentLegalOrganizationCountryCode

        public Codes.CountryCodeList getSalesAgentLegalOrganizationCountryCode()
        EXT:Country Code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID
      • getSalesAgentPostCode

        public String getSalesAgentPostCode()
        EXT:Sales Agent post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getSalesAgentAddressLine1

        public String getSalesAgentAddressLine1()
        EXT:Sales Agent address line 1

        The main address line in an address.

        Usually the street name and number or the post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getSalesAgentAddressLine2

        public String getSalesAgentAddressLine2()
        EXT:Sales Agent address line 2

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getSalesAgentAddressLine3

        public String getSalesAgentAddressLine3()
        EXT:Sales Agent address line 3

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getSalesAgentCity

        public String getSalesAgentCity()
        EXT:Sales Agent city

        The common name of the city, town or village, where the tax representative address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:PostalTradeAddress/ram:CityName
      • getSalesAgentCountryCode

        public Codes.CountryCodeList getSalesAgentCountryCode()
        EXT:Sales Agent country code

        A code that identifies the country.

        Country where VAT is liable. The lists of valid countries are registered with theEN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getSalesAgentElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getSalesAgentElectronicAddressScheme()
        EXT:schemeID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getSalesAgentElectronicAddress

        public String getSalesAgentElectronicAddress()
        EXT:Sales Agent Electronic Address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SalesAgentTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getBuyerTaxRepresentativeName

        public String getBuyerTaxRepresentativeName()
        EXT:BUYER tax representative name

        The full name of the BUYER's tax representative party.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:Name
      • getBuyerTaxRepresentativeRoleCode

        public String getBuyerTaxRepresentativeRoleCode()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:RoleCode
      • getBuyerTaxRepresentativeLegalOrganizationSchemeIdentiferAttribute

        public String getBuyerTaxRepresentativeLegalOrganizationSchemeIdentiferAttribute()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getBuyerTaxRepresentativeLegalOrganizationIdentifer

        public String getBuyerTaxRepresentativeLegalOrganizationIdentifer()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getBuyerTaxRepresentativeLegalOrganizationTradingName

        public String getBuyerTaxRepresentativeLegalOrganizationTradingName()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getBuyerTaxRepresentativeLegalOrganizationPostCode

        public String getBuyerTaxRepresentativeLegalOrganizationPostCode()
        EXT:Post code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode
      • getBuyerTaxRepresentativeLegalOrganizationAddressLine1

        public String getBuyerTaxRepresentativeLegalOrganizationAddressLine1()
        EXT:Address Line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne
      • getBuyerTaxRepresentativeLegalOrganizationAddressLine2

        public String getBuyerTaxRepresentativeLegalOrganizationAddressLine2()
        EXT:Address Line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo
      • getBuyerTaxRepresentativeLegalOrganizationAddressLine3

        public String getBuyerTaxRepresentativeLegalOrganizationAddressLine3()
        EXT:Address Line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree
      • getBuyerTaxRepresentativeLegalOrganizationCity

        public String getBuyerTaxRepresentativeLegalOrganizationCity()
        EXT:City
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName
      • getBuyerTaxRepresentativeLegalOrganizationCountryCode

        public Codes.CountryCodeList getBuyerTaxRepresentativeLegalOrganizationCountryCode()
        EXT:Country Code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID
      • getBuyerTaxRepresentativePostCode

        public String getBuyerTaxRepresentativePostCode()
        EXT:Tax representative post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getBuyerTaxRepresentativeAddressLine1

        public String getBuyerTaxRepresentativeAddressLine1()
        EXT:Tax representative address line 1

        The main address line in an address.

        Usually the street name and number or the post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getBuyerTaxRepresentativeAddressLine2

        public String getBuyerTaxRepresentativeAddressLine2()
        EXT: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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getBuyerTaxRepresentativeAddressLine3

        public String getBuyerTaxRepresentativeAddressLine3()
        EXT: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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getBuyerTaxRepresentativeCity

        public String getBuyerTaxRepresentativeCity()
        EXT:Tax representative city

        The common name of the city, town or village, where the tax representative address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CityName
      • getBuyerTaxRepresentativeCountryCode

        public Codes.CountryCodeList getBuyerTaxRepresentativeCountryCode()
        EXT:Tax representative country code

        A code that identifies the country.

        Country where VAT is liable. The lists of valid countries are registered with theEN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getBuyerTaxRepresentativeElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getBuyerTaxRepresentativeElectronicAddressScheme()
        EXT:Electronic Address Type
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getBuyerTaxRepresentativeElectronicAddress

        public String getBuyerTaxRepresentativeElectronicAddress()
        EXT:Electronic address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerTaxRepresentativeTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getSellerTaxRepresentativeName

        public String getSellerTaxRepresentativeName()
        BT-62:Seller tax representative name

        The full name of the Seller's tax representative party.

        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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:Name
      • getSellerTaxRepresentativeLegalOrganizationSchemeIdentiferAttribute

        public String getSellerTaxRepresentativeLegalOrganizationSchemeIdentiferAttribute()
        EXT:Scheme identifier attribute
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getSellerTaxRepresentativeLegalOrganizationIdentifer

        public String getSellerTaxRepresentativeLegalOrganizationIdentifer()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getSellerTaxRepresentativeLegalOrganizationTradingName

        public String getSellerTaxRepresentativeLegalOrganizationTradingName()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getSellerTaxRepresentativeLegalOrganizationPostCode

        public String getSellerTaxRepresentativeLegalOrganizationPostCode()
        EXT:Post code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode
      • getSellerTaxRepresentativeLegalOrganizationAddressLine1

        public String getSellerTaxRepresentativeLegalOrganizationAddressLine1()
        EXT:Address Line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne
      • getSellerTaxRepresentativeLegalOrganizationAddressLine2

        public String getSellerTaxRepresentativeLegalOrganizationAddressLine2()
        EXT:Address Line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo
      • getSellerTaxRepresentativeLegalOrganizationAddressLine3

        public String getSellerTaxRepresentativeLegalOrganizationAddressLine3()
        EXT:Address Line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree
      • getSellerTaxRepresentativeLegalOrganizationCity

        public String getSellerTaxRepresentativeLegalOrganizationCity()
        EXT:City
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName
      • getSellerTaxRepresentativeLegalOrganizationCountryCode

        public Codes.CountryCodeList getSellerTaxRepresentativeLegalOrganizationCountryCode()
        EXT:Country Code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID
      • getSellerTaxRepresentativePostCode

        public String getSellerTaxRepresentativePostCode()
        BT-67:Tax representative post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getSellerTaxRepresentativeAddressLine1

        public String getSellerTaxRepresentativeAddressLine1()
        BT-64:Tax representative address line 1

        The main address line in an address.

        Usually the street name and number or the post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getSellerTaxRepresentativeAddressLine2

        public String getSellerTaxRepresentativeAddressLine2()
        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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getSellerTaxRepresentativeAddressLine3

        public String getSellerTaxRepresentativeAddressLine3()
        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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getSellerTaxRepresentativeCity

        public String getSellerTaxRepresentativeCity()
        BT-66:Tax representative city

        The common name of the city, town or village, where the tax representative address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CityName
      • getSellerTaxRepresentativeCountryCode

        public Codes.CountryCodeList getSellerTaxRepresentativeCountryCode()
        BT-69:Tax representative country code

        A code that identifies the country.

        Country where VAT is liable. The lists of valid countries are registered with theEN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getSellerTaxRepresentativeElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getSellerTaxRepresentativeElectronicAddressScheme()
        EXT:Electronic Address Type Scheme identifier attribute
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getSellerTaxRepresentativeElectronicAddress

        public String getSellerTaxRepresentativeElectronicAddress()
        EXT:Electronic address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SellerTaxRepresentativeTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getProductEndUserName

        public String getProductEndUserName()
        EXT:Deviating end user identifier Name / Company Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:Name
      • getProductEndUserLegalOrganizationSchemeIdentiferAttribute

        public String getProductEndUserLegalOrganizationSchemeIdentiferAttribute()
        EXT:Scheme identifier attribute
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getProductEndUserLegalOrganizationIdentifer

        public String getProductEndUserLegalOrganizationIdentifer()
        EXT:Company Registration Number
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getProductEndUserLegalOrganizationTradingName

        public String getProductEndUserLegalOrganizationTradingName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getProductEndUserPostCode

        public String getProductEndUserPostCode()
        EXT:Post Code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getProductEndUserAddressLine1

        public String getProductEndUserAddressLine1()
        EXT:Address Line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getProductEndUserAddressLine2

        public String getProductEndUserAddressLine2()
        EXT:Address Line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getProductEndUserAddressLine3

        public String getProductEndUserAddressLine3()
        EXT:Address Line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getProductEndUserCity

        public String getProductEndUserCity()
        EXT:City
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:CityName
      • getProductEndUserCountryCode

        public Codes.CountryCodeList getProductEndUserCountryCode()
        EXT:Country Code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getProductEndUserElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getProductEndUserElectronicAddressScheme()
        EXT:Electronic Address Type Scheme identifier attribute
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getProductEndUserElectronicAddress

        public String getProductEndUserElectronicAddress()
        EXT:Electronic address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ProductEndUserTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getDeliveryTypeCode

        public String getDeliveryTypeCode()
        EXT:Delivery condition (Code)
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:ApplicableTradeDeliveryTerms/ram:DeliveryTypeCode
      • getBuyerAgentRoleCode

        public String getBuyerAgentRoleCode()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:RoleCode
      • getBuyerAgentLegalOrganizationSchemeIdentiferAttribute

        public String getBuyerAgentLegalOrganizationSchemeIdentiferAttribute()
        EXT:schemeID

        Scheme identifier for BUYER Agentlegal identifier

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getBuyerAgentLegalOrganizationIdentifer

        public String getBuyerAgentLegalOrganizationIdentifer()
        EXT:ID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getBuyerAgentLegalOrganizationTradingName

        public String getBuyerAgentLegalOrganizationTradingName()
        EXT:TradingBusinessName
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getBuyerAgentLegalOrganizationPostCode

        public String getBuyerAgentLegalOrganizationPostCode()
        EXT:Post code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:PostcodeCode
      • getBuyerAgentLegalOrganizationAddressLine1

        public String getBuyerAgentLegalOrganizationAddressLine1()
        EXT:Address Line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineOne
      • getBuyerAgentLegalOrganizationAddressLine2

        public String getBuyerAgentLegalOrganizationAddressLine2()
        EXT:Address Line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineTwo
      • getBuyerAgentLegalOrganizationAddressLine3

        public String getBuyerAgentLegalOrganizationAddressLine3()
        EXT:Address Line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:LineThree
      • getBuyerAgentLegalOrganizationCity

        public String getBuyerAgentLegalOrganizationCity()
        EXT:City
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CityName
      • getBuyerAgentLegalOrganizationCountryCode

        public Codes.CountryCodeList getBuyerAgentLegalOrganizationCountryCode()
        EXT:Country Code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:SpecifiedLegalOrganization/ram:PostalTradeAddress/ram:CountryID
      • getBuyerAgentPostCode

        public String getBuyerAgentPostCode()
        EXT:Buyer Agent post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getBuyerAgentAddressLine1

        public String getBuyerAgentAddressLine1()
        EXT:Buyer Agent address line 1

        The main address line in an address.

        Usually the street name and number or the post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getBuyerAgentAddressLine2

        public String getBuyerAgentAddressLine2()
        EXT:Buyer Agent address line 2

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getBuyerAgentAddressLine3

        public String getBuyerAgentAddressLine3()
        EXT:Buyer Agent address line 3

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getBuyerAgentCity

        public String getBuyerAgentCity()
        EXT:Buyer Agent city

        The common name of the city, town or village, where the tax representative address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:CityName
      • getBuyerAgentCountryCode

        public Codes.CountryCodeList getBuyerAgentCountryCode()
        EXT:Buyer Agent country code

        A code that identifies the country.

        Country where VAT is liable. The lists of valid countries are registered with theEN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getBuyerAgentElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getBuyerAgentElectronicAddressScheme()
        EXT:schemeID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getBuyerAgentElectronicAddress

        public String getBuyerAgentElectronicAddress()
        EXT:Buyer Agent Electronic Address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:BuyerAgentTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getProjectReference

        public DocumentReference getProjectReference()
        BT-11:Project reference

        The identification of the project the invoice refers to

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:ID
      • getProjectName

        public String getProjectName()
        BT-11-0:Project name

        Value : "Project Reference"

        Use "Project reference" as default value for Name.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeAgreement/ram:SpecifiedProcuringProject/ram:Name
      • getDeliverToName

        public String getDeliverToName()
        BT-70:Deliver to party name

        The name of the party to which the goods and services are delivered.

        Shall be used if the Deliver to party is different from the Buyer.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:Name
      • getDeliverToLegalOrganizationSchemeIdentiferAttribute

        public String getDeliverToLegalOrganizationSchemeIdentiferAttribute()
        EXT:Scheme identifier attribute
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getDeliverToLegalOrganizationIdentifer

        public String getDeliverToLegalOrganizationIdentifer()
        EXT:Company Registration Number
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getDeliverToLegalOrganizationTradingName

        public String getDeliverToLegalOrganizationTradingName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getDeliverToPostCode

        public String getDeliverToPostCode()
        BT-78:Deliver to post code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getDeliverToAddressLine1

        public String getDeliverToAddressLine1()
        BT-75:Deliver to address line 1

        The main address line in an address.

        Usually the street name and number.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getDeliverToAddressLine2

        public String getDeliverToAddressLine2()
        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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getDeliverToAddressLine3

        public String getDeliverToAddressLine3()
        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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getDeliverToCity

        public String getDeliverToCity()
        BT-77:Deliver to city

        The common name of the city, town or village, where the deliver to address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CityName
      • getDeliverToCountryCode

        public Codes.CountryCodeList getDeliverToCountryCode()
        BT-80:Deliver to country code

        A code that identifies the country.

        The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        BR-57: Each Deliver to address (BG-15) shall contain a Deliver to country code (BT-80).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getDeliverToElectronicAddressScheme

        public Codes.ElectronicAddressScheme getDeliverToElectronicAddressScheme()
        EXT:Electronic Address Type Electronic Address Type
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getDeliverToElectronicAddress

        public String getDeliverToElectronicAddress()
        EXT:Electronic address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getUltimateShipToName

        public String getUltimateShipToName()
        EXT:Final Recipient Name / Company Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:Name
      • getUltimateShipToLegalOrganizationSchemeIdentiferAttribute

        public String getUltimateShipToLegalOrganizationSchemeIdentiferAttribute()
        EXT:Scheme identifier attribute
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getUltimateShipToLegalOrganizationIdentifer

        public String getUltimateShipToLegalOrganizationIdentifer()
        EXT:Company Registration Number
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getUltimateShipToLegalOrganizationTradingName

        public String getUltimateShipToLegalOrganizationTradingName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getUltimateShipToPostCode

        public String getUltimateShipToPostCode()
        EXT:Final recipient post code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getUltimateShipToAddressLine1

        public String getUltimateShipToAddressLine1()
        EXT:Final recipient address line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getUltimateShipToAddressLine2

        public String getUltimateShipToAddressLine2()
        EXT:Final recipient address line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getUltimateShipToAddressLine3

        public String getUltimateShipToAddressLine3()
        EXT:Final recipient address line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getUltimateShipToCity

        public String getUltimateShipToCity()
        EXT:Final recipient city
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CityName
      • getUltimateShipToCountryCode

        public Codes.CountryCodeList getUltimateShipToCountryCode()
        EXT:Final recipient country (Code)
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getUltimateShipToElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getUltimateShipToElectronicAddressScheme()
        EXT:Electronic Address Type Electronic address type
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getUltimateShipToElectronicAddress

        public String getUltimateShipToElectronicAddress()
        EXT:Electronic address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getShipFromName

        public String getShipFromName()
        EXT:Deviating sender name / company name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:Name
      • getShipFromLegalOrganizationSchemeIdentiferAttribute

        public String getShipFromLegalOrganizationSchemeIdentiferAttribute()
        EXT:Scheme identifier attribute
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getShipFromLegalOrganizationIdentifer

        public String getShipFromLegalOrganizationIdentifer()
        EXT:Company Registration Number
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getShipFromLegalOrganizationTradingName

        public String getShipFromLegalOrganizationTradingName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getShipFromPostCode

        public String getShipFromPostCode()
        EXT:Sender post code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getShipFromAddressLine1

        public String getShipFromAddressLine1()
        EXT:Sender address line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getShipFromAddressLine2

        public String getShipFromAddressLine2()
        EXT:Sender address line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getShipFromAddressLine3

        public String getShipFromAddressLine3()
        EXT:Sender address line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getShipFromCity

        public String getShipFromCity()
        EXT:Sender city
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:CityName
      • getShipFromCountryCode

        public Codes.CountryCodeList getShipFromCountryCode()
        EXT:Sender country (Code)
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getShipFromElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getShipFromElectronicAddressScheme()
        EXT:Electronic Address Type Electronic address type
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getShipFromElectronicAddress

        public String getShipFromElectronicAddress()
        EXT:Electronic address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ShipFromTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getActualDeliveryDateFormat

        public Codes.DateFormat getActualDeliveryDateFormat()
                                                     throws ComputationException
        BT-72-0:Date format

        Value = 102

        Only value "102"

        Returns:
        a computed value unless an explicit value has been set and setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getActualDeliveryDate

        public LocalDate getActualDeliveryDate()
        BT-72:Actual delivery date

        the date on which the supply of goods or services was made or completed.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString
      • getBankAssignedCreditorIdentifier

        public Identifier getBankAssignedCreditorIdentifier()
        BT-90:Bank assigned creditor identifier

        Unique banking reference identifier of the Payee or Seller assigned by the Payee or Seller bank.

        Used in order to pre-notify the Buyer of a SEPA direct debit.

        This is the ICS for SEPA direct debits

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:CreditorReferenceID
      • getRemittanceInformation

        public String getRemittanceInformation()
        BT-83:Remittance information

        A textual value used to establish a link between the payment and the Invoice, issued by the Seller.

        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. Reference section 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.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PaymentReference
      • getVATAccountingCurrencyCode

        public Codes.Currency getVATAccountingCurrencyCode()
        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.

        Shall be used in combination with the Invoice 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.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxCurrencyCode
      • getInvoiceCurrencyCode

        public Codes.Currency getInvoiceCurrencyCode()
        BT-5:Invoice currency code

        The 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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceCurrencyCode
      • getSellerReferenceNumber

        public String getSellerReferenceNumber()
        EXT:Seller reference number
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceIssuerReference
      • getInvoicerName

        public String getInvoicerName()
        EXT:Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:Name
      • getInvoicerLegalOrganizationSchemeIdentiferAttribute

        public String getInvoicerLegalOrganizationSchemeIdentiferAttribute()
        EXT:schemeID

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getInvoicerLegalOrganizationIdentifer

        public String getInvoicerLegalOrganizationIdentifer()
        EXT:ID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getInvoicerLegalOrganizationTradingName

        public String getInvoicerLegalOrganizationTradingName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getInvoicerPostCode

        public String getInvoicerPostCode()
        EXT:Postcode Code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getInvoicerAddressLine1

        public String getInvoicerAddressLine1()
        EXT:Line One

        The main address line in an address.

        Usually the street name and number or post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getInvoicerAddressLine2

        public String getInvoicerAddressLine2()
        EXT:Line Two

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getInvoicerAddressLine3

        public String getInvoicerAddressLine3()
        EXT:Line Three

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getInvoicerCity

        public String getInvoicerCity()
        EXT:City Name

        The common name of the city, town or village, where the Seller address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:CityName
      • getInvoicerCountryCode

        public Codes.CountryCodeList getInvoicerCountryCode()
        EXT:Country ID

        A code that identifies the country.

        If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getInvoicerElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getInvoicerElectronicAddressScheme()
        EXT:schemeID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getInvoicerElectronicAddress

        public String getInvoicerElectronicAddress()
        EXT:URIID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoicerTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getInvoiceeName

        public String getInvoiceeName()
        EXT:Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:Name
      • getInvoiceeLegalOrganizationSchemeIdentiferAttribute

        public String getInvoiceeLegalOrganizationSchemeIdentiferAttribute()
        EXT:schemeID

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getInvoiceeLegalOrganizationIdentifer

        public String getInvoiceeLegalOrganizationIdentifer()
        EXT:ID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getInvoiceeLegalOrganizationTradingName

        public String getInvoiceeLegalOrganizationTradingName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getInvoiceePostCode

        public String getInvoiceePostCode()
        EXT:Postcode Code

        The identifier for an addressable group of properties according to the relevant postal service.

        Such as a ZIP code or a post code.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getInvoiceeAddressLine1

        public String getInvoiceeAddressLine1()
        EXT:Line One

        The main address line in an address.

        Usually the street name and number or post office box.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getInvoiceeAddressLine2

        public String getInvoiceeAddressLine2()
        EXT:Line Two

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getInvoiceeAddressLine3

        public String getInvoiceeAddressLine3()
        EXT:Line Three

        An additional address line in an address that can be used to give further details supplementing the main line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getInvoiceeCity

        public String getInvoiceeCity()
        EXT:City Name

        The common name of the city, town or village, where the Seller address is located.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:CityName
      • getInvoiceeCountryCode

        public Codes.CountryCodeList getInvoiceeCountryCode()
        EXT:Country ID

        A code that identifies the country.

        If no tax representative is specified, this is the country where VAT is liable. The lists of valid countries are registered with the EN ISO 3166-1 Maintenance agency, “Codes for the representation of names of countries and their subdivisions”.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getInvoiceeElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getInvoiceeElectronicAddressScheme()
        EXT:schemeID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getInvoiceeElectronicAddress

        public String getInvoiceeElectronicAddress()
        EXT:URIID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:InvoiceeTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getPayeeName

        public String getPayeeName()
        BT-59:Payee name

        The name of the Payee.

        Shall be used when the Payee is different from the Seller. The Payee name may however be the same as the Seller name.

        If the PAYEE party bock is present, the name of the Payee is mandatory

        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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:Name
      • getPayeeLegalOrganizationSchemeIdentiferAttribute

        public Codes.SchemeIdentifier getPayeeLegalOrganizationSchemeIdentiferAttribute()
        BT-61-1:Scheme identifier

        The identification scheme identifier of the Payee legal registration identifier.

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getPayeeLegalOrganizationIdentifer

        public Identifier getPayeeLegalOrganizationIdentifer()
        BT-61:Payee legal registration identifierScheme identifier

        An identifier issued by an official registrar that identifies the Payee as a legal entity or person.The identification scheme identifier of the Payee legal registration identifier.

        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.If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getPayeeLegalOrganizationTradingName

        public String getPayeeLegalOrganizationTradingName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getPayeePostCode

        public String getPayeePostCode()
        EXT:Payee post code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getPayeeAddressLine1

        public String getPayeeAddressLine1()
        EXT:Payee address line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getPayeeAddressLine2

        public String getPayeeAddressLine2()
        EXT:Payee address line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getPayeeAddressLine3

        public String getPayeeAddressLine3()
        EXT:Payee address line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getPayeeCity

        public String getPayeeCity()
        EXT:Payee city
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CityName
      • getPayeeCountryCode

        public Codes.CountryCodeList getPayeeCountryCode()
        EXT:Payee country (Code)
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getPayeeElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getPayeeElectronicAddressScheme()
        EXT:schemeID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getPayeeElectronicAddress

        public String getPayeeElectronicAddress()
        EXT:URIID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayeeTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getPayerName

        public String getPayerName()
        EXT:Payer name

        The name of the Payer.

        Shall be used when the Payee is different from the Seller. The Payee name may however be the same as the Seller name.

        If the PAYEE party bock is present, the name of the Payee is mandatory

        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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:Name
      • getPayerRoleCode

        public String getPayerRoleCode()
        EXT:Payer Role Code

        A code specifying the role of this trade party.

        To be chosen from the entries in UNCL 3035, for instance :AB : Buyer Agent / representativeMOP : Market operator

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:RoleCode
      • getPayerLegalOrganizationSchemeIdentiferAttribute

        public String getPayerLegalOrganizationSchemeIdentiferAttribute()
        EXT:Scheme identifier

        The identification scheme identifier of the Payer legal registration identifier.

        If used, the identification scheme identifier shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        For a SIREN or a SIRET, the value of this field is "0002"

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getPayerLegalOrganizationIdentifer

        public Identifier getPayerLegalOrganizationIdentifer()
        EXT:Payer legal registration identifierScheme identifier

        An identifier issued by an official registrar that identifies the Payer as a legal entity or person.The identification scheme identifier of the Payer legal registration identifier.

        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.If used, the identification scheme shall be chosen from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getPayerLegalOrganizationTradingName

        public String getPayerLegalOrganizationTradingName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getPayerPostCode

        public String getPayerPostCode()
        EXT:Post code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getPayerAddressLine1

        public String getPayerAddressLine1()
        EXT:Address Line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getPayerAddressLine2

        public String getPayerAddressLine2()
        EXT:Address Line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getPayerAddressLine3

        public String getPayerAddressLine3()
        EXT:Address Line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getPayerCity

        public String getPayerCity()
        EXT:City
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:CityName
      • getPayerCountryCode

        public Codes.CountryCodeList getPayerCountryCode()
        EXT:Country Code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getPayerElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getPayerElectronicAddressScheme()
        EXT:schemeID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getPayerElectronicAddress

        public String getPayerElectronicAddress()
        EXT:URIID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:PayerTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getSourceCurrencyCode

        public Codes.Currency getSourceCurrencyCode()
        EXT:Source Currency Code

        The code specifying the source currency of a trade related currency conversion.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:SourceCurrencyCode
      • getTargetCurrencyCode

        public Codes.Currency getTargetCurrencyCode()
        EXT:Target Currency Code

        The code specifying the target currency of a trade related currency conversion.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:TargetCurrencyCode
      • getConversionRate

        public Decimal getConversionRate()
        EXT:Conversion Rate

        The rate factor used for conversion from the source currency to the target currency for trade purposes.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:ConversionRate
      • getConversionRateDateTimeFormat

        public Codes.DateFormat getConversionRateDateTimeFormat()
                                                         throws ComputationException
        EXT:Date format
        Returns:
        a computed value unless an explicit value has been set and setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:ConversionRateDateTime/udt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getConversionRateDateTime

        public String getConversionRateDateTime()
        EXT:Exchange rate date, value
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:TaxApplicableTradeCurrencyExchange/ram:ConversionRateDateTime/udt:DateTimeString
      • getDescription

        public String getDescription()
        EXT:Description
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:Description
      • getInvoicingPeriodStartDateFormat

        public Codes.DateFormat getInvoicingPeriodStartDateFormat()
                                                           throws ComputationException
        BT-73-0:Date format

        Value = 102

        Only value "102"

        Returns:
        a computed value unless an explicit value has been set and setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getInvoicingPeriodStartDate

        public LocalDate getInvoicingPeriodStartDate()
        BT-73:Invoicing period start date

        The date when the Invoice period starts.

        The initial date of delivery of goods or services.

        This date must be less than or equal to the period end date (BT-74), if it exists

        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.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString
      • getInvoicingPeriodEndDateFormat

        public Codes.DateFormat getInvoicingPeriodEndDateFormat()
                                                         throws ComputationException
        BT-74-0:Date format

        Value = 102

        Only value "102"

        Returns:
        a computed value unless an explicit value has been set and setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getInvoicingPeriodEndDate

        public LocalDate getInvoicingPeriodEndDate()
        BT-74:Invoicing period end date

        The date when the Invoice period ends.

        The date on which the delivery of goods or services was completed.

        This date must be greater than or equal to the period start date (BT-73), if it exists

        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.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString
      • getSumOfInvoiceLineNetAmount

        public Amount getSumOfInvoiceLineNetAmount()
                                            throws ComputationException
        BT-106:Sum of Invoice line net amount

        Sum of all Invoice line net amounts in the Invoice.

        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).

        Returns:
        a computed value unless an explicit value has been set and setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:LineTotalAmount is returned
        Throws:
        ComputationException
      • getSumOfChargesOnDocumentLevel

        public Amount getSumOfChargesOnDocumentLevel()
        BT-108:Sum of charges on document level

        Sum of all charges on document level in the Invoice.

        Charges on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.

        BR-CO-12: Sum of charges on document level (BT-108) = ? Document level charge amount (BT-99).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:ChargeTotalAmount
      • getSumOfAllowancesOnDocumentLevel

        public Amount getSumOfAllowancesOnDocumentLevel()
        BT-107:Sum of allowances on document level

        Sum of all allowances on document level in the Invoice.

        Allowances on line level are included in the Invoice line net amount which is summed up into the Sum of Invoice line net amount.

        BR-CO-11: Sum of allowances on document level (BT-107) = ? Document level allowance amount (BT-92).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:AllowanceTotalAmount
      • getRoundingAmount

        public Amount getRoundingAmount()
        BT-114:Rounding amount

        The amount to be added to the invoice total to round the amount to be paid.

        This mechanism is not applied in France.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:RoundingAmount
      • getPaidAmount

        public Amount getPaidAmount()
        BT-113:Paid amount

        The sum of amounts which have been paid in advance.

        This amount is subtracted from the invoice total amount with VAT to calculate the amount due for payment.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:TotalPrepaidAmount
      • getAmountDueForPayment

        public Amount getAmountDueForPayment()
                                      throws ComputationException
        BT-115:Amount due for payment

        The outstanding amount that is requested to be paid.

        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.

        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).

        Returns:
        a computed value unless an explicit value has been set and setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:ApplicableHeaderTradeSettlement/ram:SpecifiedTradeSettlementHeaderMonetarySummation/ram:DuePayableAmount is returned
        Throws:
        ComputationException
      • toXML

        public void toXML​(PrintStream out)
                   throws IOException,
                          FacturXException
        Serializes to a Factur-X XML document that matches the profile specific XML Schema from the specification (in this version the file _Factur-X 1.0.06 2022 03 01 - FINAL EN/4. FACTUR-X_1.0.06_XSD_SCHEMATRON - 2022 03 01/4. Factur-X_1.0.06_EXTENDED_XSD/FACTUR-X_EXTENDED.xsd)
        Parameters:
        out - the print stream to write to
        Throws:
        IOException
        FacturXException
      • toXML

        public void toXML​(PrintWriter out)
                   throws IOException,
                          FacturXException
        Serializes to a Factur-X XML document that matches the profile specific XML Schema from the specification (in this version the file _Factur-X 1.0.06 2022 03 01 - FINAL EN/4. FACTUR-X_1.0.06_XSD_SCHEMATRON - 2022 03 01/4. Factur-X_1.0.06_EXTENDED_XSD/FACTUR-X_EXTENDED.xsd)
        Parameters:
        out - the print stream to write to
        Throws:
        IOException
        FacturXException
      • toJUnitJavaSourceCode

        public void toJUnitJavaSourceCode​(PrintStream out,
                                          String packageName,
                                          String className,
                                          String referenceFilesDirectory)
                                   throws FacturXException
        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.
        Parameters:
        out - the print stream to write to
        packageName - the package name to use in the package declaration
        className - the name to use as class name for the test class
        referenceFilesDirectory - the directory in which the test expects the reference output xml file that is named className+".xml"
        Throws:
        FacturXException
      • joinVeryLongString

        public static String joinVeryLongString​(String[] chunks)
        to be used for strings exceeding the compiler limit of 2^16 bytes for a string constant
      • fromXML

        public static Invoice fromXML​(String fileName,
                                      boolean recompute)
                               throws IOException
        Creates and Invoice instance from a Factur-X XML document.
        Parameters:
        fileName - the Factur-X XML file to read from
        recompute - specifies whether or not computed fields are computed or the values from the file are used instead
        Throws:
        IOException