TaxEngine

A tax engine represents both an instance of a tax engine provider as well as the merchant credentials for that specific instance. When Subscription Management calculates tax on an order item, it sends a request through Subscription Management Tax Calculation API to an external tax engine. The Salesforce tax engine record contains information passed to the external tax engine, such as

The merchant credentials are stored in a named credential record in Salesforce. The named credential record is referenced in the tax engine object’s Merchant Credentials field.

The tax adapter Apex class ID is stored in the tax engine provider. When a user calls Calculate Tax API, Subscription Management interacts with the external tax provider using the adapter class and the named credentials.

The tax engine address and seller code from the TaxEngine record are also used in the interaction.

Introduced in API version 55.0.

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

  • This object is available when Subscription Management or Commerce Subscriptions is enabled. If your org has Subscription Management and Commerce Subscriptions enabled, then Subscription Management takes precedence.
  • This object is available with Subscription Management, Commerce Subscriptions, and Billing (Revenue Cloud). If your org has Subscription Management and Commerce Subscriptions enabled, then Subscription Management takes precedence.
  • For information about this object that’s available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 68.0

  • Type: reference

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

  • Introduced: API version 68.0

  • Relationship name: DecisionTable

  • Relationship type: relationship

  • Refers to: DecisionTable

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The description of the tax engine provider and merchant credential.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Nillable, Sort, Update
  • Description: Shows information about the external platform used for the tax engine.

  • Type: reference

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

  • Description:

    Looks up to the merchant credential setup entity in Salesforce. CommerceTax Tax Calculation API sends this information to the external tax engine for use in the tax calculation process.

    This field is a relationship field.

  • Relationship name: MerchantCredential

  • Relationship type: relationship

  • Refers to: NamedCredential

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Seller code of the transaction for which the tax engine integration log was captured.

  • Type: boolean

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

  • Introduced: API version 66.0

  • Default value: false

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Shows the status of the tax engine.
  • Possible values:
    • Active — Active — This tax engine is available for use.
    • Inactive — Inactive — This tax engine isn’t available for use.
  • Type: address
  • Properties: Filter
  • Description: The compound form of the tax engine address. Read-only. See Address Compound Fields for details on compound address fields.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details for the tax engine address. Maximum size is 40 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details for the tax engine address. Maximum size is 80 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Accuracy level of the geocode for the tax engine address. See Compound Field Considerations and Limitations for details on geolocation compound fields.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Used with TaxEngineLongitude to specify the precise geolocation of a tax engine address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Used with TaxEngineLatitude to specify the precise geolocation of a tax engine address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places. See Compound Field Considerations and Limitations for details on geolocation compound fields.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the tax engine.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details for the tax engine address. Postal code maximum size is 20 characters.

  • Type: reference

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

  • Description:

    The Id of the tax engine provider.

    This field is a relationship field.

  • Relationship name: TaxEngineProvider

  • Relationship type: relationship

  • Refers to: TaxEngineProvider

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details for the tax engine address. State maximum size is 80 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Details for the tax engine address. Maximum of 255 characters.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Description: The unique identifier of the external tax provider’s account. This field is only available if Commerce Subscriptions is enabled for your org.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 63.0
  • Description: Specifies the tax engine used to calculate tax. This field is only available if Commerce Subscriptions is enabled for your org.
  • Possible values:
    • CommerceTaxExtension — CommerceTaxExtension — Commerce Tax Extension
    • RevenueCloudTaxExtension — RevenueCloudTaxExtension — Revenue Cloud Tax Extension
    • StandardTaxEngine — StandardTaxEngine — Standard Tax Extension
    • StripeNative — StripeNative — Stripe Native

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.