TaxRuleModel

java.lang.Object
- net.avalara.avatax.rest.client.models.TaxRuleModel

```
public class TaxRuleModel
extends java.lang.Object
```
Represents a tax rule that changes the behavior of Avalara's tax engine for certain products in certain jurisdictions.

Constructor Summary

Constructors
Constructor and Description

TaxRuleModel()

Constructors
Constructor and Description
`TaxRuleModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.math.BigDecimal`	`getCap()` Getter for cap The maximum cap for the price of this item according to this rule.
`java.lang.Integer`	`getCompanyId()` Getter for companyId The unique ID number of the company that owns this tax rule.
`java.lang.String`	`getCountry()` Getter for country The two character ISO 3166 country code for the locations where this rule applies.
`java.lang.String`	`getCountyFIPS()` Getter for countyFIPS For U.S.
`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.lang.String`	`getCustomerUsageType()` Getter for customerUsageType The type of customer usage to which this rule applies.
`java.lang.String`	`getDescription()` Getter for description A friendly name for this tax rule.
`java.util.Date`	`getEffectiveDate()` Getter for effectiveDate The first date at which this rule applies.
`java.util.Date`	`getEndDate()` Getter for endDate The last date for which this rule applies.
`java.lang.Integer`	`getId()` Getter for id The unique ID number of this tax rule.
`java.lang.Boolean`	`getIsAllJuris()` Getter for isAllJuris Set this value to true if this tax rule applies in all jurisdictions.
`java.lang.Boolean`	`getIsSTPro()` Getter for isSTPro If true, indicates this rule is for Sales Tax Pro.
`java.lang.String`	`getJurisCode()` Getter for jurisCode The code of the jurisdiction to which this tax rule applies.
`java.lang.String`	`getJurisName()` Getter for jurisName The name of the jurisdiction to which this tax rule applies.
`JurisTypeId`	`getJurisTypeId()` Getter for jurisTypeId The type of the jurisdiction to which this tax rule applies.
`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`	`getOptions()` Getter for options Custom option flags for this rule.
`java.lang.String`	`getRateTypeCode()` Getter for rateTypeCode Indicates the code of the rate type that applies to this rule.
`RateType`	`getRateTypeId()` Getter for rateTypeId (DEPRECATED) Enumerated rate type to which this rule applies.
`java.lang.Integer`	`getRateTypeTaxTypeMappingId()` Getter for rateTypeTaxTypeMappingId Id for RateTypeTaxTypeMapping object
`java.lang.String`	`getRegion()` Getter for region The state, region, or province name for the locations where this rule applies.
`Sourcing`	`getSourcing()` Getter for sourcing The sourcing types to which this rule applies.
`java.lang.String`	`getStateFIPS()` Getter for stateFIPS For U.S.
`java.lang.String`	`getTaxCode()` Getter for taxCode The code string of the tax code for this rule.
`java.lang.Integer`	`getTaxCodeId()` Getter for taxCodeId The unique ID number of the tax code for this rule.
`TaxRuleTypeId`	`getTaxRuleTypeId()` Getter for taxRuleTypeId This type value determines the behavior of the tax rule.
`java.lang.String`	`getTaxSubType()` Getter for taxSubType The Id of sub tax types supported by Avalara.
`java.lang.String`	`getTaxTypeGroup()` Getter for taxTypeGroup The group Id of tax types supported by Avalara.
`MatchingTaxType`	`getTaxTypeId()` Getter for taxTypeId Indicates which tax types to which this rule applies.
`java.lang.Integer`	`getTaxTypeMappingId()` Getter for taxTypeMappingId Id for TaxTypeMapping object
`java.math.BigDecimal`	`getThreshold()` Getter for threshold The per-unit threshold that must be met before this rule applies.
`java.math.BigDecimal`	`getValue()` Getter for value The corrected rate for this tax rule.
`void`	`setCap(java.math.BigDecimal value)` Setter for cap The maximum cap for the price of this item according to this rule.
`void`	`setCompanyId(java.lang.Integer value)` Setter for companyId The unique ID number of the company that owns this tax rule.
`void`	`setCountry(java.lang.String value)` Setter for country The two character ISO 3166 country code for the locations where this rule applies.
`void`	`setCountyFIPS(java.lang.String value)` Setter for countyFIPS For U.S.
`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`	`setCustomerUsageType(java.lang.String value)` Setter for customerUsageType The type of customer usage to which this rule applies.
`void`	`setDescription(java.lang.String value)` Setter for description A friendly name for this tax rule.
`void`	`setEffectiveDate(java.util.Date value)` Setter for effectiveDate The first date at which this rule applies.
`void`	`setEndDate(java.util.Date value)` Setter for endDate The last date for which this rule applies.
`void`	`setId(java.lang.Integer value)` Setter for id The unique ID number of this tax rule.
`void`	`setIsAllJuris(java.lang.Boolean value)` Setter for isAllJuris Set this value to true if this tax rule applies in all jurisdictions.
`void`	`setIsSTPro(java.lang.Boolean value)` Setter for isSTPro If true, indicates this rule is for Sales Tax Pro.
`void`	`setJurisCode(java.lang.String value)` Setter for jurisCode The code of the jurisdiction to which this tax rule applies.
`void`	`setJurisName(java.lang.String value)` Setter for jurisName The name of the jurisdiction to which this tax rule applies.
`void`	`setJurisTypeId(JurisTypeId value)` Setter for jurisTypeId The type of the jurisdiction to which this tax rule applies.
`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`	`setOptions(java.lang.String value)` Setter for options Custom option flags for this rule.
`void`	`setRateTypeCode(java.lang.String value)` Setter for rateTypeCode Indicates the code of the rate type that applies to this rule.
`void`	`setRateTypeId(RateType value)` Setter for rateTypeId (DEPRECATED) Enumerated rate type to which this rule applies.
`void`	`setRateTypeTaxTypeMappingId(java.lang.Integer value)` Setter for rateTypeTaxTypeMappingId Id for RateTypeTaxTypeMapping object
`void`	`setRegion(java.lang.String value)` Setter for region The state, region, or province name for the locations where this rule applies.
`void`	`setSourcing(Sourcing value)` Setter for sourcing The sourcing types to which this rule applies.
`void`	`setStateFIPS(java.lang.String value)` Setter for stateFIPS For U.S.
`void`	`setTaxCode(java.lang.String value)` Setter for taxCode The code string of the tax code for this rule.
`void`	`setTaxCodeId(java.lang.Integer value)` Setter for taxCodeId The unique ID number of the tax code for this rule.
`void`	`setTaxRuleTypeId(TaxRuleTypeId value)` Setter for taxRuleTypeId This type value determines the behavior of the tax rule.
`void`	`setTaxSubType(java.lang.String value)` Setter for taxSubType The Id of sub tax types supported by Avalara.
`void`	`setTaxTypeGroup(java.lang.String value)` Setter for taxTypeGroup The group Id of tax types supported by Avalara.
`void`	`setTaxTypeId(MatchingTaxType value)` Setter for taxTypeId Indicates which tax types to which this rule applies.
`void`	`setTaxTypeMappingId(java.lang.Integer value)` Setter for taxTypeMappingId Id for TaxTypeMapping object
`void`	`setThreshold(java.math.BigDecimal value)` Setter for threshold The per-unit threshold that must be met before this rule applies.
`void`	`setValue(java.math.BigDecimal value)` Setter for value The corrected rate for this tax rule.
`java.lang.String`	`toString()` Returns a JSON string representation of TaxRuleModel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TaxRuleModel
```
public TaxRuleModel()
```
- Method Detail
  - getId
