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

Class TaxSubtotalType

java.lang.Object

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

public class TaxSubtotalType
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>Tax Subtotal. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to define the subtotal for a particular tax category within a particular taxation scheme, such as standard rate within VAT.</ccts:Definition>
                <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
             </ccts:Component>
 

Java class for TaxSubtotalType complex type.

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

 <complexType name="TaxSubtotalType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TaxableAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TaxAmount"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}CalculationSequenceNumeric" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TransactionCurrencyTaxAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Percent" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}BaseUnitMeasure" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}PerUnitAmount" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TierRange" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TierRatePercent" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2}TaxCategory"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseUnitMeasureType	baseUnitMeasure
protected CalculationSequenceNumericType	calculationSequenceNumeric
protected PercentType	percent
protected PerUnitAmountType	perUnitAmount
protected TaxableAmountType	taxableAmount
protected TaxAmountType	taxAmount
protected TaxCategoryType	taxCategory
protected TierRangeType	tierRange
protected TierRatePercentType	tierRatePercent
protected TransactionCurrencyTaxAmountType	transactionCurrencyTaxAmount

Constructor Summary

Constructors

Constructor and Description
TaxSubtotalType()

Method Summary

Modifier and Type	Method and Description
BaseUnitMeasureType	getBaseUnitMeasure() <?
CalculationSequenceNumericType	getCalculationSequenceNumeric() <?
PercentType	getPercent() <?
PerUnitAmountType	getPerUnitAmount() <?
TaxableAmountType	getTaxableAmount() <?
TaxAmountType	getTaxAmount() <?
TaxCategoryType	getTaxCategory() <?
TierRangeType	getTierRange() <?
TierRatePercentType	getTierRatePercent() <?
TransactionCurrencyTaxAmountType	getTransactionCurrencyTaxAmount() <?
void	setBaseUnitMeasure(BaseUnitMeasureType value) Sets the value of the baseUnitMeasure property.
void	setCalculationSequenceNumeric(CalculationSequenceNumericType value) Sets the value of the calculationSequenceNumeric property.
void	setPercent(PercentType value) Sets the value of the percent property.
void	setPerUnitAmount(PerUnitAmountType value) Sets the value of the perUnitAmount property.
void	setTaxableAmount(TaxableAmountType value) Sets the value of the taxableAmount property.
void	setTaxAmount(TaxAmountType value) Sets the value of the taxAmount property.
void	setTaxCategory(TaxCategoryType value) Sets the value of the taxCategory property.
void	setTierRange(TierRangeType value) Sets the value of the tierRange property.
void	setTierRatePercent(TierRatePercentType value) Sets the value of the tierRatePercent property.
void	setTransactionCurrencyTaxAmount(TransactionCurrencyTaxAmountType value) Sets the value of the transactionCurrencyTaxAmount property.

Methods inherited from class java.lang.Object

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

Field Detail

taxableAmount

protected TaxableAmountType taxableAmount

taxAmount

protected TaxAmountType taxAmount

calculationSequenceNumeric

protected CalculationSequenceNumericType calculationSequenceNumeric

transactionCurrencyTaxAmount

protected TransactionCurrencyTaxAmountType transactionCurrencyTaxAmount

percent

protected PercentType percent

baseUnitMeasure

protected BaseUnitMeasureType baseUnitMeasure

perUnitAmount

protected PerUnitAmountType perUnitAmount

tierRange

protected TierRangeType tierRange

tierRatePercent

protected TierRatePercentType tierRatePercent

taxCategory

protected TaxCategoryType taxCategory

Constructor Detail

TaxSubtotalType

public TaxSubtotalType()

Method Detail

getTaxableAmount

public TaxableAmountType getTaxableAmount()

 <?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>Tax Subtotal. Taxable_ Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The net amount to which the tax percent (rate) is applied to calculate the tax amount.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Taxable</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is TaxableAmountType

setTaxableAmount

public void setTaxableAmount(TaxableAmountType value)

Sets the value of the taxableAmount property.

Parameters:

value - allowed object is TaxableAmountType

getTaxAmount

public TaxAmountType getTaxAmount()

 <?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>Tax Subtotal. Tax Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The amount of this tax subtotal.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tax Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is TaxAmountType

setTaxAmount

public void setTaxAmount(TaxAmountType value)

Sets the value of the taxAmount property.

Parameters:

value - allowed object is TaxAmountType

getCalculationSequenceNumeric

