Class DeclareNexusByAddressModel

java.lang.Object
net.avalara.avatax.rest.client.models.DeclareNexusByAddressModel

public class DeclareNexusByAddressModel extends 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
     
  • Method Summary

    Modifier and Type
    Method
    Description
    Getter for city City component of the address
    Getter for country Name or ISO 3166 code identifying the country.
    Getter for effectiveDate The earliest date on which your company does business at this address.
    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.
    Getter for latitude Geospatial latitude measurement, in Decimal Degrees floating point format.
    Getter for line1 First line of the street address
    Getter for line2 Second line of the street address
    Getter for line3 Third line of the street address
    Getter for longitude Geospatial longitude measurement, in Decimal Degrees floating point format.
    Getter for nexusTaxTypeGroup The type of nexus that this company is declaring.Replaces NexusTypeId.
    Getter for postalCode Postal Code / Zip Code component of the address.
    Getter for region Name or ISO 3166 code identifying the region within the country.
    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.
    Getter for textCase Specify the text case for the validated address result.
    void
    setCity(String value)
    Setter for city City component of the address
    void
    Setter for country Name or ISO 3166 code identifying the country.
    void
    Setter for effectiveDate The earliest date on which your company does business at this address.
    void
    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
    Setter for latitude Geospatial latitude measurement, in Decimal Degrees floating point format.
    void
    Setter for line1 First line of the street address
    void
    Setter for line2 Second line of the street address
    void
    Setter for line3 Third line of the street address
    void
    Setter for longitude Geospatial longitude measurement, in Decimal Degrees floating point format.
    void
    Setter for nexusTaxTypeGroup The type of nexus that this company is declaring.Replaces NexusTypeId.
    void
    Setter for postalCode Postal Code / Zip Code component of the address.
    void
    Setter for region Name or ISO 3166 code identifying the region within the country.
    void
    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
    Setter for textCase Specify the text case for the validated address result.
    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

    • DeclareNexusByAddressModel

      public DeclareNexusByAddressModel()
  • Method Details

    • getEffectiveDate

      public 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(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 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(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 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(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 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(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 String getLine1()
      Getter for line1 First line of the street address
    • setLine1

      public void setLine1(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 String getLine2()
      Getter for line2 Second line of the street address
    • setLine2

      public void setLine2(String value)
      Setter for line2 Second line of the street address
    • getLine3

      public String getLine3()
      Getter for line3 Third line of the street address
    • setLine3

      public void setLine3(String value)
      Setter for line3 Third line of the street address
    • getCity

      public String getCity()
      Getter for city City component of the address
    • setCity

      public void setCity(String value)
      Setter for city City component of the address
    • getRegion

      public 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(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 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(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 String getPostalCode()
      Getter for postalCode Postal Code / Zip Code component of the address.
    • setPostalCode

      public void setPostalCode(String value)
      Setter for postalCode Postal Code / Zip Code component of the address.
    • getLatitude

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

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

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

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

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