oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2

Class MonetaryTotalType

java.lang.Object

oasis.names.specification.ubl.schema.xsd.commonaggregatecomponents_2.MonetaryTotalType

public class MonetaryTotalType
extends Object

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                <ccts:ComponentType>ABIE</ccts:ComponentType>
                <ccts:DictionaryEntryName>Monetary Total. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to define a monetary total.</ccts:Definition>
                <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
             </ccts:Component>
 

Java class for MonetaryTotalType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="MonetaryTotalType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}LineExtensionAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TaxExclusiveAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TaxInclusiveAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}AllowanceTotalAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ChargeTotalAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PrepaidAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PayableRoundingAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PayableAmount"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PayableAlternativeAmount" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected AllowanceTotalAmountType	allowanceTotalAmount
protected ChargeTotalAmountType	chargeTotalAmount
protected LineExtensionAmountType	lineExtensionAmount
protected PayableAlternativeAmountType	payableAlternativeAmount
protected PayableAmountType	payableAmount
protected PayableRoundingAmountType	payableRoundingAmount
protected PrepaidAmountType	prepaidAmount
protected TaxExclusiveAmountType	taxExclusiveAmount
protected TaxInclusiveAmountType	taxInclusiveAmount

Constructor Summary

Constructors

Constructor and Description
MonetaryTotalType()

Method Summary

Modifier and Type	Method and Description
AllowanceTotalAmountType	getAllowanceTotalAmount() <?
ChargeTotalAmountType	getChargeTotalAmount() <?
LineExtensionAmountType	getLineExtensionAmount() <?
PayableAlternativeAmountType	getPayableAlternativeAmount() <?
PayableAmountType	getPayableAmount() <?
PayableRoundingAmountType	getPayableRoundingAmount() <?
PrepaidAmountType	getPrepaidAmount() <?
TaxExclusiveAmountType	getTaxExclusiveAmount() <?
TaxInclusiveAmountType	getTaxInclusiveAmount() <?
void	setAllowanceTotalAmount(AllowanceTotalAmountType value) Sets the value of the allowanceTotalAmount property.
void	setChargeTotalAmount(ChargeTotalAmountType value) Sets the value of the chargeTotalAmount property.
void	setLineExtensionAmount(LineExtensionAmountType value) Sets the value of the lineExtensionAmount property.
void	setPayableAlternativeAmount(PayableAlternativeAmountType value) Sets the value of the payableAlternativeAmount property.
void	setPayableAmount(PayableAmountType value) Sets the value of the payableAmount property.
void	setPayableRoundingAmount(PayableRoundingAmountType value) Sets the value of the payableRoundingAmount property.
void	setPrepaidAmount(PrepaidAmountType value) Sets the value of the prepaidAmount property.
void	setTaxExclusiveAmount(TaxExclusiveAmountType value) Sets the value of the taxExclusiveAmount property.
void	setTaxInclusiveAmount(TaxInclusiveAmountType value) Sets the value of the taxInclusiveAmount property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

lineExtensionAmount

protected LineExtensionAmountType lineExtensionAmount

taxExclusiveAmount

protected TaxExclusiveAmountType taxExclusiveAmount

taxInclusiveAmount

protected TaxInclusiveAmountType taxInclusiveAmount

allowanceTotalAmount

protected AllowanceTotalAmountType allowanceTotalAmount

chargeTotalAmount

protected ChargeTotalAmountType chargeTotalAmount

prepaidAmount

protected PrepaidAmountType prepaidAmount

payableRoundingAmount

protected PayableRoundingAmountType payableRoundingAmount

payableAmount

protected PayableAmountType payableAmount

payableAlternativeAmount

protected PayableAlternativeAmountType payableAlternativeAmount

Constructor Detail

MonetaryTotalType

public MonetaryTotalType()

Method Detail

getLineExtensionAmount

public LineExtensionAmountType getLineExtensionAmount()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Monetary Total. Line Extension Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The monetary amount of an extended transaction line, net of tax and settlement discounts, but inclusive of any applicable rounding amount.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
                      <ccts:PropertyTerm>Line Extension Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is LineExtensionAmountType

