Class InvoiceLine
- java.lang.Object
-
- com.fourjs.report.facturx.profiles.en16931.InvoiceLine
-
public class InvoiceLine extends Object
BG-25:INVOICE LINEA 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 Summary
-
-
-
Method Detail
-
appendNewItemAttributes
public ItemAttributes appendNewItemAttributes()
Creates an ItemAttributes object and appends it to the list obtainable by a call to getgetItemAttributes()
- Returns:
- ItemAttributes
-
appendNewItemClassificationIdentifier
public ItemClassificationIdentifier appendNewItemClassificationIdentifier()
Creates an ItemClassificationIdentifier object and appends it to the list obtainable by a call to getgetItemClassificationIdentifiers()
- Returns:
- ItemClassificationIdentifier
-
appendNewReferencedPurchaseOrderLineReference
public ReferencedPurchaseOrderLineReference appendNewReferencedPurchaseOrderLineReference()
Creates a ReferencedPurchaseOrderLineReference object and appends it to the list obtainable by a call to getgetReferencedPurchaseOrderLineReferences()
- Returns:
- ReferencedPurchaseOrderLineReference
-
appendNewInvoiceLineAllowances
public InvoiceLineAllowances appendNewInvoiceLineAllowances()
Creates an InvoiceLineAllowances object and appends it to the list obtainable by a call to getgetInvoiceLineAllowances()
- Returns:
- InvoiceLineAllowances
-
appendNewInvoiceLineObjectIdentifier
public InvoiceLineObjectIdentifier appendNewInvoiceLineObjectIdentifier()
Creates an InvoiceLineObjectIdentifier object and appends it to the list obtainable by a call to getgetInvoiceLineObjectIdentifiers()
- Returns:
- InvoiceLineObjectIdentifier
-
getItemAttributes
public List<ItemAttributes> getItemAttributes()
Returns a list of ItemAttributes objects previously created by calls toappendNewItemAttributes()
-
getItemClassificationIdentifiers
public List<ItemClassificationIdentifier> getItemClassificationIdentifiers()
Returns a list of ItemClassificationIdentifier objects previously created by calls toappendNewItemClassificationIdentifier()
-
getReferencedPurchaseOrderLineReferences
public List<ReferencedPurchaseOrderLineReference> getReferencedPurchaseOrderLineReferences()
Returns a list of ReferencedPurchaseOrderLineReference objects previously created by calls toappendNewReferencedPurchaseOrderLineReference()
-
getInvoiceLineAllowances
public List<InvoiceLineAllowances> getInvoiceLineAllowances()
Returns a list of InvoiceLineAllowances objects previously created by calls toappendNewInvoiceLineAllowances()
-
getInvoiceLineObjectIdentifiers
public List<InvoiceLineObjectIdentifier> getInvoiceLineObjectIdentifiers()
Returns a list of InvoiceLineObjectIdentifier objects previously created by calls toappendNewInvoiceLineObjectIdentifier()
-
setInvoiceLineIdentifier
public InvoiceLine setInvoiceLineIdentifier(Identifier value)
- Parameters:
value
- BT-126:Invoice line identifierA 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
-
setInvoiceLineNote
public InvoiceLine setInvoiceLineNote(String value)
- Parameters:
value
- BT-127:Invoice line noteA textual note that gives unstructured information that is relevant to the Invoice line.
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:IncludedNote/ram:Content
- Returns:
- InvoiceLine
-
setSchemeIdentifierForItemStandardIdentifier
public InvoiceLine setSchemeIdentifierForItemStandardIdentifier(Codes.SchemeIdentifier value)
- Parameters:
value
- BT-157-1:Scheme identifier for Item standard identifierIdentifiant 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 identifierAn 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 identifierAn 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 identifierAn 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 nameA 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 descriptionA 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 originThe 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 priceThe 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 codeThe 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 quantityThe 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
-
setItemPriceDiscount
public InvoiceLine setItemPriceDiscount(UnitPriceAmount value)
- Parameters:
value
- BT-147:Item price discountThe total discount subtracted from the Item gross price to calculate the Item net price.
Only applies if the discount is provided per unit and if it is not included in the Item gross price.
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ActualAmount
- Returns:
- InvoiceLine
-
setReasonCode
public InvoiceLine setReasonCode(Codes.SpecialServiceDescriptionCode value)
- Parameters:
value
- EXT:Reason CodeThe code specifying the reason for this trade allowance.
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode
- Returns:
- InvoiceLine
-
setItemNetPrice
public InvoiceLine setItemNetPrice(UnitPriceAmount value)
- Parameters:
value
- BT-146:Item net priceThe 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 codeThe 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 quantityThe 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
-
setInvoicedQuantityUnitOfMeasureCode
public InvoiceLine setInvoicedQuantityUnitOfMeasureCode(Codes.UnitOfMeasure value)
- Parameters:
value
- BT-130:Invoiced quantity unit of measure codeThe 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 quantityThe 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
-
setInvoicedItemVATCategoryCode
public InvoiceLine setInvoicedItemVATCategoryCode(Codes.VATCategoryCode value)
- Parameters:
value
- BT-151:Invoiced item VAT category codeThe 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).
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCode
- Returns:
- InvoiceLine
-
setInvoicedItemVATRate
public InvoiceLine setInvoicedItemVATRate(Percentage value)
- Parameters:
value
- BT-152:Invoiced item VAT rateThe VAT rate, represented as percentage that applies to the invoiced item.
The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)
XPath:/rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent
- Returns:
- InvoiceLine
-
setInvoiceLinePeriodStartDate
public InvoiceLine setInvoiceLinePeriodStartDate(LocalDate value)
- Parameters:
value
- BT-134:Invoice line period start dateThe 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 dateThe 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
-
setInvoiceLineBuyerAccountingReference
public InvoiceLine setInvoiceLineBuyerAccountingReference(String value)
- Parameters:
value
- BT-133:Invoice line Buyer accounting referenceA 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
-
getInvoiceLineIdentifier
public Identifier getInvoiceLineIdentifier()
BT-126:Invoice line identifierA 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
-
getInvoiceLineNote
public String getInvoiceLineNote()
BT-127:Invoice line noteA textual note that gives unstructured information that is relevant to the Invoice line.
- Returns:
- the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:AssociatedDocumentLineDocument/ram:IncludedNote/ram:Content
-
getSchemeIdentifierForItemStandardIdentifier
public Codes.SchemeIdentifier getSchemeIdentifierForItemStandardIdentifier()
BT-157-1:Scheme identifier for Item standard identifierIdentifiant 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 identifierAn 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 identifierAn 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 identifierAn 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 nameA 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 descriptionA 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 originThe 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 priceThe 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 codeThe 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 quantityThe 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
-
getItemPriceDiscountIndicator
public Boolean getItemPriceDiscountIndicator() throws ComputationException
BT-147-02:(Item price discount)Value = false
- 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:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ChargeIndicator/udt:Indicator is returned - Throws:
ComputationException
-
getItemPriceDiscount
public UnitPriceAmount getItemPriceDiscount()
BT-147:Item price discountThe total discount subtracted from the Item gross price to calculate the Item net price.
Only applies if the discount is provided per unit and if it is not included in the Item gross price.
- Returns:
- the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ActualAmount
-
getReasonCode
public Codes.SpecialServiceDescriptionCode getReasonCode()
EXT:Reason CodeThe code specifying the reason for this trade allowance.
- Returns:
- the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeAgreement/ram:GrossPriceProductTradePrice/ram:AppliedTradeAllowanceCharge/ram:ReasonCode
-
getItemNetPrice
public UnitPriceAmount getItemNetPrice() throws ComputationException
BT-146:Item net priceThe 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 codeThe 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 quantityThe 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
-
getInvoicedQuantityUnitOfMeasureCode
public Codes.UnitOfMeasure getInvoicedQuantityUnitOfMeasureCode()
BT-130:Invoiced quantity unit of measure codeThe 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 quantityThe 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
-
getVATTypeCodeOnLineLevel
public Codes.VATTypeCode getVATTypeCodeOnLineLevel()
BT-151-0:VAT type code on line levelValue = VAT
Fixed value "VAT"
- Returns:
- the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:TypeCode
-
getInvoicedItemVATCategoryCode
public Codes.VATCategoryCode getInvoicedItemVATCategoryCode()
BT-151:Invoiced item VAT category codeThe 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:
- the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:CategoryCode
-
getInvoicedItemVATRate
public Percentage getInvoicedItemVATRate()
BT-152:Invoiced item VAT rateThe VAT rate, represented as percentage that applies to the invoiced item.
The value to enter is the percentage. For example, for 20%, it must be filled 20 (and not 0.2)
- Returns:
- the value /rsm:CrossIndustryInvoice/rsm:SupplyChainTradeTransaction/ram:IncludedSupplyChainTradeLineItem/ram:SpecifiedLineTradeSettlement/ram:ApplicableTradeTax/ram:RateApplicablePercent
-
getStartDateFormat
public Codes.DateFormat getStartDateFormat() throws ComputationException
BT-134-0:Date formatValue = 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 dateThe 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 formatValue = 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 dateThe 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 amountThe 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
-
getInvoiceLineBuyerAccountingReference
public String getInvoiceLineBuyerAccountingReference()
BT-133:Invoice line Buyer accounting referenceA 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
-
-