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

Class CompanyDistanceThresholdModel

java.lang.Object
net.avalara.avatax.rest.client.models.CompanyDistanceThresholdModel
public class CompanyDistanceThresholdModel
extends java.lang.Object
A company-distance-threshold model indicates the distance between a company and the taxing borders of various countries. Distance thresholds are necessary to correctly calculate some value-added taxes. Distance thresholds only apply to sales of goods in certain countries. A distance threshold is applied for each ship-from/ship-to combination of countries. The threshold amount is defined by the ship-to country. Generally, if you have exceeded a distance threshold for taxes between a pair of countries, your tax calculation will be determined to be the rate in the destination country. If you have not exceeded the threshold, your tax calculation will be determined to be the rate in the origin country. The amount of a threshold is not tracked or managed in AvaTax, but the decision of your tax compliance department as to whether you have exceeded this threshold is maintained in this object. By default, you are considered to have exceeded tax thresholds. If you wish to change this default, you can create a company-distance-threshold object to select the correct behavior for this origin/destination tax calculation process.

  • Constructor Summary

    Constructors 
    Constructor Description
    CompanyDistanceThresholdModel()  

  • Method Summary

    Modifier and Type Method Description
    java.lang.Integer getCompanyId()
    Getter for companyId The ID number of the company that defined this distance threshold.
    java.lang.String getDestinationCountry()
    Getter for destinationCountry The destination country for this threshold.
    java.util.Date getEffDate()
    Getter for effDate For distance threshold values that change over time, this is the earliest date for which this distance threshold is valid.
    java.util.Date getEndDate()
    Getter for endDate For distance threshold values that change over time, this is the latest date for which this distance threshold is valid.
    java.lang.Long getId()
    Getter for id A unique ID number representing this distance threshold object.
    java.lang.String getOriginCountry()
    Getter for originCountry The origin country for this threshold.
    java.lang.Boolean getThresholdExceeded()
    Getter for thresholdExceeded True if your tax professional has determined that the value-added tax distance threshold is exceeded for this pair of countries.
    java.lang.String getType()
    Getter for type Indicates the distance threshold type.
    void setCompanyId​(java.lang.Integer value)
    Setter for companyId The ID number of the company that defined this distance threshold.
    void setDestinationCountry​(java.lang.String value)
    Setter for destinationCountry The destination country for this threshold.
    void setEffDate​(java.util.Date value)
    Setter for effDate For distance threshold values that change over time, this is the earliest date for which this distance threshold is valid.
    void setEndDate​(java.util.Date value)
    Setter for endDate For distance threshold values that change over time, this is the latest date for which this distance threshold is valid.
    void setId​(java.lang.Long value)
    Setter for id A unique ID number representing this distance threshold object.
    void setOriginCountry​(java.lang.String value)
    Setter for originCountry The origin country for this threshold.
    void setThresholdExceeded​(java.lang.Boolean value)
    Setter for thresholdExceeded True if your tax professional has determined that the value-added tax distance threshold is exceeded for this pair of countries.
    void setType​(java.lang.String value)
    Setter for type Indicates the distance threshold type.
    java.lang.String toString()
    Returns a JSON string representation of CompanyDistanceThresholdModel

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • getId

      public java.lang.Long getId()
      Getter for id A unique ID number representing this distance threshold object.

    • setId

      public void setId​(java.lang.Long value)
      Setter for id A unique ID number representing this distance threshold object.

    • getCompanyId

      public java.lang.Integer getCompanyId()
      Getter for companyId The ID number of the company that defined this distance threshold.

    • setCompanyId

      public void setCompanyId​(java.lang.Integer value)
      Setter for companyId The ID number of the company that defined this distance threshold.

    • getOriginCountry

      public java.lang.String getOriginCountry()
      Getter for originCountry The origin country for this threshold. 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`.

    • setOriginCountry

      public void setOriginCountry​(java.lang.String value)
      Setter for originCountry The origin country for this threshold. 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`.

    • getDestinationCountry

      public java.lang.String getDestinationCountry()
      Getter for destinationCountry The destination country for this threshold. 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`.

    • setDestinationCountry

      public void setDestinationCountry​(java.lang.String value)
      Setter for destinationCountry The destination country for this threshold. 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`.

    • getEffDate

      public java.util.Date getEffDate()
      Getter for effDate For distance threshold values that change over time, this is the earliest date for which this distance threshold is valid. If null, this distance threshold is valid for all dates earlier than the `endDate` field.

    • setEffDate

      public void setEffDate​(java.util.Date value)
      Setter for effDate For distance threshold values that change over time, this is the earliest date for which this distance threshold is valid. If null, this distance threshold is valid for all dates earlier than the `endDate` field.

    • getEndDate

      public java.util.Date getEndDate()
      Getter for endDate For distance threshold values that change over time, this is the latest date for which this distance threshold is valid. If null, this distance threshold is valid for all dates later than the `effDate` field.

    • setEndDate

      public void setEndDate​(java.util.Date value)
      Setter for endDate For distance threshold values that change over time, this is the latest date for which this distance threshold is valid. If null, this distance threshold is valid for all dates later than the `effDate` field.

    • getThresholdExceeded

      public java.lang.Boolean getThresholdExceeded()
      Getter for thresholdExceeded True if your tax professional has determined that the value-added tax distance threshold is exceeded for this pair of countries. If you set this value to `false`, your value added taxes will be calculated using the origin country. Otherwise, value added taxes will be calculated on the destination country.

    • setThresholdExceeded

      public void setThresholdExceeded​(java.lang.Boolean value)
      Setter for thresholdExceeded True if your tax professional has determined that the value-added tax distance threshold is exceeded for this pair of countries. If you set this value to `false`, your value added taxes will be calculated using the origin country. Otherwise, value added taxes will be calculated on the destination country.

    • getType

      public java.lang.String getType()
      Getter for type Indicates the distance threshold type. This value can be either `Sale` or `Purchase`.

    • setType

      public void setType​(java.lang.String value)
      Setter for type Indicates the distance threshold type. This value can be either `Sale` or `Purchase`.

    • toString

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