TaxRate

Represents a tax rate for a tax code and country.

Introduced in API version 56.0.

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

  • The TaxRate object is available if B2B Commerce or D2C Commerce is enabled.
  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 66.0

  • Description:

    Specifies whether the tax rate is applied on the net or gross amount.

    The default value is Gross.

  • Possible values:

    • Gross — Gross (default)
    • Net — Net
  • Default value: Gross

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Description: The city to which the tax rate applies.
  • Type: string

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 66.0

  • Description:

    The country name that’s derived from the GeoCountry field value.

    This field is a calculated field.

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Description: The date until when the tax rate is valid.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Description: The flat tax amount that’s applied to the transaction.
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, 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: relationship

  • Refers to: GeoCountry

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 57.0

  • Description:

    The ID of the GeoState for which the tax rate applies.

    This field is a relationship field.

  • Relationship name: GeoState

  • Relationship type: relationship

  • Refers to: GeoState

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 66.0

  • Description:

    The legal entity to which the tax rate applies.

    This field is a relationship field.

  • Relationship name: LegalEntity

  • Relationship type: relationship

  • Refers to: LegalEntity

  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: The unique ID of the tax rate.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Reserved for future use.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Description: The code of the product for which the tax rate applies.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The tax percentage rate that will be applied to orders.
  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

  • Introduced: API version 66.0

  • Description:

    Specifies whether the tax rate is created for Commerce or Revenue Cloud.

    The default value is Commerce.

  • Possible values:

    • Commerce — Commerce (default)
    • RevCloud — RevCloud — Revenue Cloud
  • Default value: Commerce

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Description: The date from when the tax rate is valid.
  • Type: string

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 66.0

  • Description:

    The state name that’s derived from the GeoState field value.

    This field is a calculated field.

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort
  • Description: The code used to calculate the tax rate for the invoice line.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Description: The postal or ZIP code to which the tax rate applies.

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.