Newer Version Available

This content describes an older version of this product. View Latest

TaxEngineInteractionLog

A record of a communication with an external tax engine following a tax calculation request. This object is available in API version 55.0 and later.

Supported Calls

delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete()

Special Access Rules

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.

Fields

Field Details
Description
Type
textarea
Properties
Filter, Nillable, Sort
Description
Optional user-defined description for providing more information about the tax engine interaction log.
DocumentCode
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Document code of the transaction for which the tax engine integration log was captured.
EffectiveDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The date that the tax engine request takes effect. This date is available for reference and bookkeeping only and doesn’t have any impact on tax calculation.
InteractionHttpStatusCode
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The HHTP result code of the external callout made to a third-party tax engine provider. Refer to your third-party tax engine provider’s documentation for details about the specific codes returned.
InteractionType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Shows the type of request made to the tax engine. In Subscription Management Summer ‘22, only CalculateTax is supported.
Possible values are:
  • CalculateTax
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
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 accessed this record, a record related to this record, or a list view.
ReferenceEntity
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The record on which tax was calculated.
RequestBody
Type
base64
Properties
Nillable
Description
Contains the content of the tax calculation API request.
RequestContentType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Shows the type of data passed in the request. For example, application/html or text/csv.
RequestLength
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The character length of text within the request body.
RequestName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The name of the request.
ResponseBody
Type
base64
Properties
Nillable
Description
Contains the content of the tax calculation API response.
ResponseContentType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Shows the method used to deliver the tax calculation API response, such as application/html or text/vnd.salesforce.quip-template.
ResponseLength
Type
int
Properties
Filter, Group, Nillable, Sort
Description
The character length of text within the response body.
ResponseName
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Name of the response from the tax engine.
ResultCode
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
The code describing the result of the request.
Possible values are:
  • AdapterException—The Apex adapter interface for the tax provider threw an exception.
  • Success—The request was successful.
  • TaxEngineError—An error occurred while processing the request. See the log for details.
  • ValidationError—A validation error occurred. Check that the request is complete and valid.
TaxEngineId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
The ID of the tax engine used in the tax calculation process.
This field is a relationship field.
Relationship Name
TaxEngine
Relationship Type
Lookup
Refers To
TaxEngine
TaxEngineInteractionLogNumber
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
A system-generated number for a log entry.