Tax Provider Object Reference
On this page
Overview
Configures a Tax provider to be offered as part of the checkout process. Mainly contains the necessary credentials for the provider’s API.
| Property | Value |
|---|---|
| API Name | s_c__Tax_Provider__c |
| Label | Tax Provider |
| Plural Label | Tax Providers |
| Type | Custom Object |
Fields
| Field Label | API Name | Type | Required | Description |
|---|---|---|---|---|
| Active | s_c__Active__c |
Checkbox | No | Enable/disable tax calculation for this tax provider service. |
| API Key | s_c__Api_Key__c |
Text(255) | No | The API key for the Tax provider’s API that you will have received from the Tax provider. This is the public part of your credentials, akin to a username. It may also be referred to as a “Client ID” or simply a “key”. This should not be confused with the “secret” or “private” key. |
| API Mode | s_c__Api_Mode__c |
Text(255) | No | The mode of the Tax provider’s API to use. This is determined by the terminology of the API in question, and will likely be a word similar to the following: “test”, “sandbox”, “live”, etc. |
| API Secret | s_c__Api_Secret__c |
Text(255) | No | The API secret key for the Tax provider’s API that you will have received from the Tax provider. This is the private/secret part of your credentials, and could also be referred to as a “Password” or “Private Key”. |
| Block Transactions Markdown | s_c__Block_Transactions_Markdown__c |
LongTextArea(25000) | No | Displays a message when transactions are blocked for this tax provider. Use Markdown to format your text. Find out more at https://help.getstoreconnect.com/documentation/how-to-use-markdown. |
| Block Transactions When Offline | s_c__Block_Transactions_When_Offline__c |
Checkbox | No | When set to true, prevents transactions from completing when the third party service is unavailable |
| Channels | s_c__Channels__c |
MultiselectPicklist | Yes | The sales channels this tax provider applies to. Select Web, POS, or both. A provider with no channels selected is treated as active on all channels for backward compatibility. See Avalara AvaTax. |
| Company Code | s_c__Company_Code__c |
Text(50) | No | Defines company code for this tax provider. |
| Configuration Options | s_c__Configuration_Options__c |
LongTextArea(10000) | No | This allows you to provide other options that are required for this API connection to work. The required format of this field depends on the Tax provider being used. |
| Default Freight Tax Code | s_c__Default_Freight_Tax_Code__c |
Text(50) | No | Tax code applied to the StoreConnect Shipping line item on every order. This field is the sole source of the shipping line’s tax code; the Tax Code field on the StoreConnect Shipping product record is not used. Leave blank to apply the tax provider’s own default freight tax code. |
| Provider | s_c__Provider__c |
Picklist | No | Tax provider, e.g. Avalara etc. |
| Ship From Address (Line 1) | s_c__Ship_From_Address_Line_1__c |
Text(100) | No | Defines the Line 1 component of this tax providers’s Ship From Address. This field in conjunction with the other address elements is used as a fallback address if a Stock Location Address is not found. |
| Ship From Address (Line 2) | s_c__Ship_From_Address_Line_2__c |
Text(100) | No | Defines the Line 2 component of this tax providers’s Ship From Address. This field in conjunction with the other address elements is used as a fallback address if a Stock Location Address is not found. |
| Ship From City | s_c__Ship_From_City__c |
Text(40) | No | Defines the City component of this tax providers’s Ship From Address. This field in conjunction with the other address elements is used as a fallback address if a Stock Location Address is not found. |
| Ship From Country | s_c__Ship_From_Country__c |
Text(80) | No | Defines the Country component of this tax provider’s Ship From Address. This field in conjunction with the other address elements is used as a fallback address if a Stock Location Address is not found. |
| Ship From State | s_c__Ship_From_State__c |
Text(80) | No | Defines the State component of this tax provider’s Ship From Address. This field in conjunction with the other address elements is used as a fallback address if a Stock Location Address is not found. |
| Ship From Zip/Postal Code | s_c__Ship_From_Zip_Postal_Code__c |
Text(20) | No | Defines the Zip/Postal Code component of this tax provider’s Ship From Address. This field in conjunction with the other address elements is used as a fallback address if a Stock Location Address is not found. |
Was this article helpful?
Thanks for your feedback! It helps us improve our docs.