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

Class NexusModel

  • public class NexusModel
extends java.lang.Object
    Represents a declaration of nexus within a particular taxing jurisdiction. To create a nexus declaration for your company, you must first call the Definitions API `ListNexus` to obtain a list of Avalara-defined nexus. Once you have determined which nexus you wish to declare, you should customize only the user-selectable fields in this object. The user selectable fields for the nexus object are `companyId`, `effectiveDate`, `endDate`, `localNexusTypeId`, `taxId`, `nexusTypeId`, `hasPermanentEstablishment`, and `isSellerImporterOfRecord`. When calling `CreateNexus` or `UpdateNexus`, all values in your nexus object except for the user-selectable fields must match an Avalara-defined system nexus object. You can retrieve a list of Avalara-defined system nexus objects by calling `ListNexus`. If any data does not match, AvaTax may not recognize your nexus declaration.

    • Constructor Summary

      Constructors 
      Constructor Description
      NexusModel()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Integer getCompanyId()
      Getter for companyId The unique ID number of the company that declared nexus.
      java.lang.String getCountry()
      Getter for country Name or ISO 3166 code identifying the country in which this company declared nexus.
      java.util.Date getCreatedDate()
      Getter for createdDate The date when this record was created.
      java.lang.Integer getCreatedUserId()
      Getter for createdUserId The User ID of the user who created this record.
      java.util.Date getEffectiveDate()
      Getter for effectiveDate The date when this nexus began.
      java.util.Date getEndDate()
      Getter for endDate If this nexus will end or has ended on a specific date, set this to the date when this nexus ends.
      java.lang.Boolean getHasLocalNexus()
      Getter for hasLocalNexus True if you are also declaring local nexus within this jurisdiction.
      java.lang.Boolean getHasPermanentEstablishment()
      Getter for hasPermanentEstablishment Set this value to true if your company has a permanent establishment within this jurisdiction.
      java.lang.Integer getId()
      Getter for id The unique ID number of this declaration of nexus.
      java.lang.Boolean getIsSellerImporterOfRecord()
      Getter for isSellerImporterOfRecord For nexus declarations at the country level, specifies whether this company is considered the importer of record in this nexus region.
      java.lang.Boolean getIsSSTActive()
      Getter for isSSTActive For the United States, this flag indicates whether this particular nexus falls within a U.S.
      java.lang.String getJurisCode()
      Getter for jurisCode The code identifying the jurisdiction in which this company declared nexus.
      JurisdictionType getJurisdictionTypeId()
      Getter for jurisdictionTypeId The type of the jurisdiction in which this company declared nexus.
      java.lang.String getJurisName()
      Getter for jurisName The common name of the jurisdiction in which this company declared nexus.
      JurisTypeId getJurisTypeId()
      Getter for jurisTypeId DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use jurisdictionTypeId instead.
      LocalNexusTypeId getLocalNexusTypeId()
      Getter for localNexusTypeId If you are declaring local nexus within this jurisdiction, this indicates whether you are declaring only a specified list of local jurisdictions, all state-administered local jurisdictions, or all local jurisdictions.
      java.util.Date getModifiedDate()
      Getter for modifiedDate The date/time when this record was last modified.
      java.lang.Integer getModifiedUserId()
      Getter for modifiedUserId The user ID of the user who last modified this record.
      java.lang.String getNexusTaxTypeGroup()
      Getter for nexusTaxTypeGroup The type of nexus that this company is declaring.Replaces NexusTypeId.
      NexusTypeId getNexusTypeId()
      Getter for nexusTypeId The type of nexus that this company is declaring.
      java.util.ArrayList<NexusParameterDetailModel> getParameters()
      Getter for parameters List of nexus parameters.
      java.lang.String getRegion()
      Getter for region Name or ISO 3166 code identifying the region within the country.
      java.lang.String getShortName()
      Getter for shortName The short name of the jurisdiction.
      java.lang.String getSignatureCode()
      Getter for signatureCode The signature code of the boundary region as defined by Avalara.
      Sourcing getSourcing()
      Getter for sourcing Indicates whether this nexus is defined as origin or destination nexus.
      java.lang.String getStateAssignedNo()
      Getter for stateAssignedNo The state assigned number of this jurisdiction.
      java.lang.Boolean getStreamlinedSalesTax()
      Getter for streamlinedSalesTax DEPRECATED - Date: 4/29/2017, Version: 19.4, Message: Please use isSSTActive instead.
      java.lang.Boolean getTaxableNexus()
      Getter for taxableNexus Shows if system nexus records are associated with tax collection
      java.lang.Long getTaxAuthorityId()
      Getter for taxAuthorityId A unique ID number of the tax authority that is associated with this nexus.
      java.lang.String getTaxId()
      Getter for taxId Optional - the tax identification number under which you declared nexus.
      java.lang.String getTaxName()
      Getter for taxName A description of corresponding tax type applied to the nexus.
      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.
      void setCompanyId​(java.lang.Integer value)
      Setter for companyId The unique ID number of the company that declared nexus.
      void setCountry​(java.lang.String value)
      Setter for country Name or ISO 3166 code identifying the country in which this company declared nexus.
      void setCreatedDate​(java.util.Date value)
      Setter for createdDate The date when this record was created.
      void setCreatedUserId​(java.lang.Integer value)
      Setter for createdUserId The User ID of the user who created this record.
      void setEffectiveDate​(java.util.Date value)
      Setter for effectiveDate The date when this nexus began.
      void setEndDate​(java.util.Date value)
      Setter for endDate If this nexus will end or has ended on a specific date, set this to the date when this nexus ends.
      void setHasLocalNexus​(java.lang.Boolean value)
      Setter for hasLocalNexus True if you are also declaring local nexus within this jurisdiction.
      void setHasPermanentEstablishment​(java.lang.Boolean value)
      Setter for hasPermanentEstablishment Set this value to true if your company has a permanent establishment within this jurisdiction.
      void setId​(java.lang.Integer value)
      Setter for id The unique ID number of this declaration of nexus.
      void setIsSellerImporterOfRecord​(java.lang.Boolean value)
      Setter for isSellerImporterOfRecord For nexus declarations at the country level, specifies whether this company is considered the importer of record in this nexus region.
      void setIsSSTActive​(java.lang.Boolean value)
      Setter for isSSTActive For the United States, this flag indicates whether this particular nexus falls within a U.S.
      void setJurisCode​(java.lang.String value)
      Setter for jurisCode The code identifying the jurisdiction in which this company declared nexus.
      void setJurisdictionTypeId​(JurisdictionType value)
      Setter for jurisdictionTypeId The type of the jurisdiction in which this company declared nexus.
      void setJurisName​(java.lang.String value)
      Setter for jurisName The common name of the jurisdiction in which this company declared nexus.
      void setJurisTypeId​(JurisTypeId value)
      Setter for jurisTypeId DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use jurisdictionTypeId instead.
      void setLocalNexusTypeId​(LocalNexusTypeId value)
      Setter for localNexusTypeId If you are declaring local nexus within this jurisdiction, this indicates whether you are declaring only a specified list of local jurisdictions, all state-administered local jurisdictions, or all local jurisdictions.
      void setModifiedDate​(java.util.Date value)
      Setter for modifiedDate The date/time when this record was last modified.
      void setModifiedUserId​(java.lang.Integer value)
      Setter for modifiedUserId The user ID of the user who last modified this record.
      void setNexusTaxTypeGroup​(java.lang.String value)
      Setter for nexusTaxTypeGroup The type of nexus that this company is declaring.Replaces NexusTypeId.
      void setNexusTypeId​(NexusTypeId value)
      Setter for nexusTypeId The type of nexus that this company is declaring.
      void setParameters​(java.util.ArrayList<NexusParameterDetailModel> value)
      Setter for parameters List of nexus parameters.
      void setRegion​(java.lang.String value)
      Setter for region Name or ISO 3166 code identifying the region within the country.
      void setShortName​(java.lang.String value)
      Setter for shortName The short name of the jurisdiction.
      void setSignatureCode​(java.lang.String value)
      Setter for signatureCode The signature code of the boundary region as defined by Avalara.
      void setSourcing​(Sourcing value)
      Setter for sourcing Indicates whether this nexus is defined as origin or destination nexus.
      void setStateAssignedNo​(java.lang.String value)
      Setter for stateAssignedNo The state assigned number of this jurisdiction.
      void setStreamlinedSalesTax​(java.lang.Boolean value)
      Setter for streamlinedSalesTax DEPRECATED - Date: 4/29/2017, Version: 19.4, Message: Please use isSSTActive instead.
      void setTaxableNexus​(java.lang.Boolean value)
      Setter for taxableNexus Shows if system nexus records are associated with tax collection
      void setTaxAuthorityId​(java.lang.Long value)
      Setter for taxAuthorityId A unique ID number of the tax authority that is associated with this nexus.
      void setTaxId​(java.lang.String value)
      Setter for taxId Optional - the tax identification number under which you declared nexus.
      void setTaxName​(java.lang.String value)
      Setter for taxName A description of corresponding tax type applied to the nexus.
      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.
      java.lang.String toString()
      Returns a JSON string representation of NexusModel

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • NexusModel

        public NexusModel()

    • Method Detail

      • getId

        public java.lang.Integer getId()
        Getter for id The unique ID number of this declaration of nexus. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • setId

        public void setId​(java.lang.Integer value)
        Setter for id The unique ID number of this declaration of nexus. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • getCompanyId

        public java.lang.Integer getCompanyId()
        Getter for companyId The unique ID number of the company that declared nexus. This field is user-selectable and should be provided when creating or updating a nexus object.

      • setCompanyId

        public void setCompanyId​(java.lang.Integer value)
        Setter for companyId The unique ID number of the company that declared nexus. This field is user-selectable and should be provided when creating or updating a nexus object.

      • getCountry

        public java.lang.String getCountry()
        Getter for country Name or ISO 3166 code identifying the country in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setCountry

        public void setCountry​(java.lang.String value)
        Setter for country Name or ISO 3166 code identifying the country in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getRegion

        public java.lang.String getRegion()
        Getter for region Name or ISO 3166 code identifying the region within the country. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setRegion

        public void setRegion​(java.lang.String value)
        Setter for region Name or ISO 3166 code identifying the region within the country. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getJurisTypeId

        public JurisTypeId getJurisTypeId()
        Getter for jurisTypeId DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use jurisdictionTypeId instead. The jurisdiction type of the jurisdiction in which this company declared nexus.

      • setJurisTypeId

        public void setJurisTypeId​(JurisTypeId value)
        Setter for jurisTypeId DEPRECATED - Date: 12/20/2017, Version: 18.1, Message: Please use jurisdictionTypeId instead. The jurisdiction type of the jurisdiction in which this company declared nexus.

      • getJurisdictionTypeId

        public JurisdictionType getJurisdictionTypeId()
        Getter for jurisdictionTypeId The type of the jurisdiction in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setJurisdictionTypeId

        public void setJurisdictionTypeId​(JurisdictionType value)
        Setter for jurisdictionTypeId The type of the jurisdiction in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getJurisCode

        public java.lang.String getJurisCode()
        Getter for jurisCode The code identifying the jurisdiction in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setJurisCode

        public void setJurisCode​(java.lang.String value)
        Setter for jurisCode The code identifying the jurisdiction in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getJurisName

        public java.lang.String getJurisName()
        Getter for jurisName The common name of the jurisdiction in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setJurisName

        public void setJurisName​(java.lang.String value)
        Setter for jurisName The common name of the jurisdiction in which this company declared nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getEffectiveDate

        public java.util.Date getEffectiveDate()
        Getter for effectiveDate The date when this nexus began. If not known, set to null. This field is user-selectable and should be provided when creating or updating a nexus object.

      • setEffectiveDate

        public void setEffectiveDate​(java.util.Date value)
        Setter for effectiveDate The date when this nexus began. If not known, set to null. This field is user-selectable and should be provided when creating or updating a nexus object.

      • getEndDate

        public java.util.Date getEndDate()
        Getter for endDate If this nexus will end or has ended on a specific date, set this to the date when this nexus ends. This field is user-selectable and should be provided when creating or updating a nexus object.

      • setEndDate

        public void setEndDate​(java.util.Date value)
        Setter for endDate If this nexus will end or has ended on a specific date, set this to the date when this nexus ends. This field is user-selectable and should be provided when creating or updating a nexus object.

      • getShortName

        public java.lang.String getShortName()
        Getter for shortName The short name of the jurisdiction. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setShortName

        public void setShortName​(java.lang.String value)
        Setter for shortName The short name of the jurisdiction. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getSignatureCode

        public java.lang.String getSignatureCode()
        Getter for signatureCode The signature code of the boundary region as defined by Avalara. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setSignatureCode

        public void setSignatureCode​(java.lang.String value)
        Setter for signatureCode The signature code of the boundary region as defined by Avalara. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getStateAssignedNo

        public java.lang.String getStateAssignedNo()
        Getter for stateAssignedNo The state assigned number of this jurisdiction. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setStateAssignedNo

        public void setStateAssignedNo​(java.lang.String value)
        Setter for stateAssignedNo The state assigned number of this jurisdiction. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getNexusTypeId

        public NexusTypeId getNexusTypeId()
        Getter for nexusTypeId The type of nexus that this company is declaring. If you are voluntarily declaring nexus in a jurisdiction, you should select `SalesOrSellersUseTax` for your nexus type option. This option allows you to calculate tax correctly whether you are selling in-state or shipping from an out-of-state location. If you are legally obligated to declare nexus due to physical presence or other sufficient nexus, you should select `SalesTax`. This indicates that, as a legal requirement, your company must always collect and remit full sales tax in this jurisdiction. If you are participating in the Streamlined Sales Tax program, your SST administrator will select nexus settings for you in all SST jurisdictions. Do not select any SST options by yourself. This field is user-selectable and should be provided when creating or updating a nexus object.

      • setNexusTypeId

        public void setNexusTypeId​(NexusTypeId value)
        Setter for nexusTypeId The type of nexus that this company is declaring. If you are voluntarily declaring nexus in a jurisdiction, you should select `SalesOrSellersUseTax` for your nexus type option. This option allows you to calculate tax correctly whether you are selling in-state or shipping from an out-of-state location. If you are legally obligated to declare nexus due to physical presence or other sufficient nexus, you should select `SalesTax`. This indicates that, as a legal requirement, your company must always collect and remit full sales tax in this jurisdiction. If you are participating in the Streamlined Sales Tax program, your SST administrator will select nexus settings for you in all SST jurisdictions. Do not select any SST options by yourself. This field is user-selectable and should be provided when creating or updating a nexus object.

      • getSourcing

        public Sourcing getSourcing()
        Getter for sourcing Indicates whether this nexus is defined as origin or destination nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setSourcing

        public void setSourcing​(Sourcing value)
        Setter for sourcing Indicates whether this nexus is defined as origin or destination nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getHasLocalNexus

        public java.lang.Boolean getHasLocalNexus()
        Getter for hasLocalNexus True if you are also declaring local nexus within this jurisdiction. Many U.S. states have options for declaring nexus in local jurisdictions as well as within the state. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setHasLocalNexus

        public void setHasLocalNexus​(java.lang.Boolean value)
        Setter for hasLocalNexus True if you are also declaring local nexus within this jurisdiction. Many U.S. states have options for declaring nexus in local jurisdictions as well as within the state. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getLocalNexusTypeId

        public LocalNexusTypeId getLocalNexusTypeId()
        Getter for localNexusTypeId If you are declaring local nexus within this jurisdiction, this indicates whether you are declaring only a specified list of local jurisdictions, all state-administered local jurisdictions, or all local jurisdictions. This field is user-selectable and should be provided when creating or updating a nexus object.

      • setLocalNexusTypeId

        public void setLocalNexusTypeId​(LocalNexusTypeId value)
        Setter for localNexusTypeId If you are declaring local nexus within this jurisdiction, this indicates whether you are declaring only a specified list of local jurisdictions, all state-administered local jurisdictions, or all local jurisdictions. This field is user-selectable and should be provided when creating or updating a nexus object.

      • getHasPermanentEstablishment

        public java.lang.Boolean getHasPermanentEstablishment()
        Getter for hasPermanentEstablishment Set this value to true if your company has a permanent establishment within this jurisdiction. This field is user-selectable and should be provided when creating or updating a nexus object.

      • setHasPermanentEstablishment

        public void setHasPermanentEstablishment​(java.lang.Boolean value)
        Setter for hasPermanentEstablishment Set this value to true if your company has a permanent establishment within this jurisdiction. This field is user-selectable and should be provided when creating or updating a nexus object.

      • getTaxId

        public java.lang.String getTaxId()
        Getter for taxId Optional - the tax identification number under which you declared nexus. This field is user-selectable and should be provided when creating or updating a nexus object.

      • setTaxId

        public void setTaxId​(java.lang.String value)
        Setter for taxId Optional - the tax identification number under which you declared nexus. This field is user-selectable and should be provided when creating or updating a nexus object.

      • getStreamlinedSalesTax

        public java.lang.Boolean getStreamlinedSalesTax()
        Getter for streamlinedSalesTax DEPRECATED - Date: 4/29/2017, Version: 19.4, Message: Please use isSSTActive instead. For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates in the Streamlined Sales Tax program. For countries other than the US, this flag is null. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setStreamlinedSalesTax

        public void setStreamlinedSalesTax​(java.lang.Boolean value)
        Setter for streamlinedSalesTax DEPRECATED - Date: 4/29/2017, Version: 19.4, Message: Please use isSSTActive instead. For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates in the Streamlined Sales Tax program. For countries other than the US, this flag is null. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getIsSSTActive

        public java.lang.Boolean getIsSSTActive()
        Getter for isSSTActive For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates in the Streamlined Sales Tax program and if the account associated with the Nexus has an active AvaTaxCsp subscription. For countries other than the US, this flag is null. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setIsSSTActive

        public void setIsSSTActive​(java.lang.Boolean value)
        Setter for isSSTActive For the United States, this flag indicates whether this particular nexus falls within a U.S. State that participates in the Streamlined Sales Tax program and if the account associated with the Nexus has an active AvaTaxCsp subscription. For countries other than the US, this flag is null. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getCreatedDate

        public java.util.Date getCreatedDate()
        Getter for createdDate The date when this record was created. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • setCreatedDate

        public void setCreatedDate​(java.util.Date value)
        Setter for createdDate The date when this record was created. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • getCreatedUserId

        public java.lang.Integer getCreatedUserId()
        Getter for createdUserId The User ID of the user who created this record. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • setCreatedUserId

        public void setCreatedUserId​(java.lang.Integer value)
        Setter for createdUserId The User ID of the user who created this record. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • getModifiedDate

        public java.util.Date getModifiedDate()
        Getter for modifiedDate The date/time when this record was last modified. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • setModifiedDate

        public void setModifiedDate​(java.util.Date value)
        Setter for modifiedDate The date/time when this record was last modified. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • getModifiedUserId

        public java.lang.Integer getModifiedUserId()
        Getter for modifiedUserId The user ID of the user who last modified this record. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • setModifiedUserId

        public void setModifiedUserId​(java.lang.Integer value)
        Setter for modifiedUserId The user ID of the user who last modified this record. This field is defined automatically when you declare nexus. You do not need to provide a value for this field.

      • 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`.

      • getTaxAuthorityId

        public java.lang.Long getTaxAuthorityId()
        Getter for taxAuthorityId A unique ID number of the tax authority that is associated with this nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • setTaxAuthorityId

        public void setTaxAuthorityId​(java.lang.Long value)
        Setter for taxAuthorityId A unique ID number of the tax authority that is associated with this nexus. This field is defined by Avalara. All Avalara-defined fields must match an Avalara-defined nexus object found by calling `ListNexus`.

      • getIsSellerImporterOfRecord

        public java.lang.Boolean getIsSellerImporterOfRecord()
        Getter for isSellerImporterOfRecord For nexus declarations at the country level, specifies whether this company is considered the importer of record in this nexus region. Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer of record will then be the company designated to pay taxes marked as being obligated to the importer of record. Set this value to `true` to consider your company as the importer of record and collect these taxes. Leave this value as false or null and taxes will be calculated as if your company is not the importer of record. This value may also be set during each transaction API call. See `CreateTransaction()` for more information. This field is user-selectable and should be provided when creating or updating a nexus object.

      • setIsSellerImporterOfRecord

        public void setIsSellerImporterOfRecord​(java.lang.Boolean value)
        Setter for isSellerImporterOfRecord For nexus declarations at the country level, specifies whether this company is considered the importer of record in this nexus region. Some taxes only apply if the seller is the importer of record for a product. In cases where companies are working together to ship products, there may be mutual agreement as to which company is the entity designated as importer of record. The importer of record will then be the company designated to pay taxes marked as being obligated to the importer of record. Set this value to `true` to consider your company as the importer of record and collect these taxes. Leave this value as false or null and taxes will be calculated as if your company is not the importer of record. This value may also be set during each transaction API call. See `CreateTransaction()` for more information. This field is user-selectable and should be provided when creating or updating a nexus object.

      • getTaxName

        public java.lang.String getTaxName()
        Getter for taxName A description of corresponding tax type applied to the nexus. When a custom nexus is created, it'll have to be matched to a system nexus to be validated successfully. The matched system nexus has a field to describe the tax type applied to it, that field will be copied over to the nexus that is being created. This field is defined by Avalara. Its main purpose is to give a simple description of the tax type associated with the nexus so users have a better understanding of the nexus when it is displayed.

      • setTaxName

        public void setTaxName​(java.lang.String value)
        Setter for taxName A description of corresponding tax type applied to the nexus. When a custom nexus is created, it'll have to be matched to a system nexus to be validated successfully. The matched system nexus has a field to describe the tax type applied to it, that field will be copied over to the nexus that is being created. This field is defined by Avalara. Its main purpose is to give a simple description of the tax type associated with the nexus so users have a better understanding of the nexus when it is displayed.

      • getParameters

        public java.util.ArrayList<NexusParameterDetailModel> getParameters()
        Getter for parameters List of nexus parameters.

      • setParameters

        public void setParameters​(java.util.ArrayList<NexusParameterDetailModel> value)
        Setter for parameters List of nexus parameters.

      • getTaxableNexus

        public java.lang.Boolean getTaxableNexus()
        Getter for taxableNexus Shows if system nexus records are associated with tax collection

      • setTaxableNexus

        public void setTaxableNexus​(java.lang.Boolean value)
        Setter for taxableNexus Shows if system nexus records are associated with tax collection

      • toString

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