Module jonix.onix2

Package com.tectonica.jonix.onix2

Class TaxRateCode1

java.lang.Object

com.tectonica.jonix.onix2.TaxRateCode1

All Implemented Interfaces:

OnixElement<TaxRateTypes>, OnixTag, Serializable

public class TaxRateCode1
extends Object
implements OnixElement<TaxRateTypes>, Serializable

Tax rate 1, coded

A code which specifies a value added tax rate applying to the whole of the price, or to the amount of the price which is specified in <TaxableAmount1> if present. Optional and non-repeating.

If the product is taxable at a single rate, or is wholly exempt or zero-rated, <TaxRateCode1> may be sent on its own, or with any combination of <TaxRatePercent1>, <TaxableAmount1> and <TaxAmount1>, although it is best practise to send all these three elements.

If the product carries mixed tax rates, the minimum requirement is to send <TaxRateCode1>, <TaxRateCode2>, <TaxableAmount1> and <TaxableAmount2>, though again best practise would be to send all eight tax elements so that the tax calculation is made entirely explicit.

Format	Fixed-length, one letter.
Codelist	List 62
Reference name	<TaxRateCode1>
Short tag	<j153>
Example	<TaxRateCode1>Z</TaxRateCode1> Zero-rated

This tag may be included in the following composites:

• <Price>

Possible placements within ONIX message:

• Product ⯈ SupplyDetail ⯈ Price ⯈ TaxRateCode1
• Product ⯈ SupplyDetail ⯈ Reissue ⯈ Price ⯈ TaxRateCode1

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
String	datestamp	(type: DateOrDateTime)
static final TaxRateCode1	EMPTY
Languages	language
static final String	refname
static final String	shortname
String	sourcename
RecordSourceTypes	sourcetype
TextCaseFlags	textcase
TextFormats	textformat
TransliterationSchemes	transliteration
TaxRateTypes	value

Constructor Summary

Constructors

Constructor	Description
TaxRateCode1()
TaxRateCode1(Element element)

Method Summary

Modifier and Type	Method	Description
TaxRateTypes	__v()	Internal API, use the OnixElement.value() method or the OnixElement.value() field instead
String	codeOrNull()
String	descriptionOrNull()
boolean	exists()	indicates whether this tag exists in the ONIX record
void	ifExists(Consumer<TaxRateCode1> action)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tectonica.jonix.common.OnixElement

equal, is, isNull, value

Field Details

refname

public static final String refname

See Also:

• Constant Field Values

shortname

public static final String shortname

See Also:

• Constant Field Values

textformat

public TextFormats textformat

textcase

public TextCaseFlags textcase

language

public Languages language

transliteration

public TransliterationSchemes transliteration

datestamp

public String datestamp

(type: DateOrDateTime)

sourcetype

public RecordSourceTypes sourcetype

sourcename

public String sourcename

value

public TaxRateTypes value

EMPTY

public static final TaxRateCode1 EMPTY

Constructor Details

TaxRateCode1

public TaxRateCode1()

TaxRateCode1

public TaxRateCode1(Element element)

Method Details

__v

public TaxRateTypes __v()

Internal API, use the OnixElement.value() method or the OnixElement.value() field instead

Specified by:

__v in interface OnixElement<TaxRateTypes>

exists

public boolean exists()

Description copied from interface: OnixTag

indicates whether this tag exists in the ONIX record

Specified by:

exists in interface OnixTag

Returns:

whether this tag (<TaxRateCode1> or <j153>) is explicitly provided in the ONIX XML

ifExists

public void ifExists(Consumer<TaxRateCode1> action)

codeOrNull

public String codeOrNull()

descriptionOrNull

public String descriptionOrNull()