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

Class TaxCategoryType

java.lang.Object

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

public class TaxCategoryType
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 Category. Details</ccts:DictionaryEntryName>
                <ccts:Definition>A class to describe one of the tax categories within a taxation scheme (e.g., High Rate VAT, Low Rate VAT).</ccts:Definition>
                <ccts:ObjectClass>Tax Category</ccts:ObjectClass>
             </ccts:Component>
 

Java class for TaxCategoryType complex type.

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

 <complexType name="TaxCategoryType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}ID" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}Name" 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}TaxExemptionReasonCode" minOccurs="0"/>
         <element ref="{urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2}TaxExemptionReason" maxOccurs="unbounded" 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}TaxScheme"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected BaseUnitMeasureType	baseUnitMeasure
protected IDType	id
protected NameType	name
protected PercentType	percent
protected PerUnitAmountType	perUnitAmount
protected List<TaxExemptionReasonType>	taxExemptionReason
protected TaxExemptionReasonCodeType	taxExemptionReasonCode
protected TaxSchemeType	taxScheme
protected TierRangeType	tierRange
protected TierRatePercentType	tierRatePercent

Constructor Summary

Constructors

Constructor and Description
TaxCategoryType()

Method Summary

Modifier and Type	Method and Description
BaseUnitMeasureType	getBaseUnitMeasure() <?
IDType	getID() <?
NameType	getName() <?
PercentType	getPercent() <?
PerUnitAmountType	getPerUnitAmount() <?
List<TaxExemptionReasonType>	getTaxExemptionReason() <?
TaxExemptionReasonCodeType	getTaxExemptionReasonCode() <?
TaxSchemeType	getTaxScheme() <?
TierRangeType	getTierRange() <?
TierRatePercentType	getTierRatePercent() <?
void	setBaseUnitMeasure(BaseUnitMeasureType value) Sets the value of the baseUnitMeasure property.
void	setID(IDType value) Sets the value of the id property.
void	setName(NameType value) Sets the value of the name property.
void	setPercent(PercentType value) Sets the value of the percent property.
void	setPerUnitAmount(PerUnitAmountType value) Sets the value of the perUnitAmount property.
void	setTaxExemptionReasonCode(TaxExemptionReasonCodeType value) Sets the value of the taxExemptionReasonCode property.
void	setTaxScheme(TaxSchemeType value) Sets the value of the taxScheme property.
void	setTierRange(TierRangeType value) Sets the value of the tierRange property.
void	setTierRatePercent(TierRatePercentType value) Sets the value of the tierRatePercent property.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected IDType id

name

protected NameType name

percent

protected PercentType percent

baseUnitMeasure

protected BaseUnitMeasureType baseUnitMeasure

perUnitAmount

protected PerUnitAmountType perUnitAmount

taxExemptionReasonCode

protected TaxExemptionReasonCodeType taxExemptionReasonCode

taxExemptionReason

protected List<TaxExemptionReasonType> taxExemptionReason

tierRange

protected TierRangeType tierRange

tierRatePercent

protected TierRatePercentType tierRatePercent

taxScheme

protected TaxSchemeType taxScheme

Constructor Detail

TaxCategoryType

public TaxCategoryType()

Method Detail

getID

public IDType getID()

 <?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 Category. Identifier</ccts:DictionaryEntryName>
                      <ccts:Definition>An identifier for this tax category.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Category</ccts:ObjectClass>
                      <ccts:PropertyTerm>Identifier</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Identifier</ccts:RepresentationTerm>
                      <ccts:DataType>Identifier. Type</ccts:DataType>
                      <ccts:Examples>http://www.unece.org/uncefact/codelist/standard/UNECE_DutyorTaxorFeeCategoryCode_D09B.xsd</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is IDType

setID

public void setID(IDType value)

Sets the value of the id property.

Parameters:

value - allowed object is IDType

getName

public NameType getName()

 <?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 Category. Name</ccts:DictionaryEntryName>
                      <ccts:Definition>The name of this tax category.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Category</ccts:ObjectClass>
                      <ccts:PropertyTerm>Name</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Name</ccts:RepresentationTerm>
                      <ccts:DataType>Name. Type</ccts:DataType>
                      <ccts:Examples>Luxury Goods , Wine Equalization , Exempt </ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is NameType

setName

public void setName(NameType value)

Sets the value of the name property.

Parameters:

value - allowed object is NameType

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 Category. Percent</ccts:DictionaryEntryName>
                      <ccts:Definition>The tax rate for this category, expressed as a percentage.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Category</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 Category. Base Unit Measure. Measure</ccts:DictionaryEntryName>
                      <ccts:Definition>A Unit of Measures used as the basic for the tax calculation applied at a certain rate per unit.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Category</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 Category. 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 Category</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

getTaxExemptionReasonCode

public TaxExemptionReasonCodeType getTaxExemptionReasonCode()

 <?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 Category. Tax Exemption Reason Code. Code</ccts:DictionaryEntryName>
                      <ccts:Definition>The reason for tax being exempted, expressed as a code.</ccts:Definition>
                      <ccts:Cardinality>0..1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Category</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tax Exemption Reason Code</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Code</ccts:RepresentationTerm>
                      <ccts:DataType>Code. Type</ccts:DataType>
                      <ccts:Examples>http://www.unece.org/uncefact/codelist/standard/UNECE_DutyTaxFeeTypeCode_D09B.xsd</ccts:Examples>
                   </ccts:Component>
 

Returns:

possible object is TaxExemptionReasonCodeType

setTaxExemptionReasonCode

public void setTaxExemptionReasonCode(TaxExemptionReasonCodeType value)

Sets the value of the taxExemptionReasonCode property.

Parameters:

value - allowed object is TaxExemptionReasonCodeType

getTaxExemptionReason

public List<TaxExemptionReasonType> getTaxExemptionReason()

 <?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 Category. Tax Exemption Reason. Text</ccts:DictionaryEntryName>
                      <ccts:Definition>The reason for tax being exempted, expressed as text.</ccts:Definition>
                      <ccts:Cardinality>0..n</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Category</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tax Exemption Reason</ccts:PropertyTerm>
                      <ccts:RepresentationTerm>Text</ccts:RepresentationTerm>
                      <ccts:DataType>Text. Type</ccts:DataType>
                   </ccts:Component>
 

Gets the value of the taxExemptionReason property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the taxExemptionReason property.

For example, to add a new item, do as follows:

    getTaxExemptionReason().add(newItem);
 

Objects of the following type(s) are allowed in the list TaxExemptionReasonType

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

getTaxScheme

public TaxSchemeType getTaxScheme()

 <?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 Category. Tax Scheme</ccts:DictionaryEntryName>
                      <ccts:Definition>The taxation scheme within which this tax category is defined.</ccts:Definition>
                      <ccts:Cardinality>1</ccts:Cardinality>
                      <ccts:ObjectClass>Tax Category</ccts:ObjectClass>
                      <ccts:PropertyTerm>Tax Scheme</ccts:PropertyTerm>
                      <ccts:AssociatedObjectClass>Tax Scheme</ccts:AssociatedObjectClass>
                      <ccts:RepresentationTerm>Tax Scheme</ccts:RepresentationTerm>
                   </ccts:Component>
 

Returns:

possible object is TaxSchemeType

setTaxScheme

public void setTaxScheme(TaxSchemeType value)

Sets the value of the taxScheme property.

Parameters:

value - allowed object is TaxSchemeType