Tax Object Reference
On this page
Overview
A Tax__c object represets a tax code used within StoreConnect and then can be associated with a specific product and zone. For example, you could have a tax code of “GST” which belongs to the Zone “Australia” which includes one Zone_Country “Australia”. This would be then used against a product when the customer orders the product and their shipping address is found to be in Australia.
| Property | Value |
|---|---|
| API Name | s_c__Tax__c |
| Label | Tax |
| Plural Label | Taxes |
| Type | Custom Object |
Fields
| Field Label | API Name | Type | Required | Description |
|---|---|---|---|---|
| Based On Ship Address | s_c__Based_On_Ship_Address__c |
Checkbox | No | Tax calculation is based on the shipping address |
| Display Name | s_c__Display_Name__c |
Text(80) | No | This field is used as display name for the Tax in the app, if the value of this field is empty then the value of Name field will be used as the tax name. |
| Effective Start Date | s_c__Effective_From__c |
Date | No | Effective From Date for Tax |
| Effective End Date | s_c__Effective_To__c |
Date | No | Effective To Date for a Tax |
| Tax Rate (in percentage) | s_c__Rate_Percentage__c |
Number(16,4) | No | Tax Rate |
| [Deprecated] Tax Rate (in percentage) | s_c__Rate__c |
Number(18,2) | No | [DEPRECATED] Use Rate_Percentage__c instead |
| Zone | s_c__Zone_Id__c |
Lookup (s_c__Zone__c) | Yes | Choose a Zone for the Tax |
| StoreConnect External ID | s_c__sC_Id__c |
Text(36) | No | StoreConnect External ID, do not modify in Salesforce |
Relationships
| Field | Type | Related Object | Relationship Name |
|---|---|---|---|
s_c__Zone_Id__c |
Lookup | s_c__Zone__c | Taxes |
Referenced by
These objects hold a lookup or master-detail relationship to Tax (s_c__Tax__c). Where the referring record exists to join things together, Also links to shows what it connects this object to.
| Object | Field | Type | Relationship Name | Also links to |
|---|---|---|---|---|
| s_c__Order_Items_Taxes__c | s_c__Tax_Id__c |
Lookup | Order_Item_Taxes_Tax | s_c__Fulfillment_Item__c, OrderItem |
| s_c__Product_Tax__c | s_c__Tax_Id__c |
Lookup | Product_Taxes | Product2 |
| s_c__Tax_Tax_Group__c | s_c__Tax_Id__c |
Lookup | Tax_Tax_Group | s_c__Tax_Group__c |
On the storefront
Storefront templates read this object through the Tax Liquid object, written as tax in a theme.
| Salesforce field | Liquid attribute |
|---|---|
s_c__Display_Name__c |
tax.name |
s_c__Effective_From__c |
tax.effective_from |
s_c__Effective_To__c |
tax.effective_to |
s_c__Rate_Percentage__c |
tax.rate |
Fields you add yourself are not listed above. Expose one with a Custom Data Mapping record, then read it from tax.data. See custom data fields in Liquid.
Was this article helpful?
Thanks for your feedback! It helps us improve our docs.