```
public java.lang.Integer getId()
```
    Getter for id The unique ID number of this tax rule.
  - setId
```
public void setId(java.lang.Integer value)
```
    Setter for id The unique ID number of this tax rule.
  - getCompanyId
```
public java.lang.Integer getCompanyId()
```
    Getter for companyId The unique ID number of the company that owns this tax rule.
  - setCompanyId
```
public void setCompanyId(java.lang.Integer value)
```
    Setter for companyId The unique ID number of the company that owns this tax rule.
  - getTaxCodeId
```
public java.lang.Integer getTaxCodeId()
```
    Getter for taxCodeId The unique ID number of the tax code for this rule. When creating or updating a tax rule, you may specify either the taxCodeId value or the taxCode value.
  - setTaxCodeId
```
public void setTaxCodeId(java.lang.Integer value)
```
    Setter for taxCodeId The unique ID number of the tax code for this rule. When creating or updating a tax rule, you may specify either the taxCodeId value or the taxCode value.
  - getTaxCode
```
public java.lang.String getTaxCode()
```
    Getter for taxCode The code string of the tax code for this rule. When creating or updating a tax rule, you may specify either the taxCodeId value or the taxCode value.
  - setTaxCode
```
public void setTaxCode(java.lang.String value)
```
    Setter for taxCode The code string of the tax code for this rule. When creating or updating a tax rule, you may specify either the taxCodeId value or the taxCode value.
  - getStateFIPS
