Package net.avalara.avatax.rest.client.models

Class HsCodeModel

java.lang.Object
net.avalara.avatax.rest.client.models.HsCodeModel
public class HsCodeModel
extends java.lang.Object
Describes an element in the harmonized tariff system. According to the [United States International Trade Commission](https://www.usitc.gov), the harmonized tariff schedule is defined as follows: The HTS is a U.S. nomenclature system used to classify traded goods based on their material composition, product name, and/or intended function. The HTS is designed so that each article falls into only one category. It is divided into chapters, each of which has a 2-digit number. Each product category within the various chapters is designated by 4, 6, 8, or 10 digits. The 4-digit categories are called "headings." The 6-, 8- and 10-digit classifications are called "subheadings." Within AvaTax, the `HsCodeModel` object can refer to sections, chapters, headings, subheadings, or articles. Each object represents one classification. Many of these objects have child objects underneath them; these child objects are more specific than their parent objects.

  • Constructor Summary

    Constructors 
    Constructor Description
    HsCodeModel()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDescription()
    Getter for description A human readable description that identifies Code descriptive text for this Section, Chapter, Heading, or Subheading.
    java.lang.String getDestinationCountry()
    Getter for destinationCountry The destination country identified with this HS Code.
    java.util.Date getEffDate()
    Getter for effDate For codes that have been expired or defined on specific dates, this value indicates the earliest date for which this code is considered valid.
    java.util.Date getEndDate()
    Getter for endDate For codes that have been expired or defined on specific dates, this value indicates the latest date for which this code is considered valid.
    java.lang.String getHsCode()
    Getter for hsCode The harmonized tariff system code for this section and chapter.
    java.lang.Long getId()
    Getter for id A unique identifier for this harmonized tariff system code.
    java.lang.Long getParentHsCodeId()
    Getter for parentHsCodeId The unique ID number of the parent HS code or HS code prefix.
    java.lang.String getSystem()
    Getter for system The system to which this HS code belongs.
    void setDescription​(java.lang.String value)
    Setter for description A human readable description that identifies Code descriptive text for this Section, Chapter, Heading, or Subheading.
    void setDestinationCountry​(java.lang.String value)
    Setter for destinationCountry The destination country identified with this HS Code.
    void setEffDate​(java.util.Date value)
    Setter for effDate For codes that have been expired or defined on specific dates, this value indicates the earliest date for which this code is considered valid.
    void setEndDate​(java.util.Date value)
    Setter for endDate For codes that have been expired or defined on specific dates, this value indicates the latest date for which this code is considered valid.
    void setHsCode​(java.lang.String value)
    Setter for hsCode The harmonized tariff system code for this section and chapter.
    void setId​(java.lang.Long value)
    Setter for id A unique identifier for this harmonized tariff system code.
    void setParentHsCodeId​(java.lang.Long value)
    Setter for parentHsCodeId The unique ID number of the parent HS code or HS code prefix.
    void setSystem​(java.lang.String value)
    Setter for system The system to which this HS code belongs.
    java.lang.String toString()
    Returns a JSON string representation of HsCodeModel

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • getHsCode

      public java.lang.String getHsCode()
      Getter for hsCode The harmonized tariff system code for this section and chapter. A full HS code contains more than six characters. Partial HS codes with two, four, or six characters may have child codes underneath them. A child code is one that contains greater specificity than a parent code. It is recommended that when you identify a product you use the most detailed code available to identify it. Top level sections do not have HS Codes.

    • setHsCode

      public void setHsCode​(java.lang.String value)
      Setter for hsCode The harmonized tariff system code for this section and chapter. A full HS code contains more than six characters. Partial HS codes with two, four, or six characters may have child codes underneath them. A child code is one that contains greater specificity than a parent code. It is recommended that when you identify a product you use the most detailed code available to identify it. Top level sections do not have HS Codes.

    • getId

      public java.lang.Long getId()
      Getter for id A unique identifier for this harmonized tariff system code. To search for a list of child codes underneath a specific HS code, search for codes where the child's `parentHsCodeId` value matches the parent's `id` value.

    • setId

      public void setId​(java.lang.Long value)
      Setter for id A unique identifier for this harmonized tariff system code. To search for a list of child codes underneath a specific HS code, search for codes where the child's `parentHsCodeId` value matches the parent's `id` value.

    • getParentHsCodeId

      public java.lang.Long getParentHsCodeId()
      Getter for parentHsCodeId The unique ID number of the parent HS code or HS code prefix. To search for a list of child codes underneath a specific HS code, search for codes where the child's `parentHsCodeId` value matches the parent's `id` value.

    • setParentHsCodeId

      public void setParentHsCodeId​(java.lang.Long value)
      Setter for parentHsCodeId The unique ID number of the parent HS code or HS code prefix. To search for a list of child codes underneath a specific HS code, search for codes where the child's `parentHsCodeId` value matches the parent's `id` value.

    • getDescription

      public java.lang.String getDescription()
      Getter for description A human readable description that identifies Code descriptive text for this Section, Chapter, Heading, or Subheading.

    • setDescription

      public void setDescription​(java.lang.String value)
      Setter for description A human readable description that identifies Code descriptive text for this Section, Chapter, Heading, or Subheading.

    • getSystem

      public java.lang.String getSystem()
      Getter for system The system to which this HS code belongs.

    • setSystem

      public void setSystem​(java.lang.String value)
      Setter for system The system to which this HS code belongs.

    • getDestinationCountry

      public java.lang.String getDestinationCountry()
      Getter for destinationCountry The destination country identified with this HS Code. This value applies when certain products are classified in specific ways by bilateral trade agreements.

    • setDestinationCountry

      public void setDestinationCountry​(java.lang.String value)
      Setter for destinationCountry The destination country identified with this HS Code. This value applies when certain products are classified in specific ways by bilateral trade agreements.

    • getEffDate

      public java.util.Date getEffDate()
      Getter for effDate For codes that have been expired or defined on specific dates, this value indicates the earliest date for which this code is considered valid. If this value is null, this code can be used for any valid date earlier than its end date.

    • setEffDate

      public void setEffDate​(java.util.Date value)
      Setter for effDate For codes that have been expired or defined on specific dates, this value indicates the earliest date for which this code is considered valid. If this value is null, this code can be used for any valid date earlier than its end date.

    • getEndDate

      public java.util.Date getEndDate()
      Getter for endDate For codes that have been expired or defined on specific dates, this value indicates the latest date for which this code is considered valid. If this value is null, this code can be used for any valid date later than its effective date.

    • setEndDate

      public void setEndDate​(java.util.Date value)
      Setter for endDate For codes that have been expired or defined on specific dates, this value indicates the latest date for which this code is considered valid. If this value is null, this code can be used for any valid date later than its effective date.

    • toString

      public java.lang.String toString()
      Returns a JSON string representation of HsCodeModel
      Overrides:
      toString in class java.lang.Object