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.
`RateType`	`getRateTypeId()` Getter for rateTypeId - Indicates the rate type to which this rule applies.
`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.
`MatchingTaxType`	`getTaxTypeId()` Getter for taxTypeId - Indicates which tax types to which this rule applies.
`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 cap)` Setter for cap - The maximum cap for the price of this item according to this rule.
`void`	`setCompanyId(java.lang.Integer companyId)` Setter for companyId - The unique ID number of the company that owns this tax rule.
`void`	`setCountry(java.lang.String country)` Setter for country - The two character ISO 3166 country code for the locations where this rule applies.
`void`	`setCountyFIPS(java.lang.String countyFIPS)` Setter for countyFIPS - For U.S.
`void`	`setCreatedDate(java.util.Date createdDate)` Setter for createdDate - The date when this record was created.
`void`	`setCreatedUserId(java.lang.Integer createdUserId)` Setter for createdUserId - The User ID of the user who created this record.
`void`	`setCustomerUsageType(java.lang.String customerUsageType)` Setter for customerUsageType - The type of customer usage to which this rule applies.
`void`	`setDescription(java.lang.String description)` Setter for description - A friendly name for this tax rule.
`void`	`setEffectiveDate(java.util.Date effectiveDate)` Setter for effectiveDate - The first date at which this rule applies.
`void`	`setEndDate(java.util.Date endDate)` Setter for endDate - The last date for which this rule applies.
`void`	`setId(java.lang.Integer id)` Setter for id - The unique ID number of this tax rule.
`void`	`setIsAllJuris(java.lang.Boolean isAllJuris)` Setter for isAllJuris - Set this value to true if this tax rule applies in all jurisdictions.
`void`	`setIsSTPro(java.lang.Boolean isSTPro)` Setter for isSTPro - If true, indicates this rule is for Sales Tax Pro.
`void`	`setJurisCode(java.lang.String jurisCode)` Setter for jurisCode - The code of the jurisdiction to which this tax rule applies.
`void`	`setJurisName(java.lang.String jurisName)` Setter for jurisName - The name of the jurisdiction to which this tax rule applies.
`void`	`setJurisTypeId(JurisTypeId jurisTypeId)` Setter for jurisTypeId - The type of the jurisdiction to which this tax rule applies.
`void`	`setModifiedDate(java.util.Date modifiedDate)` Setter for modifiedDate - The date/time when this record was last modified.
`void`	`setModifiedUserId(java.lang.Integer modifiedUserId)` Setter for modifiedUserId - The user ID of the user who last modified this record.
`void`	`setOptions(java.lang.String options)` Setter for options - Custom option flags for this rule.
`void`	`setRateTypeId(RateType rateTypeId)` Setter for rateTypeId - Indicates the rate type to which this rule applies.
`void`	`setRegion(java.lang.String region)` Setter for region - The state, region, or province name for the locations where this rule applies.
`void`	`setSourcing(Sourcing sourcing)` Setter for sourcing - The sourcing types to which this rule applies.
`void`	`setStateFIPS(java.lang.String stateFIPS)` Setter for stateFIPS - For U.S.
`void`	`setTaxCode(java.lang.String taxCode)` Setter for taxCode - The code string of the tax code for this rule.
`void`	`setTaxCodeId(java.lang.Integer taxCodeId)` Setter for taxCodeId - The unique ID number of the tax code for this rule.
`void`	`setTaxRuleTypeId(TaxRuleTypeId taxRuleTypeId)` Setter for taxRuleTypeId - This type value determines the behavior of the tax rule.
`void`	`setTaxTypeId(MatchingTaxType taxTypeId)` Setter for taxTypeId - Indicates which tax types to which this rule applies.
`void`	`setThreshold(java.math.BigDecimal threshold)` 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
  - 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 taxCode)
```
    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.
  - 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 customerUsageType)
```
    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 taxTypeId)
```
    Setter for taxTypeId - Indicates which tax types to which this rule applies.
  - 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 endDate)
```
    Setter for endDate - The last date for which this rule applies. If null, this rule will apply to all dates after the effective date.
  - 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 jurisCode)
```
    Setter for jurisCode - The code of the jurisdiction to which this tax rule applies.
  - getDescription
```
public java.lang.String getDescription()
```
    Getter for description - A friendly name for this tax rule.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Setter for description - A friendly name for this tax rule.
  - 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 modifiedDate)
