Class InvoiceLine


  • public class InvoiceLine
    extends Object
    BG-25:INVOICE LINE

    A group of business terms providing information on individual Invoice lines.

    BR-16: An Invoice shall have at least one Invoice line (BG-25).

    XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem

    • Method Detail

      • appendNewInvoiceLineNote

        public InvoiceLineNote appendNewInvoiceLineNote()
        Creates an InvoiceLineNote object and appends it to the list obtainable by a call to get getInvoiceLineNotes()
        Returns:
        InvoiceLineNote
      • appendNewItemAttributes

        public ItemAttributes appendNewItemAttributes()
        Creates an ItemAttributes object and appends it to the list obtainable by a call to get getItemAttributes()
        Returns:
        ItemAttributes
      • appendNewLineDeliverToIdentifier

        public LineDeliverToIdentifier appendNewLineDeliverToIdentifier()
        Creates a LineDeliverToIdentifier object and appends it to the list obtainable by a call to get getLineDeliverToIdentifiers()
        Returns:
        LineDeliverToIdentifier
      • appendNewLineDeliverTo

        public LineDeliverTo appendNewLineDeliverTo()
        Creates a LineDeliverTo object and appends it to the list obtainable by a call to get getLineDeliverTos()
        Returns:
        LineDeliverTo
      • appendNewCountrySubdivision

        public CountrySubdivision appendNewCountrySubdivision()
        Creates a CountrySubdivision object and appends it to the list obtainable by a call to get getCountrySubdivisions()
        Returns:
        CountrySubdivision
      • appendNewLineVATInformation

        public LineVATInformation appendNewLineVATInformation​(Codes.VATCategoryCode invoicedItemVATCategoryCode)
        Creates a LineVATInformation object and appends it to the list obtainable by a call to get getLineVATInformationList()
        Parameters:
        invoicedItemVATCategoryCode - BT-151:Invoiced item VAT category code

        The VAT category code for the invoiced item.

        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-CO-4: Each Invoice line (BG-25) shall be categorized with an Invoiced item VAT category code (BT-151).

        Returns:
        LineVATInformation
      • appendNewInvoiceLineAllowances

        public InvoiceLineAllowances appendNewInvoiceLineAllowances()
        Creates an InvoiceLineAllowances object and appends it to the list obtainable by a call to get getInvoiceLineAllowances()
        Returns:
        InvoiceLineAllowances
      • setInvoiceLineIdentifier

        public InvoiceLine setInvoiceLineIdentifier​(Identifier value)
        Parameters:
        value - 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).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineID

        Returns:
        InvoiceLine
      • setLineStatusCode

        public InvoiceLine setLineStatusCode​(LineStatusCodeContentType value)
        Parameters:
        value - EXT:LineStatusCode

        The code specifying the status of this document line.

        Codelist UNTDID 1229

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineStatusCode

        Returns:
        InvoiceLine
      • setLineStatusReasonCode

        public InvoiceLine setLineStatusReasonCode​(String value)
        Parameters:
        value - EXT:LineStatusReasonCode

        The code specifying the line status reason for this document line.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineStatusReasonCode

        Returns:
        InvoiceLine
      • setSchemeIdentifierForItemStandardIdentifier

        public InvoiceLine setSchemeIdentifierForItemStandardIdentifier​(Codes.SchemeIdentifier value)
        Parameters:
        value - BT-157-1:Scheme identifier for Item standard identifier

        Identifiant du schéma de l'identifiant standard de l'article

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

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID/@schemeID

        Returns:
        InvoiceLine
      • setItemStandardIdentifier

        public InvoiceLine setItemStandardIdentifier​(Identifier value)
        Parameters:
        value - BT-157:Item standard identifier

        An item identifier based on a registered scheme.The identification scheme identifier of the Item standard identifier

        The identification scheme shall be identified from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        CHORUSPRO: this field is limited to 40 characters

        BR-64: The Item standard identifier (BT-157) shall have a Scheme identifier

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID

        Returns:
        InvoiceLine
      • setSellerAssignedID

        public InvoiceLine setSellerAssignedID​(Identifier value)
        Parameters:
        value - BT-155:Item Seller's identifier

        An identifier, assigned by the Seller, for the item.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:SellerAssignedID

        Returns:
        InvoiceLine
      • setBuyerAssignedID

        public InvoiceLine setBuyerAssignedID​(Identifier value)
        Parameters:
        value - BT-156:Item Buyer's identifier

        An identifier, assigned by the Buyer, for the item.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:BuyerAssignedID

        Returns:
        InvoiceLine
      • setItemName

        public InvoiceLine setItemName​(String value)
        Parameters:
        value - BT-153:Item name

        A name for an item.

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

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Name

        Returns:
        InvoiceLine
      • setItemDescription

        public InvoiceLine setItemDescription​(String value)
        Parameters:
        value - BT-154:Item description

        A description for an item.

        The Item description allows for describing the item and its features in more detail than the Item name.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Description

        Returns:
        InvoiceLine
      • setItemCountryOfOrigin

        public InvoiceLine setItemCountryOfOrigin​(Codes.CountryCodeList value)
        Parameters:
        value - BT-159:Item country of origin

        The code identifying the country from which the item originates.

        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:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:OriginTradeCountry/ram:ID

        Returns:
        InvoiceLine
      • setItemGrossPrice

        public InvoiceLine setItemGrossPrice​(UnitPriceAmount value)
        Parameters:
        value - BT-148:Item gross price

        The unit price, exclusive of VAT, before subtracting Item price discount.

        The Item gross price MUST NOT be negative

        BR-28: The Item gross price (BT-148) shall NOT be negative.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:ChargeAmount Passing a null value causes getItemGrossPrice() to return a computed value

        Returns:
        InvoiceLine
      • setGrossItemPriceBaseQuantityUnitOfMeasureCode

        public InvoiceLine setGrossItemPriceBaseQuantityUnitOfMeasureCode​(Codes.UnitOfMeasure value)
        Parameters:
        value - BT-150-1:Item price base quantity unit of measure code

        The unit of measure that applies to the Item price base quantity.

        The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).

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

        Must be the same than BT-150 for Net Price

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:BasisQuantity/@unitCode

        Returns:
        InvoiceLine
      • setGrossItemPriceBaseQuantity

        public InvoiceLine setGrossItemPriceBaseQuantity​(Quantity value)
        Parameters:
        value - BT-149-1:Item price base quantity

        The number of item units to which the price applies.

        To fill if BT-149 is present and if BT-148 is present, with the same value than BT-149

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:BasisQuantity

        Returns:
        InvoiceLine
      • setItemNetPrice

        public InvoiceLine setItemNetPrice​(UnitPriceAmount value)
        Parameters:
        value - BT-146:Item net price

        The price of an item, exclusive of VAT, after subtracting item price discount.

        The Item net price has to be equal with the Item gross price less the Item price discount.

        The Item net price MUST NOT be negative

        BR-26: Each Invoice line (BG-25) shall contain the Item net price (BT-146).BR-27: The Item net price (BT-146) shall NOT be negative.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:ChargeAmount Passing a null value causes getItemNetPrice() to return a computed value

        Returns:
        InvoiceLine
      • setNetItemPriceBaseQuantityUnitOfMeasureCode

        public InvoiceLine setNetItemPriceBaseQuantityUnitOfMeasureCode​(Codes.UnitOfMeasure value)
        Parameters:
        value - BT-150:Item price base quantity unit of measure code

        The unit of measure that applies to the Item price base quantity.

        The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).

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

        Must be equal to the value of BT-130 and BT-150-1 if it exists

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity/@unitCode

        Returns:
        InvoiceLine
      • setNetItemPriceBaseQuantity

        public InvoiceLine setNetItemPriceBaseQuantity​(Quantity value)
        Parameters:
        value - BT-149:Item price base quantity

        The number of item units to which the price applies.

        Optional, if filled and if BT-148 is present (EN16931 and EXTENDED profiles), then it should be the same value than BT-149-1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity

        Returns:
        InvoiceLine
      • setIncludedTaxForB2CCalculatedAmount

        public InvoiceLine setIncludedTaxForB2CCalculatedAmount​(UnitPriceAmount value)
        Parameters:
        value - EXT:Included tax for B2C

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CalculatedAmount

        Returns:
        InvoiceLine
      • setIncludedTaxForB2CTypeCode

        public InvoiceLine setIncludedTaxForB2CTypeCode​(String value)
        Parameters:
        value - EXT:Included tax for B2C

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:TypeCode

        Returns:
        InvoiceLine
      • setIncludedTaxForB2CExcemptionReason

        public InvoiceLine setIncludedTaxForB2CExcemptionReason​(String value)
        Parameters:
        value - EXT:Included tax for B2C

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReason

        Returns:
        InvoiceLine
      • setIncludedTaxForB2CCategoryCode

        public InvoiceLine setIncludedTaxForB2CCategoryCode​(String value)
        Parameters:
        value - EXT:Included tax for B2C

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CategoryCode

        Returns:
        InvoiceLine
      • setVATExemptionReasonCode

        public InvoiceLine setVATExemptionReasonCode​(Codes.VATExemptionReasonCode value)
        Parameters:
        value - EXT:VAT exemption reason code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReasonCode

        Returns:
        InvoiceLine
      • setIncludedTaxForB2CApplicablePercent

        public InvoiceLine setIncludedTaxForB2CApplicablePercent​(Percentage value)
        Parameters:
        value - EXT:Included tax for B2C

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:RateApplicablePercent

        Returns:
        InvoiceLine
      • setInvoicedQuantityUnitOfMeasureCode

        public InvoiceLine setInvoicedQuantityUnitOfMeasureCode​(Codes.UnitOfMeasure value)
        Parameters:
        value - 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).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity/@unitCode

        Returns:
        InvoiceLine
      • setInvoicedQuantity

        public InvoiceLine setInvoicedQuantity​(Quantity value)
        Parameters:
        value - 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).

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity

        Returns:
        InvoiceLine
      • setChargeFreeQuantityMeasurementUnit

        public InvoiceLine setChargeFreeQuantityMeasurementUnit​(Codes.UnitOfMeasure value)
        Parameters:
        value - EXT:Measurement unit

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity/@unitCode

        Returns:
        InvoiceLine
      • setChargeFreeQuantity

        public InvoiceLine setChargeFreeQuantity​(Quantity value)
        Parameters:
        value - EXT:Amount, without charge

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity

        Returns:
        InvoiceLine
      • setPackageQuantityMeasurementUnit

        public InvoiceLine setPackageQuantityMeasurementUnit​(Codes.UnitOfMeasure value)
        Parameters:
        value - EXT:Measurement unit

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity/@unitCode

        Returns:
        InvoiceLine
      • setPackageQuantity

        public InvoiceLine setPackageQuantity​(Quantity value)
        Parameters:
        value - EXT:Package quantity

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity

        Returns:
        InvoiceLine
      • setLineDeliverToName

        public InvoiceLine setLineDeliverToName​(String value)
        Parameters:
        value - EXT:SHIP TO Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:Name

        Returns:
        InvoiceLine
      • setLineDeliverToLegalOrganizationSchemeIdentiferAttribute

        public InvoiceLine setLineDeliverToLegalOrganizationSchemeIdentiferAttribute​(String value)
        Parameters:
        value - EXT:Scheme identifier attribute

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

        Returns:
        InvoiceLine
      • setLineDeliverToLegalOrganizationIdentifer

        public InvoiceLine setLineDeliverToLegalOrganizationIdentifer​(String value)
        Parameters:
        value - EXT:Company Registration Number

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        InvoiceLine
      • setLineDeliverToLegalOrganizationTradingName

        public InvoiceLine setLineDeliverToLegalOrganizationTradingName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        InvoiceLine
      • setLineDeliverToPostCode

        public InvoiceLine setLineDeliverToPostCode​(String value)
        Parameters:
        value - EXT:PostcodeCode

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        InvoiceLine
      • setLineDeliverToAddressLine1

        public InvoiceLine setLineDeliverToAddressLine1​(String value)
        Parameters:
        value - EXT:LineOne

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        InvoiceLine
      • setLineDeliverToAddressLine2

        public InvoiceLine setLineDeliverToAddressLine2​(String value)
        Parameters:
        value - EXT:LineTwo

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        InvoiceLine
      • setLineDeliverToAddressLine3

        public InvoiceLine setLineDeliverToAddressLine3​(String value)
        Parameters:
        value - EXT:LineThree

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        InvoiceLine
      • setLineDeliverToCity

        public InvoiceLine setLineDeliverToCity​(String value)
        Parameters:
        value - EXT:CityName

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        InvoiceLine
      • setLineDeliverToCountryCode

        public InvoiceLine setLineDeliverToCountryCode​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:CountryID

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        InvoiceLine
      • setLineDeliverToElectronicAddressScheme

        public InvoiceLine setLineDeliverToElectronicAddressScheme​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:Electronic Address Type

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

        Returns:
        InvoiceLine
      • setLineDeliverToElectronicAddress

        public InvoiceLine setLineDeliverToElectronicAddress​(String value)
        Parameters:
        value - EXT:Electronic address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        InvoiceLine
      • setName

        public InvoiceLine setName​(String value)
        Parameters:
        value - EXT:Final Recipient Name / Company Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:Name

        Returns:
        InvoiceLine
      • setSchemeIdentifierAttribute

        public InvoiceLine setSchemeIdentifierAttribute​(String value)
        Parameters:
        value - EXT:Scheme identifier attribute

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

        Returns:
        InvoiceLine
      • setCompanyRegistrationNumber

        public InvoiceLine setCompanyRegistrationNumber​(String value)
        Parameters:
        value - EXT:Company Registration Number

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID

        Returns:
        InvoiceLine
      • setTradingBusinessName

        public InvoiceLine setTradingBusinessName​(String value)
        Parameters:
        value - EXT:Trading Business Name

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName

        Returns:
        InvoiceLine
      • setPostCode

        public InvoiceLine setPostCode​(String value)
        Parameters:
        value - EXT:Post Code

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode

        Returns:
        InvoiceLine
      • setAddressLine1

        public InvoiceLine setAddressLine1​(String value)
        Parameters:
        value - EXT:Address Line 1

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineOne

        Returns:
        InvoiceLine
      • setAddressLine2

        public InvoiceLine setAddressLine2​(String value)
        Parameters:
        value - EXT:Address Line 2

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo

        Returns:
        InvoiceLine
      • setAddressLine3

        public InvoiceLine setAddressLine3​(String value)
        Parameters:
        value - EXT:Address Line 3

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineThree

        Returns:
        InvoiceLine
      • setCity

        public InvoiceLine setCity​(String value)
        Parameters:
        value - EXT:City

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CityName

        Returns:
        InvoiceLine
      • setCountryID

        public InvoiceLine setCountryID​(Codes.CountryCodeList value)
        Parameters:
        value - EXT:Country (Code)

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CountryID

        Returns:
        InvoiceLine
      • setElectronicAddressTypeTypeOfElectronicAddress

        public InvoiceLine setElectronicAddressTypeTypeOfElectronicAddress​(Codes.SchemeIdentifierAttribute value)
        Parameters:
        value - EXT:Electronic Address Type Type of electronic address

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

        Returns:
        InvoiceLine
      • setElectronicAddressElectronicAddress

        public InvoiceLine setElectronicAddressElectronicAddress​(String value)
        Parameters:
        value - EXT:Electronic address Electronic Address

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID

        Returns:
        InvoiceLine
      • setDeliveryDateForThisLine

        public InvoiceLine setDeliveryDateForThisLine​(LocalDate value)
        Parameters:
        value - EXT:Delivery Date for this line

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString

        Returns:
        InvoiceLine
      • setInvoiceLinePeriodStartDate

        public InvoiceLine setInvoiceLinePeriodStartDate​(LocalDate value)
        Parameters:
        value - BT-134:Invoice line period start date

        The date when the Invoice period for this Invoice line starts.

        The date is the first day of the period.

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

        BR-CO-20: If Invoice line period (BG-26) is used, the Invoice line period start date (BT-134) or the Invoice line period end date (BT-135) shall be filled, or both.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString

        Returns:
        InvoiceLine
      • setInvoiceLinePeriodEndDate

        public InvoiceLine setInvoiceLinePeriodEndDate​(LocalDate value)
        Parameters:
        value - BT-135:Invoice line period end date

        The date when the Invoice period for this Invoice line ends.

        The date is the last day of the period.

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

        BR-30: If both Invoice line period start date (BT-134) and Invoice line period end date (BT-135) are given then the Invoice line period end date (BT-135) shall be later or equal to the Invoice line period start date (BT-134).BR-CO-20: If Invoice line period (BG-26) is used, the Invoice line period start date (BT-134) or the Invoice line period end date (BT-135) shall be filled, or both.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString

        Returns:
        InvoiceLine
      • setChargeTotalAmount

        public InvoiceLine setChargeTotalAmount​(UnitPriceAmount value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:ChargeTotalAmount

        Returns:
        InvoiceLine
      • setAllowanceTotalAmount

        public InvoiceLine setAllowanceTotalAmount​(UnitPriceAmount value)
        Parameters:
        value - EXT:

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:AllowanceTotalAmount

        Returns:
        InvoiceLine
      • setLineTotalTaxAmount

        public InvoiceLine setLineTotalTaxAmount​(Decimal value)
        Parameters:
        value - EXT:Line Total Tax amount

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:TaxTotalAmount

        Returns:
        InvoiceLine
      • setLineGrandTotalAmount

        public InvoiceLine setLineGrandTotalAmount​(Decimal value)
        Parameters:
        value - EXT:Line Grand Total amount

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:GrandTotalAmount

        Returns:
        InvoiceLine
      • setTotalAllowanceChargeAmount

        public InvoiceLine setTotalAllowanceChargeAmount​(UnitPriceAmount value)
        Parameters:
        value - EXT:Total amount of allowances / charges

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:TotalAllowanceChargeAmount

        Returns:
        InvoiceLine
      • setInvoiceLineBuyerAccountingReference

        public InvoiceLine setInvoiceLineBuyerAccountingReference​(String value)
        Parameters:
        value - BT-133:Invoice line Buyer accounting reference

        A textual value that specifies where to book the relevant data into the Buyer's financial accounts.

        If required, this reference shall be provided by the Buyer to the Seller prior to the issuing of the Invoice.

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:ID

        Returns:
        InvoiceLine
      • setTypeCode

        public InvoiceLine setTypeCode​(String value)
        Parameters:
        value - EXT:Accounting reference (Code)

        XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:TypeCode

        Returns:
        InvoiceLine
      • getInvoiceLineIdentifier

        public Identifier getInvoiceLineIdentifier()
        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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineID
      • getLineStatusCode

        public LineStatusCodeContentType getLineStatusCode()
        EXT:LineStatusCode

        The code specifying the status of this document line.

        Codelist UNTDID 1229

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineStatusCode
      • getLineStatusReasonCode

        public String getLineStatusReasonCode()
        EXT:LineStatusReasonCode

        The code specifying the line status reason for this document line.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:LineStatusReasonCode
      • getSchemeIdentifierForItemStandardIdentifier

        public Codes.SchemeIdentifier getSchemeIdentifierForItemStandardIdentifier()
        BT-157-1:Scheme identifier for Item standard identifier

        Identifiant du schéma de l'identifiant standard de l'article

        If used, the identification scheme identifier 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:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID/@schemeID
      • getItemStandardIdentifier

        public Identifier getItemStandardIdentifier()
        BT-157:Item standard identifier

        An item identifier based on a registered scheme.The identification scheme identifier of the Item standard identifier

        The identification scheme shall be identified from the entries of the list published by the ISO/IEC 6523 maintenance agency.

        CHORUSPRO: this field is limited to 40 characters

        BR-64: The Item standard identifier (BT-157) shall have a Scheme identifier

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:GlobalID
      • getSellerAssignedID

        public Identifier getSellerAssignedID()
        BT-155:Item Seller's identifier

        An identifier, assigned by the Seller, for the item.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:SellerAssignedID
      • getBuyerAssignedID

        public Identifier getBuyerAssignedID()
        BT-156:Item Buyer's identifier

        An identifier, assigned by the Buyer, for the item.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:BuyerAssignedID
      • getItemName

        public String getItemName()
        BT-153:Item name

        A name for an item.

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

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Name
      • getItemDescription

        public String getItemDescription()
        BT-154:Item description

        A description for an item.

        The Item description allows for describing the item and its features in more detail than the Item name.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:Description
      • getItemCountryOfOrigin

        public Codes.CountryCodeList getItemCountryOfOrigin()
        BT-159:Item country of origin

        The code identifying the country from which the item originates.

        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:IncludedSupplyChainTradeLineItem/ram:SpecifiedTradeProduct/ram:OriginTradeCountry/ram:ID
      • getItemGrossPrice

        public UnitPriceAmount getItemGrossPrice()
                                          throws ComputationException
        BT-148:Item gross price

        The unit price, exclusive of VAT, before subtracting Item price discount.

        The Item gross price MUST NOT be negative

        BR-28: The Item gross price (BT-148) shall NOT be negative.

        Returns:
        a computed value unless an explicit value has been set in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:ChargeAmount is returned
        Throws:
        ComputationException
      • getGrossItemPriceBaseQuantityUnitOfMeasureCode

        public Codes.UnitOfMeasure getGrossItemPriceBaseQuantityUnitOfMeasureCode()
        BT-150-1:Item price base quantity unit of measure code

        The unit of measure that applies to the Item price base quantity.

        The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).

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

        Must be the same than BT-150 for Net Price

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:BasisQuantity/@unitCode
      • getGrossItemPriceBaseQuantity

        public Quantity getGrossItemPriceBaseQuantity()
        BT-149-1:Item price base quantity

        The number of item units to which the price applies.

        To fill if BT-149 is present and if BT-148 is present, with the same value than BT-149

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:BasisQuantity
      • getItemNetPrice

        public UnitPriceAmount getItemNetPrice()
                                        throws ComputationException
        BT-146:Item net price

        The price of an item, exclusive of VAT, after subtracting item price discount.

        The Item net price has to be equal with the Item gross price less the Item price discount.

        The Item net price MUST NOT be negative

        BR-26: Each Invoice line (BG-25) shall contain the Item net price (BT-146).BR-27: The Item net price (BT-146) shall NOT be negative.

        Returns:
        a computed value unless an explicit value has been set in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:ChargeAmount is returned
        Throws:
        ComputationException
      • getNetItemPriceBaseQuantityUnitOfMeasureCode

        public Codes.UnitOfMeasure getNetItemPriceBaseQuantityUnitOfMeasureCode()
        BT-150:Item price base quantity unit of measure code

        The unit of measure that applies to the Item price base quantity.

        The Item price base quantity unit of measure shall be the same as the Invoiced quantity unit of measure (BT-130).

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

        Must be equal to the value of BT-130 and BT-150-1 if it exists

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity/@unitCode
      • getNetItemPriceBaseQuantity

        public Quantity getNetItemPriceBaseQuantity()
        BT-149:Item price base quantity

        The number of item units to which the price applies.

        Optional, if filled and if BT-148 is present (EN16931 and EXTENDED profiles), then it should be the same value than BT-149-1

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:BasisQuantity
      • getIncludedTaxForB2CCalculatedAmount

        public UnitPriceAmount getIncludedTaxForB2CCalculatedAmount()
        EXT:Included tax for B2C
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CalculatedAmount
      • getIncludedTaxForB2CTypeCode

        public String getIncludedTaxForB2CTypeCode()
        EXT:Included tax for B2C
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:TypeCode
      • getIncludedTaxForB2CExcemptionReason

        public String getIncludedTaxForB2CExcemptionReason()
        EXT:Included tax for B2C
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReason
      • getIncludedTaxForB2CCategoryCode

        public String getIncludedTaxForB2CCategoryCode()
        EXT:Included tax for B2C
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CategoryCode
      • getVATExemptionReasonCode

        public Codes.VATExemptionReasonCode getVATExemptionReasonCode()
        EXT:VAT exemption reason code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReasonCode
      • getIncludedTaxForB2CApplicablePercent

        public Percentage getIncludedTaxForB2CApplicablePercent()
        EXT:Included tax for B2C
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:RateApplicablePercent
      • getInvoicedQuantityUnitOfMeasureCode

        public Codes.UnitOfMeasure getInvoicedQuantityUnitOfMeasureCode()
        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).

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity/@unitCode
      • getInvoicedQuantity

        public Quantity getInvoicedQuantity()
        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:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:BilledQuantity
      • getChargeFreeQuantityMeasurementUnit

        public Codes.UnitOfMeasure getChargeFreeQuantityMeasurementUnit()
        EXT:Measurement unit
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity/@unitCode
      • getChargeFreeQuantity

        public Quantity getChargeFreeQuantity()
        EXT:Amount, without charge
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity
      • getPackageQuantityMeasurementUnit

        public Codes.UnitOfMeasure getPackageQuantityMeasurementUnit()
        EXT:Measurement unit
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity/@unitCode
      • getPackageQuantity

        public Quantity getPackageQuantity()
        EXT:Package quantity
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity
      • getLineDeliverToName

        public String getLineDeliverToName()
        EXT:SHIP TO Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:Name
      • getLineDeliverToLegalOrganizationSchemeIdentiferAttribute

        public String getLineDeliverToLegalOrganizationSchemeIdentiferAttribute()
        EXT:Scheme identifier attribute
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getLineDeliverToLegalOrganizationIdentifer

        public String getLineDeliverToLegalOrganizationIdentifer()
        EXT:Company Registration Number
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getLineDeliverToLegalOrganizationTradingName

        public String getLineDeliverToLegalOrganizationTradingName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getLineDeliverToPostCode

        public String getLineDeliverToPostCode()
        EXT:PostcodeCode
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getLineDeliverToAddressLine1

        public String getLineDeliverToAddressLine1()
        EXT:LineOne
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getLineDeliverToAddressLine2

        public String getLineDeliverToAddressLine2()
        EXT:LineTwo
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getLineDeliverToAddressLine3

        public String getLineDeliverToAddressLine3()
        EXT:LineThree
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getLineDeliverToCity

        public String getLineDeliverToCity()
        EXT:CityName
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CityName
      • getLineDeliverToCountryCode

        public Codes.CountryCodeList getLineDeliverToCountryCode()
        EXT:CountryID
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getLineDeliverToElectronicAddressScheme

        public Codes.SchemeIdentifierAttribute getLineDeliverToElectronicAddressScheme()
        EXT:Electronic Address Type
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getLineDeliverToElectronicAddress

        public String getLineDeliverToElectronicAddress()
        EXT:Electronic address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getName

        public String getName()
        EXT:Final Recipient Name / Company Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:Name
      • getSchemeIdentifierAttribute

        public String getSchemeIdentifierAttribute()
        EXT:Scheme identifier attribute
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
      • getCompanyRegistrationNumber

        public String getCompanyRegistrationNumber()
        EXT:Company Registration Number
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID
      • getTradingBusinessName

        public String getTradingBusinessName()
        EXT:Trading Business Name
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
      • getPostCode

        public String getPostCode()
        EXT:Post Code
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
      • getAddressLine1

        public String getAddressLine1()
        EXT:Address Line 1
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineOne
      • getAddressLine2

        public String getAddressLine2()
        EXT:Address Line 2
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo
      • getAddressLine3

        public String getAddressLine3()
        EXT:Address Line 3
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineThree
      • getCity

        public String getCity()
        EXT:City
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CityName
      • getCountryID

        public Codes.CountryCodeList getCountryID()
        EXT:Country (Code)
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CountryID
      • getElectronicAddressTypeTypeOfElectronicAddress

        public Codes.SchemeIdentifierAttribute getElectronicAddressTypeTypeOfElectronicAddress()
        EXT:Electronic Address Type Type of electronic address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
      • getElectronicAddressElectronicAddress

        public String getElectronicAddressElectronicAddress()
        EXT:Electronic address Electronic Address
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID
      • getFormat

        public Codes.DateFormat getFormat()
                                   throws ComputationException
        EXT:format

        Only value "102"

        Returns:
        a computed value unless an explicit value has been set and Invoice.setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getDeliveryDateForThisLine

        public LocalDate getDeliveryDateForThisLine()
        EXT:Delivery Date for this line
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString
      • getStartDateFormat

        public Codes.DateFormat getStartDateFormat()
                                            throws ComputationException
        BT-134-0:Date format

        Value = 102

        Only value "102"

        Returns:
        a computed value unless an explicit value has been set and Invoice.setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getInvoiceLinePeriodStartDate

        public LocalDate getInvoiceLinePeriodStartDate()
        BT-134:Invoice line period start date

        The date when the Invoice period for this Invoice line starts.

        The date is the first day of the period.

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

        BR-CO-20: If Invoice line period (BG-26) is used, the Invoice line period start date (BT-134) or the Invoice line period end date (BT-135) shall be filled, or both.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:StartDateTime/udt:DateTimeString
      • getEndDateFormat

        public Codes.DateFormat getEndDateFormat()
                                          throws ComputationException
        BT-135-0:Date format

        Value = 102

        Only value "102"

        Returns:
        a computed value unless an explicit value has been set and Invoice.setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString/@format is returned
        Throws:
        ComputationException
      • getInvoiceLinePeriodEndDate

        public LocalDate getInvoiceLinePeriodEndDate()
        BT-135:Invoice line period end date

        The date when the Invoice period for this Invoice line ends.

        The date is the last day of the period.

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

        BR-30: If both Invoice line period start date (BT-134) and Invoice line period end date (BT-135) are given then the Invoice line period end date (BT-135) shall be later or equal to the Invoice line period start date (BT-134).BR-CO-20: If Invoice line period (BG-26) is used, the Invoice line period start date (BT-134) or the Invoice line period end date (BT-135) shall be filled, or both.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:BillingSpecifiedPeriod/ram:EndDateTime/udt:DateTimeString
      • getInvoiceLineNetAmount

        public Amount getInvoiceLineNetAmount()
                                       throws ComputationException
        BT-131:Invoice line net amount

        The total amount of the Invoice line.

        The amount is “net” without VAT, i.e. inclusive of line level allowances and charges as well as other relevant taxes.

        BR-24: Each Invoice line (BG-25) shall have an Invoice line net amount (BT-131).

        Returns:
        a computed value unless an explicit value has been set and Invoice.setRecompute(boolean) has been called with a value of false in which case the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:LineTotalAmount is returned
        Throws:
        ComputationException
      • getChargeTotalAmount

        public UnitPriceAmount getChargeTotalAmount()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:ChargeTotalAmount
      • getAllowanceTotalAmount

        public UnitPriceAmount getAllowanceTotalAmount()
        EXT:
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:AllowanceTotalAmount
      • getLineTotalTaxAmount

        public Decimal getLineTotalTaxAmount()
        EXT:Line Total Tax amount
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:TaxTotalAmount
      • getLineGrandTotalAmount

        public Decimal getLineGrandTotalAmount()
        EXT:Line Grand Total amount
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:GrandTotalAmount
      • getTotalAllowanceChargeAmount

        public UnitPriceAmount getTotalAllowanceChargeAmount()
        EXT:Total amount of allowances / charges
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:TotalAllowanceChargeAmount
      • getInvoiceLineBuyerAccountingReference

        public String getInvoiceLineBuyerAccountingReference()
        BT-133:Invoice line Buyer accounting reference

        A textual value that specifies where to book the relevant data into the Buyer's financial accounts.

        If required, this reference shall be provided by the Buyer to the Seller prior to the issuing of the Invoice.

        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:ID
      • getTypeCode

        public String getTypeCode()
        EXT:Accounting reference (Code)
        Returns:
        the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:TypeCode