setLineExtensionAmount

public void setLineExtensionAmount(LineExtensionAmountType value)

Sets the value of the lineExtensionAmount property.

Parameters:

value - allowed object is LineExtensionAmountType

getTaxExclusiveAmount

public TaxExclusiveAmountType getTaxExclusiveAmount()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Monetary Total. Tax Exclusive Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The monetary amount of an extended transaction line, exclusive of taxes.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tax Exclusive Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is TaxExclusiveAmountType

setTaxExclusiveAmount

public void setTaxExclusiveAmount(TaxExclusiveAmountType value)

Sets the value of the taxExclusiveAmount property.

Parameters:

value - allowed object is TaxExclusiveAmountType

getTaxInclusiveAmount

public TaxInclusiveAmountType getTaxInclusiveAmount()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Monetary Total. Tax Inclusive Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The monetary amount including taxes; the sum of payable amount and prepaid amount.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tax Inclusive Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is TaxInclusiveAmountType

setTaxInclusiveAmount

public void setTaxInclusiveAmount(TaxInclusiveAmountType value)

Sets the value of the taxInclusiveAmount property.

Parameters:

value - allowed object is TaxInclusiveAmountType

getAllowanceTotalAmount

public AllowanceTotalAmountType getAllowanceTotalAmount()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Monetary Total. Allowance_ Total Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The total monetary amount of all allowances.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Allowance</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Total Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is AllowanceTotalAmountType

setAllowanceTotalAmount

public void setAllowanceTotalAmount(AllowanceTotalAmountType value)

Sets the value of the allowanceTotalAmount property.

Parameters:

value - allowed object is AllowanceTotalAmountType

getChargeTotalAmount

public ChargeTotalAmountType getChargeTotalAmount()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Monetary Total. Charge_ Total Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The total monetary amount of all charges.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Charge</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Total Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is ChargeTotalAmountType

setChargeTotalAmount

public void setChargeTotalAmount(ChargeTotalAmountType value)

Sets the value of the chargeTotalAmount property.

Parameters:

value - allowed object is ChargeTotalAmountType

getPrepaidAmount

public PrepaidAmountType getPrepaidAmount()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Monetary Total. Prepaid Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The total prepaid monetary amount.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
                      <ccts:PropertyTerm>Prepaid Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is PrepaidAmountType

setPrepaidAmount

public void setPrepaidAmount(PrepaidAmountType value)

Sets the value of the prepaidAmount property.

Parameters:

value - allowed object is PrepaidAmountType

getPayableRoundingAmount

public PayableRoundingAmountType getPayableRoundingAmount()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Monetary Total. Payable_ Rounding Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The rounding amount (positive or negative) added to produce the line extension amount.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Payable</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Rounding Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is PayableRoundingAmountType

setPayableRoundingAmount

public void setPayableRoundingAmount(PayableRoundingAmountType value)

Sets the value of the payableRoundingAmount property.

Parameters:

value - allowed object is PayableRoundingAmountType

getPayableAmount

public PayableAmountType getPayableAmount()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Monetary Total. Payable_ Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The amount of the monetary total to be paid.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Payable</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is PayableAmountType

setPayableAmount

public void setPayableAmount(PayableAmountType value)

Sets the value of the payableAmount property.

Parameters:

value - allowed object is PayableAmountType

getPayableAlternativeAmount

public PayableAlternativeAmountType getPayableAlternativeAmount()

 <?xml version="1.0" encoding="UTF-8"?><ccts:Component xmlns:ccts="urn:un:unece:uncefact:documentation:2" xmlns="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2" xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
                      <ccts:ComponentType>BBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Monetary Total. Payable_ Alternative Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The amount of the monetary total to be paid, expressed in an alternative currency.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Monetary Total</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Payable</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Alternative Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is PayableAlternativeAmountType

setPayableAlternativeAmount

public void setPayableAlternativeAmount(PayableAlternativeAmountType value)

Sets the value of the payableAlternativeAmount property.

Parameters:

value - allowed object is PayableAlternativeAmountType