```
    Setter for modifiedDate - The date/time when this record was last modified.
  - getSourcing
```
public Sourcing getSourcing()
```
    Getter for sourcing - The sourcing types to which this rule applies.
  - setSourcing
```
public void setSourcing(Sourcing sourcing)
```
    Setter for sourcing - The sourcing types to which this rule applies.
  - 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 country)
```
    Setter for country - The two character ISO 3166 country code for the locations where this rule applies.
  - 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 taxCodeId)
```
    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.
  - getOptions
```
public java.lang.String getOptions()
```
    Getter for options - Custom option flags for this rule.
  - setOptions
```
public void setOptions(java.lang.String options)
```
    Setter for options - Custom option flags for this rule.
  - 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 isAllJuris)
```
    Setter for isAllJuris - Set this value to true if this tax rule applies in all jurisdictions.
  - getId
```
public java.lang.Integer getId()
```
    Getter for id - The unique ID number of this tax rule.
  - setId
```
public void setId(java.lang.Integer id)
```
    Setter for id - The unique ID number of this tax rule.
  - 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 stateFIPS)
```
    Setter for stateFIPS - For U.S. tax rules, this is the state's Federal Information Processing Standard (FIPS) code.
  - 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 threshold)
```
    Setter for threshold - The per-unit threshold that must be met before this rule applies.
  - 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 isSTPro)
```
    Setter for isSTPro - If true, indicates this rule is for Sales Tax Pro.
  - 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 modifiedUserId)
```
    Setter for modifiedUserId - The user ID of the user who last modified this record.
  - 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 effectiveDate)
```
    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.
  - 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 createdUserId)
```
    Setter for createdUserId - The User ID of the user who created this record.
  - 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 region)
```
    Setter for region - The state, region, or province name for the locations where this rule applies.
  - 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 countyFIPS)
```
    Setter for countyFIPS - For U.S. tax rules, this is the county's Federal Information Processing Standard (FIPS) code.
  - 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 taxRuleTypeId)
```
    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.
  - getRateTypeId
```
public RateType getRateTypeId()
```
    Getter for rateTypeId - Indicates the rate type to which this rule applies.
  - setRateTypeId
```
public void setRateTypeId(RateType rateTypeId)
```
    Setter for rateTypeId - Indicates the rate type to which this rule applies.
  - 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 jurisName)
```
    Setter for jurisName - The name of the jurisdiction to which this tax rule applies.
  - 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 cap)
```
    Setter for cap - The maximum cap for the price of this item according to this rule.
  - getJurisTypeId
```
public JurisTypeId getJurisTypeId()
```
    Getter for jurisTypeId - The type of the jurisdiction to which this tax rule applies.
  - setJurisTypeId
```
public void setJurisTypeId(JurisTypeId jurisTypeId)
```
    Setter for jurisTypeId - The type of the jurisdiction to which this tax rule applies.
  - 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.
  - 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 companyId)
```
    Setter for companyId - The unique ID number of the company that owns this tax rule.
  - getCreatedDate
```
public java.util.Date getCreatedDate()
```
    Getter for createdDate - The date when this record was created.
  - setCreatedDate
```
public void setCreatedDate(java.util.Date createdDate)
```
    Setter for createdDate - The date when this record was created.
  - 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

getTaxCode

setTaxCode

getCustomerUsageType

setCustomerUsageType

getTaxTypeId

setTaxTypeId

getEndDate

setEndDate

getJurisCode

setJurisCode

getDescription

setDescription

getModifiedDate

setModifiedDate

getSourcing

setSourcing

getCountry

setCountry

getTaxCodeId

setTaxCodeId

getOptions

setOptions

getIsAllJuris

setIsAllJuris

getId

setId

getStateFIPS

setStateFIPS

getThreshold

setThreshold

getIsSTPro

setIsSTPro

getModifiedUserId

setModifiedUserId

getEffectiveDate

setEffectiveDate

getCreatedUserId

setCreatedUserId

getRegion

setRegion

getCountyFIPS

setCountyFIPS

getTaxRuleTypeId

setTaxRuleTypeId

getRateTypeId

setRateTypeId

getJurisName

setJurisName

getCap

setCap

getJurisTypeId

setJurisTypeId

getValue

setValue

getCompanyId

setCompanyId

getCreatedDate

setCreatedDate

toString