TaxRate

Represents a tax rate for a tax code and country. This object is available in API version 56.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

The TaxRate object is available if B2B Commerce or D2C Commerce is enabled.

Fields

Field Details
ApplicationBasis
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies whether the tax rate is applied on the net or gross amount.
Possible values are:
  • Gross
  • Net
The default value is Gross.
City
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city to which the tax rate applies.
Country
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The country name that’s derived from the GeoCountry field value.
This field is a calculated field.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The currency ISO code that’s applicable to the tax rate.
Possible values are:
  • AUD—Australian Dollar
  • EUR—Euro
  • GBP—British Pound
  • USD—U.S. Dollar
The default value is USD.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date until when the tax rate is valid.
FlatTaxAmount
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The flat tax amount that’s applied to the transaction.
GeoCountryId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the GeoCountry for which the tax rate applies. You can define only one tax rate per GeoCountry and tax code combination.
This field is a relationship field.
Relationship Name
GeoCountry
Relationship Type
Lookup
Refers To
GeoCountry
GeoStateId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort
Description
The ID of the GeoState for which the tax rate applies.
This field is a relationship field.
Relationship Name
GeoState
Refers To
GeoState
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last accessed this record, a record related to this record, or a list view.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp when the current user last viewed this record or list view. If this value is null, it's possible the user accessed data in this record or list view but didn't viewed it directly.
LegalEntityId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The legal entity to which the tax rate applies.
This field is a relationship field.
Relationship Name
LegalEntity
Refers To
LegalEntity
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The unique ID of the tax rate.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The TaxRate record owner. By default, the record owner is the user who created the record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
Priority
Type
int
Properties
Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
Description
Reserved for future use.
ProductCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The code of the product for which the tax rate applies.
Rate
Type
double
Properties
Create, Filter, Sort, Update
Description
The tax percentage rate that will be applied to orders.
RateUsageType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies whether the tax rate is created for Commerce or Revenue Cloud.
Possible values are:
  • Commerce
  • RevCloud—Revenue Cloud
The default value is Commerce.
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date from when the tax rate is valid.
State
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The state name that’s derived from the GeoState field value.
This field is a calculated field.
TaxCode
Type
string
Properties
Create, Filter, Group, Sort
Description
The code used to calculate the tax rate for the invoice line.
ZipCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The postal or ZIP code to which the tax rate applies.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

TaxRateChangeEvent
Change events are available for the object.
TaxRateFeed
Feed tracking is available for the object.
TaxRateHistory
History is available for tracked fields of the object.
TaxRateOwnerSharingRule
Sharing rules are available for the object.
TaxRateShare
Sharing is available for the object.