public class InvoiceLine
extends java.lang.Object
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
public InvoiceLineNote appendNewInvoiceLineNote()
getInvoiceLineNotes()
public ItemAttributes appendNewItemAttributes()
getItemAttributes()
public ItemClassificationIdentifier appendNewItemClassificationIdentifier()
getItemClassificationIdentifiers()
public IndividualTradeProductInstance appendNewIndividualTradeProductInstance()
getIndividualTradeProductInstances()
public DetailedInformationOnTheIncludedItems appendNewDetailedInformationOnTheIncludedItems()
getDetailedInformationOnTheIncludedItems()
public ReferencedPurchaseOrderLineReference appendNewReferencedPurchaseOrderLineReference()
getReferencedPurchaseOrderLineReferences()
public QuotationReferencedDocument appendNewQuotationReferencedDocument()
getQuotationReferencedDocuments()
public DetailedInformationOnTheAssociatedContract appendNewDetailedInformationOnTheAssociatedContract()
getDetailedInformationOnTheAssociatedContracts()
public DetailsOfAnAdditionalDocumentReference appendNewDetailsOfAnAdditionalDocumentReference()
getDetailsOfAnAdditionalDocumentReferences()
public AppliedTradeAllowanceCharge appendNewAppliedTradeAllowanceCharge()
getAppliedTradeAllowanceCharges()
public UltimateCustomerOrderReferencedDocument appendNewUltimateCustomerOrderReferencedDocument()
getUltimateCustomerOrderReferencedDocuments()
public LineDeliverToIdentifier appendNewLineDeliverToIdentifier()
getLineDeliverToIdentifiers()
public LineDeliverToIdentifierSchemeIdentifier appendNewLineDeliverToIdentifierSchemeIdentifier()
getLineDeliverToIdentifierSchemeIdentifiers()
public LineDeliverTo appendNewLineDeliverTo()
getLineDeliverTos()
public LineDeliverToCountrySubdivision appendNewLineDeliverToCountrySubdivision()
getLineDeliverToCountrySubdivisions()
public DetailedInformationOnTaxInformationOfTheGoodsRecipient appendNewDetailedInformationOnTaxInformationOfTheGoodsRecipient()
getDetailedInformationOnTaxInformationOfTheGoodsRecipients()
public FinalRecipientIdentifier appendNewFinalRecipientIdentifier()
getFinalRecipientIdentifiers()
public FinalRecipientGlobalIdentifier appendNewFinalRecipientGlobalIdentifier()
getFinalRecipientGlobalIdentifiers()
public DetailsOfTheContactPerson appendNewDetailsOfTheContactPerson()
getDetailsOfTheContactPersons()
public CountrySubdivision appendNewCountrySubdivision()
getCountrySubdivisions()
public DetailedTaxInformationOfTheFinalRecipient appendNewDetailedTaxInformationOfTheFinalRecipient()
getDetailedTaxInformationOfTheFinalRecipients()
public DespatchAdviceReferencedDocumentForThisLine appendNewDespatchAdviceReferencedDocumentForThisLine()
getDespatchAdviceReferencedDocumentForThisLines()
public ReceivingAdviceReferencedDocumentForThisLine appendNewReceivingAdviceReferencedDocumentForThisLine()
getReceivingAdviceReferencedDocumentForThisLines()
public DetailedInformationAboutTheCorrespondingDeliveryNote appendNewDetailedInformationAboutTheCorrespondingDeliveryNote()
getDetailedInformationAboutTheCorrespondingDeliveryNotes()
public LineVATInformation appendNewLineVATInformation(Codes.VATCategoryCode invoicedItemVATCategoryCode)
getLineVATInformationList()
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).
public InvoiceLineAllowances appendNewInvoiceLineAllowances()
getInvoiceLineAllowances()
public ExtendedPrecedingInvoiceReference appendNewExtendedPrecedingInvoiceReference()
getExtendedPrecedingInvoiceReferences()
public InvoiceLineObjectIdentifier appendNewInvoiceLineObjectIdentifier()
getInvoiceLineObjectIdentifiers()
public java.util.List<InvoiceLineNote> getInvoiceLineNotes()
appendNewInvoiceLineNote()
public java.util.List<ItemAttributes> getItemAttributes()
appendNewItemAttributes()
public java.util.List<ItemClassificationIdentifier> getItemClassificationIdentifiers()
appendNewItemClassificationIdentifier()
public java.util.List<IndividualTradeProductInstance> getIndividualTradeProductInstances()
appendNewIndividualTradeProductInstance()
public java.util.List<DetailedInformationOnTheIncludedItems> getDetailedInformationOnTheIncludedItems()
appendNewDetailedInformationOnTheIncludedItems()
public java.util.List<ReferencedPurchaseOrderLineReference> getReferencedPurchaseOrderLineReferences()
appendNewReferencedPurchaseOrderLineReference()
public java.util.List<QuotationReferencedDocument> getQuotationReferencedDocuments()
appendNewQuotationReferencedDocument()
public java.util.List<DetailedInformationOnTheAssociatedContract> getDetailedInformationOnTheAssociatedContracts()
appendNewDetailedInformationOnTheAssociatedContract()
public java.util.List<DetailsOfAnAdditionalDocumentReference> getDetailsOfAnAdditionalDocumentReferences()
appendNewDetailsOfAnAdditionalDocumentReference()
public java.util.List<AppliedTradeAllowanceCharge> getAppliedTradeAllowanceCharges()
appendNewAppliedTradeAllowanceCharge()
public java.util.List<UltimateCustomerOrderReferencedDocument> getUltimateCustomerOrderReferencedDocuments()
appendNewUltimateCustomerOrderReferencedDocument()
public java.util.List<LineDeliverToIdentifier> getLineDeliverToIdentifiers()
appendNewLineDeliverToIdentifier()
public java.util.List<LineDeliverToIdentifierSchemeIdentifier> getLineDeliverToIdentifierSchemeIdentifiers()
appendNewLineDeliverToIdentifierSchemeIdentifier()
public java.util.List<LineDeliverTo> getLineDeliverTos()
appendNewLineDeliverTo()
public java.util.List<LineDeliverToCountrySubdivision> getLineDeliverToCountrySubdivisions()
appendNewLineDeliverToCountrySubdivision()
public java.util.List<DetailedInformationOnTaxInformationOfTheGoodsRecipient> getDetailedInformationOnTaxInformationOfTheGoodsRecipients()
appendNewDetailedInformationOnTaxInformationOfTheGoodsRecipient()
public java.util.List<FinalRecipientIdentifier> getFinalRecipientIdentifiers()
appendNewFinalRecipientIdentifier()
public java.util.List<FinalRecipientGlobalIdentifier> getFinalRecipientGlobalIdentifiers()
appendNewFinalRecipientGlobalIdentifier()
public java.util.List<DetailsOfTheContactPerson> getDetailsOfTheContactPersons()
appendNewDetailsOfTheContactPerson()
public java.util.List<CountrySubdivision> getCountrySubdivisions()
appendNewCountrySubdivision()
public java.util.List<DetailedTaxInformationOfTheFinalRecipient> getDetailedTaxInformationOfTheFinalRecipients()
appendNewDetailedTaxInformationOfTheFinalRecipient()
public java.util.List<DespatchAdviceReferencedDocumentForThisLine> getDespatchAdviceReferencedDocumentForThisLines()
appendNewDespatchAdviceReferencedDocumentForThisLine()
public java.util.List<ReceivingAdviceReferencedDocumentForThisLine> getReceivingAdviceReferencedDocumentForThisLines()
appendNewReceivingAdviceReferencedDocumentForThisLine()
public java.util.List<DetailedInformationAboutTheCorrespondingDeliveryNote> getDetailedInformationAboutTheCorrespondingDeliveryNotes()
appendNewDetailedInformationAboutTheCorrespondingDeliveryNote()
public java.util.List<LineVATInformation> getLineVATInformationList()
appendNewLineVATInformation(Codes.VATCategoryCode)
public java.util.List<InvoiceLineAllowances> getInvoiceLineAllowances()
appendNewInvoiceLineAllowances()
public java.util.List<ExtendedPrecedingInvoiceReference> getExtendedPrecedingInvoiceReferences()
appendNewExtendedPrecedingInvoiceReference()
public java.util.List<InvoiceLineObjectIdentifier> getInvoiceLineObjectIdentifiers()
appendNewInvoiceLineObjectIdentifier()
public InvoiceLine setInvoiceLineIdentifier(Identifier value)
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
public InvoiceLine setLineStatusCode(LineStatusCodeContentType value)
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
public InvoiceLine setLineStatusReasonCode(java.lang.String value)
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
public InvoiceLine setSchemeIdentifierForItemStandardIdentifier(Codes.SchemeIdentifier value)
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
public InvoiceLine setItemStandardIdentifier(Identifier value)
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
public InvoiceLine setSellerAssignedID(Identifier value)
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
public InvoiceLine setBuyerAssignedID(Identifier value)
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
public InvoiceLine setItemName(java.lang.String value)
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
public InvoiceLine setItemDescription(java.lang.String value)
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
public InvoiceLine setItemCountryOfOrigin(Codes.CountryCodeList value)
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
public InvoiceLine setItemGrossPrice(UnitPriceAmount value)
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
public InvoiceLine setGrossItemPriceBaseQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
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
public InvoiceLine setGrossItemPriceBaseQuantity(Quantity value)
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
public InvoiceLine setItemNetPrice(UnitPriceAmount value)
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
public InvoiceLine setNetItemPriceBaseQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
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
public InvoiceLine setNetItemPriceBaseQuantity(Quantity value)
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
public InvoiceLine setIncludedTaxForB2CCalculatedAmount(UnitPriceAmount value)
value
- EXT:Included tax for B2C
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CalculatedAmount
public InvoiceLine setIncludedTaxForB2CTypeCode(java.lang.String value)
value
- EXT:Included tax for B2C
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:TypeCode
public InvoiceLine setIncludedTaxForB2CExcemptionReason(java.lang.String value)
value
- EXT:Included tax for B2C
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReason
public InvoiceLine setIncludedTaxForB2CCategoryCode(java.lang.String value)
value
- EXT:Included tax for B2C
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:CategoryCode
public InvoiceLine setVATExemptionReasonCode(Codes.VATExemptionReasonCode value)
value
- EXT:VAT exemption reason code
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:ExemptionReasonCode
public InvoiceLine setIncludedTaxForB2CApplicablePercent(Percentage value)
value
- EXT:Included tax for B2C
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:NetPriceProductTradePrice/ram:IncludedTradeTax/ram:RateApplicablePercent
public InvoiceLine setInvoicedQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
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
public InvoiceLine setInvoicedQuantity(Quantity value)
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
public InvoiceLine setChargeFreeQuantityMeasurementUnit(Codes.UnitOfMeasure value)
value
- EXT:Measurement unit
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity/@unitCode
public InvoiceLine setChargeFreeQuantity(Quantity value)
value
- EXT:Amount, without charge
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ChargeFreeQuantity
public InvoiceLine setPackageQuantityMeasurementUnit(Codes.UnitOfMeasure value)
value
- EXT:Measurement unit
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity/@unitCode
public InvoiceLine setPackageQuantity(Quantity value)
value
- EXT:Package quantity
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:PackageQuantity
public InvoiceLine setLineDeliverToName(java.lang.String value)
value
- EXT:SHIP TO Name
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:Name
public InvoiceLine setLineDeliverToLegalOrganizationSchemeIdentiferAttribute(java.lang.String value)
value
- EXT:Scheme identifier attribute
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
public InvoiceLine setLineDeliverToLegalOrganizationIdentifer(java.lang.String value)
value
- EXT:Company Registration Number
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID
public InvoiceLine setLineDeliverToLegalOrganizationTradingName(java.lang.String value)
value
- EXT:Trading Business Name
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
public InvoiceLine setLineDeliverToPostCode(java.lang.String value)
value
- EXT:PostcodeCode
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
public InvoiceLine setLineDeliverToAddressLine1(java.lang.String value)
value
- EXT:LineOne
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineOne
public InvoiceLine setLineDeliverToAddressLine2(java.lang.String value)
value
- EXT:LineTwo
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo
public InvoiceLine setLineDeliverToAddressLine3(java.lang.String value)
value
- EXT:LineThree
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:LineThree
public InvoiceLine setLineDeliverToCity(java.lang.String value)
value
- EXT:CityName
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CityName
public InvoiceLine setLineDeliverToCountryCode(Codes.CountryCodeList value)
value
- EXT:CountryID
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:PostalTradeAddress/ram:CountryID
public InvoiceLine setLineDeliverToElectronicAddressScheme(Codes.SchemeIdentifierAttribute value)
value
- EXT:Electronic Address Type
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID/@schemeID
public InvoiceLine setLineDeliverToElectronicAddress(java.lang.String value)
value
- EXT:Electronic address
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ShipToTradeParty/ram:URIUniversalCommunication/ram:URIID
public InvoiceLine setName(java.lang.String value)
value
- EXT:Final Recipient Name / Company Name
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:Name
public InvoiceLine setSchemeIdentifierAttribute(java.lang.String value)
value
- EXT:Scheme identifier attribute
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID/@schemeID
public InvoiceLine setCompanyRegistrationNumber(java.lang.String value)
value
- EXT:Company Registration Number
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:ID
public InvoiceLine setTradingBusinessName(java.lang.String value)
value
- EXT:Trading Business Name
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:SpecifiedLegalOrganization/ram:TradingBusinessName
public InvoiceLine setPostCode(java.lang.String value)
value
- EXT:Post Code
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:PostcodeCode
public InvoiceLine setAddressLine1(java.lang.String value)
value
- EXT:Address Line 1
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineOne
public InvoiceLine setAddressLine2(java.lang.String value)
value
- EXT:Address Line 2
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineTwo
public InvoiceLine setAddressLine3(java.lang.String value)
value
- EXT:Address Line 3
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:LineThree
public InvoiceLine setCity(java.lang.String value)
value
- EXT:City
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CityName
public InvoiceLine setCountryID(Codes.CountryCodeList value)
value
- EXT:Country (Code)
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:PostalTradeAddress/ram:CountryID
public InvoiceLine setElectronicAddressTypeTypeOfElectronicAddress(Codes.SchemeIdentifierAttribute value)
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
public InvoiceLine setElectronicAddressElectronicAddress(java.lang.String value)
value
- EXT:Electronic address Electronic Address
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:UltimateShipToTradeParty/ram:URIUniversalCommunication/ram:URIID
public InvoiceLine setDeliveryDateForThisLine(java.time.LocalDate value)
value
- EXT:Delivery Date for this line
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeDelivery/ram:ActualDeliverySupplyChainEvent/ram:OccurrenceDateTime/udt:DateTimeString
public InvoiceLine setInvoiceLinePeriodStartDate(java.time.LocalDate value)
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
public InvoiceLine setInvoiceLinePeriodEndDate(java.time.LocalDate value)
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
public InvoiceLine setChargeTotalAmount(UnitPriceAmount value)
value
- EXT:
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:ChargeTotalAmount
public InvoiceLine setAllowanceTotalAmount(UnitPriceAmount value)
value
- EXT:
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:AllowanceTotalAmount
public InvoiceLine setLineTotalTaxAmount(Decimal value)
value
- EXT:Line Total Tax amount
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:TaxTotalAmount
public InvoiceLine setLineGrandTotalAmount(Decimal value)
value
- EXT:Line Grand Total amount
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:GrandTotalAmount
public InvoiceLine setTotalAllowanceChargeAmount(UnitPriceAmount value)
value
- EXT:Total amount of allowances / charges
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:SpecifiedTradeSettlementLineMonetarySummation/ram:TotalAllowanceChargeAmount
public InvoiceLine setInvoiceLineBuyerAccountingReference(java.lang.String value)
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
public InvoiceLine setTypeCode(java.lang.String value)
value
- EXT:Accounting reference (Code)
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ReceivableSpecifiedTradeAccountingAccount/ram:TypeCode
public Identifier getInvoiceLineIdentifier()
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).
public LineStatusCodeContentType getLineStatusCode()
The code specifying the status of this document line.
Codelist UNTDID 1229
public java.lang.String getLineStatusReasonCode()
The code specifying the line status reason for this document line.
public Codes.SchemeIdentifier getSchemeIdentifierForItemStandardIdentifier()
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.
public Identifier getItemStandardIdentifier()
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
public Identifier getSellerAssignedID()
An identifier, assigned by the Seller, for the item.
public Identifier getBuyerAssignedID()
An identifier, assigned by the Buyer, for the item.
public java.lang.String getItemName()
A name for an item.
BR-25: Each Invoice line (BG-25) shall contain the Item name (BT- 153).
public java.lang.String getItemDescription()
A description for an item.
The Item description allows for describing the item and its features in more detail than the Item name.
public Codes.CountryCodeList getItemCountryOfOrigin()
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”.
public UnitPriceAmount getItemGrossPrice() throws ComputationException
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.
ComputationException
public Codes.UnitOfMeasure getGrossItemPriceBaseQuantityUnitOfMeasureCode()
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
public Quantity getGrossItemPriceBaseQuantity()
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
public UnitPriceAmount getItemNetPrice() throws ComputationException
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.
ComputationException
public Codes.UnitOfMeasure getNetItemPriceBaseQuantityUnitOfMeasureCode()
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
public Quantity getNetItemPriceBaseQuantity()
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
public UnitPriceAmount getIncludedTaxForB2CCalculatedAmount()
public java.lang.String getIncludedTaxForB2CTypeCode()
public java.lang.String getIncludedTaxForB2CExcemptionReason()
public java.lang.String getIncludedTaxForB2CCategoryCode()
public Codes.VATExemptionReasonCode getVATExemptionReasonCode()
public Percentage getIncludedTaxForB2CApplicablePercent()
public Codes.UnitOfMeasure getInvoicedQuantityUnitOfMeasureCode()
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).
public Quantity getInvoicedQuantity()
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).
public Codes.UnitOfMeasure getChargeFreeQuantityMeasurementUnit()
public Quantity getChargeFreeQuantity()
public Codes.UnitOfMeasure getPackageQuantityMeasurementUnit()
public Quantity getPackageQuantity()
public java.lang.String getLineDeliverToName()
public java.lang.String getLineDeliverToLegalOrganizationSchemeIdentiferAttribute()
public java.lang.String getLineDeliverToLegalOrganizationIdentifer()
public java.lang.String getLineDeliverToLegalOrganizationTradingName()
public java.lang.String getLineDeliverToPostCode()
public java.lang.String getLineDeliverToAddressLine1()
public java.lang.String getLineDeliverToAddressLine2()
public java.lang.String getLineDeliverToAddressLine3()
public java.lang.String getLineDeliverToCity()
public Codes.CountryCodeList getLineDeliverToCountryCode()
public Codes.SchemeIdentifierAttribute getLineDeliverToElectronicAddressScheme()
public java.lang.String getLineDeliverToElectronicAddress()
public java.lang.String getName()
public java.lang.String getSchemeIdentifierAttribute()
public java.lang.String getCompanyRegistrationNumber()
public java.lang.String getTradingBusinessName()
public java.lang.String getPostCode()
public java.lang.String getAddressLine1()
public java.lang.String getAddressLine2()
public java.lang.String getAddressLine3()
public java.lang.String getCity()
public Codes.CountryCodeList getCountryID()
public Codes.SchemeIdentifierAttribute getElectronicAddressTypeTypeOfElectronicAddress()
public java.lang.String getElectronicAddressElectronicAddress()
public Codes.DateFormat getFormat() throws ComputationException
Only value "102"
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 returnedComputationException
public java.time.LocalDate getDeliveryDateForThisLine()
public Codes.DateFormat getStartDateFormat() throws ComputationException
Value = 102
Only value "102"
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 returnedComputationException
public java.time.LocalDate getInvoiceLinePeriodStartDate()
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.
public Codes.DateFormat getEndDateFormat() throws ComputationException
Value = 102
Only value "102"
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 returnedComputationException
public java.time.LocalDate getInvoiceLinePeriodEndDate()
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.
public Amount getInvoiceLineNetAmount() throws ComputationException
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).
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 returnedComputationException
public UnitPriceAmount getChargeTotalAmount()
public UnitPriceAmount getAllowanceTotalAmount()
public Decimal getLineTotalTaxAmount()
public Decimal getLineGrandTotalAmount()
public UnitPriceAmount getTotalAllowanceChargeAmount()
public java.lang.String getInvoiceLineBuyerAccountingReference()
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.
public java.lang.String getTypeCode()