```
public java.lang.String getStateFIPS()
```
    Getter for stateFIPS For U.S. tax rules, this is the state's Federal Information Processing Standard (FIPS) code.
  - setStateFIPS
```
public void setStateFIPS(java.lang.String value)
```
    Setter for stateFIPS For U.S. tax rules, this is the state's Federal Information Processing Standard (FIPS) code.
  - getJurisName
```
public java.lang.String getJurisName()
```
    Getter for jurisName The name of the jurisdiction to which this tax rule applies.
  - setJurisName
```
public void setJurisName(java.lang.String value)
```
    Setter for jurisName The name of the jurisdiction to which this tax rule applies.
  - getJurisCode
```
public java.lang.String getJurisCode()
```
    Getter for jurisCode The code of the jurisdiction to which this tax rule applies.
  - setJurisCode
```
public void setJurisCode(java.lang.String value)
```
    Setter for jurisCode The code of the jurisdiction to which this tax rule applies.
  - getJurisTypeId
```
public JurisTypeId getJurisTypeId()
```
    Getter for jurisTypeId The type of the jurisdiction to which this tax rule applies.
  - setJurisTypeId
```
public void setJurisTypeId(JurisTypeId value)
```
    Setter for jurisTypeId The type of the jurisdiction to which this tax rule applies.
  - getCustomerUsageType
```
public java.lang.String getCustomerUsageType()
```
    Getter for customerUsageType The type of customer usage to which this rule applies.
  - setCustomerUsageType
```
public void setCustomerUsageType(java.lang.String value)
```
    Setter for customerUsageType The type of customer usage to which this rule applies.
  - getTaxTypeId
```
public MatchingTaxType getTaxTypeId()
```
    Getter for taxTypeId Indicates which tax types to which this rule applies.
  - setTaxTypeId
```
public void setTaxTypeId(MatchingTaxType value)
```
    Setter for taxTypeId Indicates which tax types to which this rule applies.
  - getRateTypeId
```
public RateType getRateTypeId()
```
    Getter for rateTypeId (DEPRECATED) Enumerated rate type to which this rule applies. Please use rateTypeCode instead.
  - setRateTypeId
```
public void setRateTypeId(RateType value)
```
    Setter for rateTypeId (DEPRECATED) Enumerated rate type to which this rule applies. Please use rateTypeCode instead.
  - getRateTypeCode
```
public java.lang.String getRateTypeCode()
```
    Getter for rateTypeCode Indicates the code of the rate type that applies to this rule. Use `/api/v2/definitions/ratetypes` for a full list of rate type codes.
  - setRateTypeCode
```
public void setRateTypeCode(java.lang.String value)
```
    Setter for rateTypeCode Indicates the code of the rate type that applies to this rule. Use `/api/v2/definitions/ratetypes` for a full list of rate type codes.
  - getTaxRuleTypeId
