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

Class DeclareNexusByAddressModel

java.lang.Object
net.avalara.avatax.rest.client.models.DeclareNexusByAddressModel
public class DeclareNexusByAddressModel
extends java.lang.Object
Use this object to provide an address and date range where your company does business. This address will be used to determine what jurisdictions you should declare nexus and calculate tax.

  • Constructor Summary

    Constructors 
    Constructor Description
    DeclareNexusByAddressModel()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getCity()
    Getter for city City component of the address
    java.lang.String getCountry()
    Getter for country Name or ISO 3166 code identifying the country.
    java.util.Date getEffectiveDate()
    Getter for effectiveDate The earliest date on which your company does business at this address.
    java.util.Date getEndDate()
    Getter for endDate The date on which your company stopped doing business at this address, or empty if your company has no plans to stop doing business at this address.
    java.math.BigDecimal getLatitude()
    Getter for latitude Geospatial latitude measurement, in Decimal Degrees floating point format.
    java.lang.String getLine1()
    Getter for line1 First line of the street address
    java.lang.String getLine2()
    Getter for line2 Second line of the street address
    java.lang.String getLine3()
    Getter for line3 Third line of the street address
    java.math.BigDecimal getLongitude()
    Getter for longitude Geospatial longitude measurement, in Decimal Degrees floating point format.
    java.lang.String getNexusTaxTypeGroup()
    Getter for nexusTaxTypeGroup The type of nexus that this company is declaring.Replaces NexusTypeId.
    java.lang.String getPostalCode()
    Getter for postalCode Postal Code / Zip Code component of the address.
    java.lang.String getRegion()
    Getter for region Name or ISO 3166 code identifying the region within the country.
    java.lang.String getTaxTypeGroup()
    Getter for taxTypeGroup The type group of nexus that this company is declaring Use [ListTaxTypeGroups](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListTaxTypeGroups/) API for a list of nexus tax type groups.
    TextCase getTextCase()
    Getter for textCase Specify the text case for the validated address result.
    void setCity​(java.lang.String value)
    Setter for city City component of the address
    void setCountry​(java.lang.String value)
    Setter for country Name or ISO 3166 code identifying the country.
    void setEffectiveDate​(java.util.Date value)
    Setter for effectiveDate The earliest date on which your company does business at this address.
    void setEndDate​(java.util.Date value)
    Setter for endDate The date on which your company stopped doing business at this address, or empty if your company has no plans to stop doing business at this address.
    void setLatitude​(java.math.BigDecimal value)
    Setter for latitude Geospatial latitude measurement, in Decimal Degrees floating point format.
    void setLine1​(java.lang.String value)
    Setter for line1 First line of the street address
    void setLine2​(java.lang.String value)
    Setter for line2 Second line of the street address
    void setLine3​(java.lang.String value)
    Setter for line3 Third line of the street address
    void setLongitude​(java.math.BigDecimal value)
    Setter for longitude Geospatial longitude measurement, in Decimal Degrees floating point format.
    void setNexusTaxTypeGroup​(java.lang.String value)
    Setter for nexusTaxTypeGroup The type of nexus that this company is declaring.Replaces NexusTypeId.
    void setPostalCode​(java.lang.String value)
    Setter for postalCode Postal Code / Zip Code component of the address.
    void setRegion​(java.lang.String value)
    Setter for region Name or ISO 3166 code identifying the region within the country.
    void setTaxTypeGroup​(java.lang.String value)
    Setter for taxTypeGroup The type group of nexus that this company is declaring Use [ListTaxTypeGroups](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListTaxTypeGroups/) API for a list of nexus tax type groups.
    void setTextCase​(TextCase value)
    Setter for textCase Specify the text case for the validated address result.
    java.lang.String toString()
    Returns a JSON string representation of DeclareNexusByAddressModel

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • getEffectiveDate

      public java.util.Date getEffectiveDate()
      Getter for effectiveDate The earliest date on which your company does business at this address. If you omit a value in this field, nexus will be declared at the earliest possible date for this jurisdiction.

    • setEffectiveDate

      public void setEffectiveDate​(java.util.Date value)
      Setter for effectiveDate The earliest date on which your company does business at this address. If you omit a value in this field, nexus will be declared at the earliest possible date for this jurisdiction.

    • getEndDate

      public java.util.Date getEndDate()
      Getter for endDate The date on which your company stopped doing business at this address, or empty if your company has no plans to stop doing business at this address.

    • setEndDate

      public void setEndDate​(java.util.Date value)
      Setter for endDate The date on which your company stopped doing business at this address, or empty if your company has no plans to stop doing business at this address.

    • getTaxTypeGroup

      public java.lang.String getTaxTypeGroup()
      Getter for taxTypeGroup The type group of nexus that this company is declaring Use [ListTaxTypeGroups](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListTaxTypeGroups/) API for a list of nexus tax type groups. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. NOTE: This optional field will trigger nexus subtype lookup when populated. When using make sure TaxTypeGroup matches corresponding NexusTaxTypeGroup

    • setTaxTypeGroup

      public void setTaxTypeGroup​(java.lang.String value)
      Setter for taxTypeGroup The type group of nexus that this company is declaring Use [ListTaxTypeGroups](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListTaxTypeGroups/) API for a list of nexus tax type groups. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`. NOTE: This optional field will trigger nexus subtype lookup when populated. When using make sure TaxTypeGroup matches corresponding NexusTaxTypeGroup

    • getNexusTaxTypeGroup

      public java.lang.String getNexusTaxTypeGroup()
      Getter for nexusTaxTypeGroup The type of nexus that this company is declaring.Replaces NexusTypeId. Use [ListNexusTaxTypeGroups](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListNexusTaxTypeGroups/) API for a list of nexus tax type groups. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

    • setNexusTaxTypeGroup

      public void setNexusTaxTypeGroup​(java.lang.String value)
      Setter for nexusTaxTypeGroup The type of nexus that this company is declaring.Replaces NexusTypeId. Use [ListNexusTaxTypeGroups](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListNexusTaxTypeGroups/) API for a list of nexus tax type groups. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

    • getLine1

      public java.lang.String getLine1()
      Getter for line1 First line of the street address

    • setLine1

      public void setLine1​(java.lang.String value)
      Setter for line1 First line of the street address

    • getTextCase

      public TextCase getTextCase()
      Getter for textCase Specify the text case for the validated address result. If not specified, will return uppercase.

    • setTextCase

      public void setTextCase​(TextCase value)
      Setter for textCase Specify the text case for the validated address result. If not specified, will return uppercase.

    • getLine2

      public java.lang.String getLine2()
      Getter for line2 Second line of the street address

    • setLine2

      public void setLine2​(java.lang.String value)
      Setter for line2 Second line of the street address

    • getLine3

      public java.lang.String getLine3()
      Getter for line3 Third line of the street address

    • setLine3

      public void setLine3​(java.lang.String value)
      Setter for line3 Third line of the street address

    • getCity

      public java.lang.String getCity()
      Getter for city City component of the address

    • setCity

      public void setCity​(java.lang.String value)
      Setter for city City component of the address

    • getRegion

      public java.lang.String getRegion()
      Getter for region Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.

    • setRegion

      public void setRegion​(java.lang.String value)
      Setter for region Name or ISO 3166 code identifying the region within the country. This field supports many different region identifiers: * Two and three character ISO 3166 region codes * Fully spelled out names of the region in ISO supported languages * Common alternative spellings for many regions For a full list of all supported codes and names, please see the Definitions API `ListRegions`.

    • getCountry

      public java.lang.String getCountry()
      Getter for country Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.

    • setCountry

      public void setCountry​(java.lang.String value)
      Setter for country Name or ISO 3166 code identifying the country. This field supports many different country identifiers: * Two character ISO 3166 codes * Three character ISO 3166 codes * Fully spelled out names of the country in ISO supported languages * Common alternative spellings for many countries For a full list of all supported codes and names, please see the Definitions API `ListCountries`.

    • getPostalCode

      public java.lang.String getPostalCode()
      Getter for postalCode Postal Code / Zip Code component of the address.

    • setPostalCode

      public void setPostalCode​(java.lang.String value)
      Setter for postalCode Postal Code / Zip Code component of the address.

    • getLatitude

      public java.math.BigDecimal getLatitude()
      Getter for latitude Geospatial latitude measurement, in Decimal Degrees floating point format.

    • setLatitude

      public void setLatitude​(java.math.BigDecimal value)
      Setter for latitude Geospatial latitude measurement, in Decimal Degrees floating point format.

    • getLongitude

      public java.math.BigDecimal getLongitude()
      Getter for longitude Geospatial longitude measurement, in Decimal Degrees floating point format.

    • setLongitude

      public void setLongitude​(java.math.BigDecimal value)
      Setter for longitude Geospatial longitude measurement, in Decimal Degrees floating point format.

    • toString

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