public CalculationSequenceNumericType getCalculationSequenceNumeric()

 <?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>Tax Subtotal. Calculation Sequence. Numeric</ccts:DictionaryEntryName>
                      <ccts:Definition>The number of this tax subtotal in the sequence of subtotals corresponding to the order in which multiple taxes are applied. If all taxes are applied to the same taxable amount (i.e., their order of application is inconsequential), then CalculationSequenceNumeric is 1 for all tax subtotals applied to a given amount.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTerm>Calculation Sequence</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Numeric</ccts:RepresentationTerm>
                      <ccts:DataType>Numeric. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is CalculationSequenceNumericType

setCalculationSequenceNumeric

public void setCalculationSequenceNumeric(CalculationSequenceNumericType value)

Sets the value of the calculationSequenceNumeric property.

Parameters:

value - allowed object is CalculationSequenceNumericType

getTransactionCurrencyTaxAmount

public TransactionCurrencyTaxAmountType getTransactionCurrencyTaxAmount()

 <?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>Tax Subtotal. Transaction Currency_ Tax Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>The amount of this tax subtotal, expressed in the currency used for invoicing.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Transaction Currency</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Tax Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is TransactionCurrencyTaxAmountType

setTransactionCurrencyTaxAmount

public void setTransactionCurrencyTaxAmount(TransactionCurrencyTaxAmountType value)

Sets the value of the transactionCurrencyTaxAmount property.

Parameters:

value - allowed object is TransactionCurrencyTaxAmountType

getPercent

public PercentType getPercent()

 <?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>Tax Subtotal. Percent</ccts:DictionaryEntryName>
                      <ccts:Definition>The tax rate of the tax category applied to this tax subtotal, expressed as a percentage.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTerm>Percent</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Percent</ccts:RepresentationTerm>
                      <ccts:DataType>Percent. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is PercentType

setPercent

public void setPercent(PercentType value)

Sets the value of the percent property.

Parameters:

value - allowed object is PercentType

getBaseUnitMeasure

public BaseUnitMeasureType getBaseUnitMeasure()

 <?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>Tax Subtotal. Base Unit Measure. Measure</ccts:DictionaryEntryName>
                      <ccts:Definition>The unit of measure on which the tax calculation is based</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTerm>Base Unit Measure</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Measure</ccts:RepresentationTerm>
                      <ccts:DataType>Measure. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is BaseUnitMeasureType

setBaseUnitMeasure

public void setBaseUnitMeasure(BaseUnitMeasureType value)

Sets the value of the baseUnitMeasure property.

Parameters:

value - allowed object is BaseUnitMeasureType

getPerUnitAmount

public PerUnitAmountType getPerUnitAmount()

 <?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>Tax Subtotal. Per Unit_ Amount. Amount</ccts:DictionaryEntryName>
                      <ccts:Definition>Where a tax is applied at a certain rate per unit, the rate per unit applied.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTermQualifier>Per Unit</ccts:PropertyTermQualifier>
                      <ccts:PropertyTerm>Amount</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Amount</ccts:RepresentationTerm>
                      <ccts:DataType>Amount. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is PerUnitAmountType

setPerUnitAmount

public void setPerUnitAmount(PerUnitAmountType value)

Sets the value of the perUnitAmount property.

Parameters:

value - allowed object is PerUnitAmountType

getTierRange

public TierRangeType getTierRange()

 <?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>Tax Subtotal. Tier Range. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>Where a tax is tiered, the range of taxable amounts that determines the rate of tax applicable to this tax subtotal.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tier Range</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is TierRangeType

setTierRange

public void setTierRange(TierRangeType value)

Sets the value of the tierRange property.

Parameters:

value - allowed object is TierRangeType

getTierRatePercent

public TierRatePercentType getTierRatePercent()

 <?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>Tax Subtotal. Tier Rate. Percent</ccts:DictionaryEntryName>
                      <ccts:Definition>Where a tax is tiered, the tax rate that applies within a specified range of taxable amounts for this tax subtotal.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tier Rate</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Percent</ccts:RepresentationTerm>
                      <ccts:DataType>Percent. Type</ccts:DataType>
                   </ccts:Component>
 

Returns:

possible object is TierRatePercentType

setTierRatePercent

public void setTierRatePercent(TierRatePercentType value)

Sets the value of the tierRatePercent property.

Parameters:

value - allowed object is TierRatePercentType

getTaxCategory

public TaxCategoryType getTaxCategory()

 <?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>ASBIE</ccts:ComponentType>
                      <ccts:DictionaryEntryName>Tax Subtotal. Tax Category</ccts:DictionaryEntryName>
                      <ccts:Definition>The tax category applicable to this subtotal.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Subtotal</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tax Category</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Tax Category</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Tax Category</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is TaxCategoryType

setTaxCategory

public void setTaxCategory(TaxCategoryType value)

Sets the value of the taxCategory property.

Parameters:

value - allowed object is TaxCategoryType