TaxPolicy

A tax policy contains a group of tax treatments, where each treatment represents parameters to determine how a particular product is taxed for a transaction line item. Tax policies are related to products, which pass the policy on to the resulting order items. When you activate an order, Subscription Management assigns a tax treatment to each order item based on the tax policy’s DefaultTaxTreatmentId, then uses the tax treatment to calculate tax.

Each tax policy requires at least one tax treatment. We recommend determining the taxation needs for each of your products and creating policies and treatments for each product accordingly. You can then assign your tax policies to the relevant products on your own or through automation.

Introduced in API version 55.0.

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

  • This object is available with Subscription Management and Billing (Revenue Cloud).
  • For information about this object that’s available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.

  • Type: reference

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

  • Description:

    When you order a product, the order product receives this tax treatment.

    This field is a relationship field.

  • Relationship name: DefaultTaxTreatment

  • Relationship type: relationship

  • Refers to: TaxTreatment

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Optional user-defined description for providing more information about the tax policy.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Optional user-defined name for the tax policy.
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: To calculate tax for order products, products must have an active tax policy. Tax policies are created with a Draft status before being assigned to a product or order product. After activating a tax policy, you can’t edit certain policy fields.
  • Possible values:
    • Active — Active
    • Draft — Draft
    • Inactive — Inactive
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Defines how Subscription Management chooses a tax treatment to assign to order products related to this tax policy. In API version 55.0, only Default is supported.
  • Possible values:
    • Default — Default — The order product receives the tax treatment defined in the tax policy’s DefaultTreatmentId field.
    • LegalEntity — LegalEntity — Assigns a tax treatment based on matching legal entities between the order product and tax treatment.
    • Manual — Manual — Order products don’t receive tax treatments based on the tax policy; users must provide the treatment on their own instead.

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.