```
public TaxRuleTypeId getTaxRuleTypeId()
```
    Getter for taxRuleTypeId This type value determines the behavior of the tax rule. You can specify that this rule controls the product's taxability or exempt / nontaxable status, the product's rate (for example, if you have been granted an official ruling for your product's rate that differs from the official rate), or other types of behavior.
  - setTaxRuleTypeId
```
public void setTaxRuleTypeId(TaxRuleTypeId value)
```
    Setter for taxRuleTypeId This type value determines the behavior of the tax rule. You can specify that this rule controls the product's taxability or exempt / nontaxable status, the product's rate (for example, if you have been granted an official ruling for your product's rate that differs from the official rate), or other types of behavior.
  - getIsAllJuris
```
public java.lang.Boolean getIsAllJuris()
```
    Getter for isAllJuris Set this value to true if this tax rule applies in all jurisdictions.
  - setIsAllJuris
```
public void setIsAllJuris(java.lang.Boolean value)
```
    Setter for isAllJuris Set this value to true if this tax rule applies in all jurisdictions.
  - getValue
```
public java.math.BigDecimal getValue()
```
    Getter for value The corrected rate for this tax rule.
  - setValue
```
public void setValue(java.math.BigDecimal value)
```
    Setter for value The corrected rate for this tax rule.
  - getCap
```
public java.math.BigDecimal getCap()
```
    Getter for cap The maximum cap for the price of this item according to this rule.
  - setCap
```
public void setCap(java.math.BigDecimal value)
```
    Setter for cap The maximum cap for the price of this item according to this rule.
  - getThreshold
```
public java.math.BigDecimal getThreshold()
```
    Getter for threshold The per-unit threshold that must be met before this rule applies.
  - setThreshold
```
public void setThreshold(java.math.BigDecimal value)
```
    Setter for threshold The per-unit threshold that must be met before this rule applies.
  - getOptions
```
public java.lang.String getOptions()
```
    Getter for options Custom option flags for this rule.
  - setOptions
```
public void setOptions(java.lang.String value)
```
    Setter for options Custom option flags for this rule.
  - getEffectiveDate
```
public java.util.Date getEffectiveDate()
```
    Getter for effectiveDate The first date at which this rule applies. If null, this rule will apply to all dates prior to the end date.
  - setEffectiveDate
```
public void setEffectiveDate(java.util.Date value)
```
    Setter for effectiveDate The first date at which this rule applies. If null, this rule will apply to all dates prior to the end date.
  - getEndDate
```
public java.util.Date getEndDate()
```
    Getter for endDate The last date for which this rule applies. If null, this rule will apply to all dates after the effective date.
  - setEndDate
```
public void setEndDate(java.util.Date value)
```
    Setter for endDate The last date for which this rule applies. If null, this rule will apply to all dates after the effective date.
  - getDescription
```
public java.lang.String getDescription()
```
    Getter for description A friendly name for this tax rule.
  - setDescription
```
public void setDescription(java.lang.String value)
```
    Setter for description A friendly name for this tax rule.
  - getCountyFIPS
```
public java.lang.String getCountyFIPS()
```
    Getter for countyFIPS For U.S. tax rules, this is the county's Federal Information Processing Standard (FIPS) code.
  - setCountyFIPS
```
public void setCountyFIPS(java.lang.String value)
```
    Setter for countyFIPS For U.S. tax rules, this is the county's Federal Information Processing Standard (FIPS) code.
  - getIsSTPro
```
public java.lang.Boolean getIsSTPro()
```
    Getter for isSTPro If true, indicates this rule is for Sales Tax Pro.
  - setIsSTPro
```
public void setIsSTPro(java.lang.Boolean value)
```
    Setter for isSTPro If true, indicates this rule is for Sales Tax Pro.
  - getCountry
```
public java.lang.String getCountry()
```
    Getter for country The two character ISO 3166 country code for the locations where this rule applies.
  - setCountry
```
public void setCountry(java.lang.String value)
```
    Setter for country The two character ISO 3166 country code for the locations where this rule applies.
  - getRegion
```
public java.lang.String getRegion()
```
    Getter for region The state, region, or province name for the locations where this rule applies.
  - setRegion
```
public void setRegion(java.lang.String value)
```
    Setter for region The state, region, or province name for the locations where this rule applies.
  - getSourcing
```
public Sourcing getSourcing()
```
    Getter for sourcing The sourcing types to which this rule applies.
  - setSourcing
```
public void setSourcing(Sourcing value)
```
    Setter for sourcing The sourcing types to which this rule applies.
  - getCreatedDate
```
public java.util.Date getCreatedDate()
```
    Getter for createdDate The date when this record was created.
  - setCreatedDate
```
public void setCreatedDate(java.util.Date value)
```
    Setter for createdDate The date when this record was created.
  - getCreatedUserId
```
public java.lang.Integer getCreatedUserId()
```
    Getter for createdUserId The User ID of the user who created this record.
  - setCreatedUserId
```
public void setCreatedUserId(java.lang.Integer value)
```
    Setter for createdUserId The User ID of the user who created this record.
  - getModifiedDate
```
public java.util.Date getModifiedDate()
```
    Getter for modifiedDate The date/time when this record was last modified.
  - setModifiedDate
```
public void setModifiedDate(java.util.Date value)
```
    Setter for modifiedDate The date/time when this record was last modified.
  - getModifiedUserId
```
public java.lang.Integer getModifiedUserId()
```
    Getter for modifiedUserId The user ID of the user who last modified this record.
  - setModifiedUserId
```
public void setModifiedUserId(java.lang.Integer value)
```
    Setter for modifiedUserId The user ID of the user who last modified this record.
  - getTaxTypeGroup
```
public java.lang.String getTaxTypeGroup()
```
    Getter for taxTypeGroup The group Id of tax types supported by Avalara. Refer to /api/v2/definitions/taxtypegroups for types we support.
  - setTaxTypeGroup
```
public void setTaxTypeGroup(java.lang.String value)
```
    Setter for taxTypeGroup The group Id of tax types supported by Avalara. Refer to /api/v2/definitions/taxtypegroups for types we support.
  - getTaxSubType
```
public java.lang.String getTaxSubType()
```
    Getter for taxSubType The Id of sub tax types supported by Avalara. Refer to /api/v2/definitions/taxsubtypes for types we support.
  - setTaxSubType
```
public void setTaxSubType(java.lang.String value)
```
    Setter for taxSubType The Id of sub tax types supported by Avalara. Refer to /api/v2/definitions/taxsubtypes for types we support.
  - getTaxTypeMappingId
```
public java.lang.Integer getTaxTypeMappingId()
```
    Getter for taxTypeMappingId Id for TaxTypeMapping object
  - setTaxTypeMappingId
```
public void setTaxTypeMappingId(java.lang.Integer value)
```
    Setter for taxTypeMappingId Id for TaxTypeMapping object
  - getRateTypeTaxTypeMappingId
```
public java.lang.Integer getRateTypeTaxTypeMappingId()
```
    Getter for rateTypeTaxTypeMappingId Id for RateTypeTaxTypeMapping object
  - setRateTypeTaxTypeMappingId
```
public void setRateTypeTaxTypeMappingId(java.lang.Integer value)
```
    Setter for rateTypeTaxTypeMappingId Id for RateTypeTaxTypeMapping object
  - toString
```
public java.lang.String toString()
```
    Returns a JSON string representation of TaxRuleModel
    
    Overrides:
    
    toString in class java.lang.Object

Class TaxRuleModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TaxRuleModel

Method Detail

getId

setId

getCompanyId

setCompanyId

getTaxCodeId

setTaxCodeId

getTaxCode

setTaxCode

getStateFIPS

setStateFIPS

getJurisName

setJurisName

getJurisCode

setJurisCode

getJurisTypeId

setJurisTypeId

getCustomerUsageType

setCustomerUsageType

getTaxTypeId

setTaxTypeId

getRateTypeId

setRateTypeId

getRateTypeCode

setRateTypeCode

getTaxRuleTypeId

setTaxRuleTypeId

getIsAllJuris

setIsAllJuris

getValue

setValue

getCap

setCap

getThreshold

setThreshold

getOptions

setOptions

getEffectiveDate

setEffectiveDate

getEndDate

setEndDate

getDescription

setDescription

getCountyFIPS

setCountyFIPS

getIsSTPro

setIsSTPro

getCountry

setCountry

getRegion

setRegion

getSourcing

setSourcing

getCreatedDate

setCreatedDate

getCreatedUserId

setCreatedUserId

getModifiedDate

setModifiedDate

getModifiedUserId

setModifiedUserId

getTaxTypeGroup

setTaxTypeGroup

getTaxSubType

setTaxSubType

getTaxTypeMappingId

setTaxTypeMappingId

getRateTypeTaxTypeMappingId

setRateTypeTaxTypeMappingId

toString