system.xml 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--
  3. @copyright Vertex. All rights reserved. https://www.vertexinc.com/
  4. @author Mediotype https://www.mediotype.com/
  5. -->
  6. <config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
  7. <system>
  8. <section id="tax" translate="label">
  9. <group id="vertex_settings" translate="label" sortOrder="2" showInDefault="1" showInWebsite="1" showInStore="0">
  10. <label>Vertex Settings</label>
  11. <comment><![CDATA[For information on how to sign up for Vertex, please <a href="http://go.vertexinc.com/magento_cbe">click here</a>]]></comment>
  12. <field id="enable_vertex" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="0">
  13. <label>Use Vertex Tax Links</label>
  14. <source_model>Magento\Config\Model\Config\Source\Enabledisable</source_model>
  15. <comment><![CDATA[Utilize the Vertex Tax Links connector]]></comment>
  16. </field>
  17. <field id="use_for_calculation" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="0">
  18. <label>Vertex Tax Calculation</label>
  19. <source_model>Magento\Config\Model\Config\Source\Enabledisable</source_model>
  20. <comment><![CDATA[Calculate Tax using Vertex.]]></comment>
  21. <depends>
  22. <field id="enable_vertex">1</field>
  23. </depends>
  24. </field>
  25. <field id="vertex_status" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="0">
  26. <label>Vertex API Status</label>
  27. <frontend_model>Vertex\Tax\Block\Adminhtml\Config\Form\Field\VertexStatus</frontend_model>
  28. <comment><![CDATA[API credentials status]]></comment>
  29. <depends>
  30. <field id="enable_vertex">1</field>
  31. </depends>
  32. </field>
  33. <field id="api_url" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="0" canRestore="1">
  34. <label>Vertex Calculation API Url</label>
  35. <validate>required-entry</validate>
  36. <depends>
  37. <field id="enable_vertex">1</field>
  38. </depends>
  39. </field>
  40. <field id="address_api_url" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="0" canRestore="1">
  41. <label>Vertex Address Validation API Url</label>
  42. <validate>required-entry</validate>
  43. <depends>
  44. <field id="enable_vertex">1</field>
  45. </depends>
  46. </field>
  47. <field id="trustedId" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="0">
  48. <label>Vertex Trusted Id</label>
  49. <validate>required-entry validate-length maximum-length-16 minimum-length-6</validate>
  50. <depends>
  51. <field id="enable_vertex">1</field>
  52. </depends>
  53. <comment><![CDATA[An identifier supplied by an ERP.]]></comment>
  54. </field>
  55. <field id="invoice_order" translate="label" type="select" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="0" canRestore="1">
  56. <label>When to send invoice to Vertex</label>
  57. <depends>
  58. <field id="enable_vertex">1</field>
  59. </depends>
  60. <source_model>Vertex\Tax\Model\Config\Source\TaxInvoice</source_model>
  61. <comment><![CDATA[Please select when tax should be invoiced to Vertex]]></comment>
  62. </field>
  63. <field id="invoice_order_status" translate="label" type="select" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="0">
  64. <validate>required-entry</validate>
  65. <label>Invoice When Order Status</label>
  66. <depends>
  67. <field id="enable_vertex">1</field>
  68. <field id="invoice_order"><![CDATA[order_status]]></field>
  69. </depends>
  70. <source_model>Magento\Sales\Model\Config\Source\Order\Status</source_model>
  71. <frontend_model>Vertex\Tax\Block\Adminhtml\Config\Form\Field\OrderStatus</frontend_model>
  72. <comment><![CDATA[Please select order status]]></comment>
  73. </field>
  74. <field id="allowed_countries" translate="label comment" type="multiselect" sortOrder="70" showInDefault="1" showInWebsite="1" showInStore="0">
  75. <label>Use Vertex for orders shipping to</label>
  76. <comment>The billing address will be used when a shipping address is absent.</comment>
  77. <frontend_model>Vertex\Tax\Block\Adminhtml\Config\Form\Field\AllowedCountries</frontend_model>
  78. <source_model>Vertex\Tax\Model\Config\Source\AllowedCountries</source_model>
  79. <depends>
  80. <field id="enable_vertex">1</field>
  81. </depends>
  82. </field>
  83. <field id="summarize_tax" translate="label comment" type="select" sortOrder="80" showInDefault="1" showInWebsite="1" showInStore="0">
  84. <label>Summarize Tax by</label>
  85. <depends>
  86. <field id="enable_vertex">1</field>
  87. </depends>
  88. <source_model>Vertex\Tax\Model\Config\Source\SummarizeTax</source_model>
  89. <comment><![CDATA[Please select how Tax should be summarized]]></comment>
  90. </field>
  91. </group>
  92. <group id="vertex_seller_info" translate="label" sortOrder="3" showInDefault="1" showInWebsite="1" showInStore="1">
  93. <label>Vertex Company Information</label>
  94. <depends>
  95. <field id="tax/vertex_settings/enable_vertex">1</field>
  96. </depends>
  97. <field id="company" translate="label" type="text" sortOrder="10" showInDefault="1" showInWebsite="1" showInStore="1">
  98. <label>Company Code</label>
  99. <validate>validate-length maximum-length-40</validate>
  100. <comment><![CDATA[The Vertex TaxCentral user interface is used to set up any taxability rules that apply at this level.
  101. This should be a parameter that is configurable to data from the host system based on an individual company's legal and tax requirements.]]></comment>
  102. </field>
  103. <field id="location_code" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
  104. <label>Location Code</label>
  105. <validate>validate-length maximum-length-40</validate>
  106. <comment><![CDATA[The locationCode attribute on the line item represents the store location code that is used for returns filing]]></comment>
  107. </field>
  108. <field id="streetAddress1" translate="label" type="text" sortOrder="30" showInDefault="1" showInWebsite="1" showInStore="1">
  109. <label>Company Street Address</label>
  110. <validate>validate-length maximum-length-100</validate>
  111. <comment><![CDATA[The first line of the street address.]]></comment>
  112. </field>
  113. <field id="streetAddress2" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1">
  114. <label>Company Street Address 2</label>
  115. <validate>validate-length maximum-length-100</validate>
  116. <comment><![CDATA[The first second of the street address.]]></comment>
  117. </field>
  118. <field id="city" translate="label" type="text" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
  119. <label>Company City</label>
  120. <validate>validate-length maximum-length-60</validate>
  121. <comment><![CDATA[The proper name of the city used to determine Tax Jurisdiction(s)]]></comment>
  122. </field>
  123. <field id="country_id" translate="label" type="select" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1">
  124. <label>Company Country</label>
  125. <frontend_class>countries</frontend_class>
  126. <source_model>Magento\Directory\Model\Config\Source\Country</source_model>
  127. <comment><![CDATA[The country used to determine the Tax Jurisdiction(s)]]></comment>
  128. </field>
  129. <field id="region_id" translate="label" type="select" sortOrder="70" showInDefault="1" showInWebsite="1" showInStore="1">
  130. <label>Company State</label>
  131. <validate>validate-length maximum-length-60</validate>
  132. <comment><![CDATA[The proper name or the postal abbreviation of the state, province, or territory used to determine Tax Jurisdiction(s)]]></comment>
  133. <source_model>Magento\Directory\Model\Config\Source\Allregion</source_model>
  134. </field>
  135. <field id="postalCode" translate="label" type="text" sortOrder="80" showInDefault="1" showInWebsite="1" showInStore="1">
  136. <label>Company Postal Code</label>
  137. <validate>validate-length maximum-length-15</validate>
  138. <comment><![CDATA[The postal code used to determine Tax Jurisdiction(s)]]></comment>
  139. </field>
  140. </group>
  141. <group id="vertex_delivery_terms" translate="label comment" type="select" sortOrder="4" showInDefault="1" showInWebsite="1">
  142. <label>Vertex Delivery Terms</label>
  143. <depends>
  144. <field id="tax/vertex_settings/enable_vertex">1</field>
  145. </depends>
  146. <field id="default_term" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="1">
  147. <label>Global Delivery Term</label>
  148. <validate>required-entry</validate>
  149. <source_model>Vertex\Tax\Model\Config\Source\DeliveryTerm</source_model>
  150. <comment><![CDATA[Delivery Term used by default]]></comment>
  151. </field>
  152. <field id="override" translate="label comment" type="select" sortOrder="20" showInDefault="1" showInWebsite="1">
  153. <label>Delivery Term Override</label>
  154. <validate>required-entry</validate>
  155. <frontend_model>Vertex\Tax\Block\Adminhtml\Config\Form\Field\TaxOverride</frontend_model>
  156. <backend_model>Vertex\Tax\Model\Config\Backend\TaxOverride</backend_model>
  157. <comment><![CDATA[Override the Global Delivery Term based on the country being shipped to]]></comment>
  158. </field>
  159. </group>
  160. <group id="avaiable_shipping_product_codes" translate="label" sortOrder="5" showInDefault="1" showInWebsite="1" showInStore="1">
  161. <label>Vertex Shipping Product Codes</label>
  162. <comment><![CDATA[<p class="message message-notification">List of shipping methods available for mapping in Vertex</p>]]></comment>
  163. <depends>
  164. <field id="tax/vertex_settings/enable_vertex">1</field>
  165. </depends>
  166. <field id="shipping_codes" translate="label" type="text" sortOrder="20" showInDefault="1" showInWebsite="1" showInStore="1">
  167. <label>Vertex API Status</label>
  168. <frontend_model>Vertex\Tax\Block\Adminhtml\Config\Form\Field\ShippingCodes</frontend_model>
  169. </field>
  170. </group>
  171. <group id="classes">
  172. <comment><![CDATA[<p class="message message-notification">You can manage customer and product tax classes at Stores->Tax Rules->Add New Tax Rule->Additional Settings</p>]]></comment>
  173. <field id="shipping_tax_class" showInWebsite="1" sortOrder="10" showInStore="1" />
  174. <field id="default_customer_code" translate="label" type="text" sortOrder="40" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
  175. <depends>
  176. <field id="tax/vertex_settings/enable_vertex">1</field>
  177. </depends>
  178. <label>Default Customer Code</label>
  179. <validate>required-entry</validate>
  180. <comment><![CDATA[Customer code which will be used for unregistered users and for customers without customer code value]]></comment>
  181. </field>
  182. <field id="creditmemo_adjustment_class" translate="label" type="select" sortOrder="50" showInDefault="1" showInWebsite="1" showInStore="1">
  183. <depends>
  184. <field id="tax/vertex_settings/enable_vertex">1</field>
  185. </depends>
  186. <label>Refund Adjustments Class</label>
  187. <validate>required-entry</validate>
  188. <source_model>Magento\Tax\Model\TaxClass\Source\Product</source_model>
  189. <comment><![CDATA[Class which will be used for creditmemo adjustments]]></comment>
  190. </field>
  191. <field id="creditmemo_adjustment_negative_code" translate="label" type="text" sortOrder="60" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
  192. <depends>
  193. <field id="tax/vertex_settings/enable_vertex">1</field>
  194. </depends>
  195. <label>Adjustment Fee Code</label>
  196. <validate>required-entry</validate>
  197. <comment><![CDATA[Product code which will be used for creditmemo adjustment fee]]></comment>
  198. </field>
  199. <field id="creditmemo_adjustment_positive_code" translate="label" type="text" sortOrder="70" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
  200. <depends>
  201. <field id="tax/vertex_settings/enable_vertex">1</field>
  202. </depends>
  203. <label>Adjustment Refund Code</label>
  204. <validate>required-entry</validate>
  205. <comment><![CDATA[Product code which will be used for creditmemo adjustment]]></comment>
  206. </field>
  207. <field id="giftwrap_order_class" translate="label" type="select" sortOrder="80" showInDefault="1" showInWebsite="1" showInStore="1">
  208. <depends>
  209. <field id="tax/vertex_settings/enable_vertex">1</field>
  210. </depends>
  211. <label>Gift Wrap For Order Class</label>
  212. <validate>required-entry</validate>
  213. <source_model>Magento\Tax\Model\TaxClass\Source\Product</source_model>
  214. <comment><![CDATA[Product class which will be used for order gift wrap]]></comment>
  215. </field>
  216. <field id="giftwrap_order_code" translate="label" type="text" sortOrder="90" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
  217. <depends>
  218. <field id="tax/vertex_settings/enable_vertex">1</field>
  219. </depends>
  220. <label>Gift Wrap For Order Code</label>
  221. <validate>required-entry</validate>
  222. <comment><![CDATA[Product code which will be used for order gift wrap]]></comment>
  223. </field>
  224. <field id="giftwrap_item_class" translate="label" type="select" sortOrder="90" showInDefault="1" showInWebsite="1" showInStore="1">
  225. <depends>
  226. <field id="tax/vertex_settings/enable_vertex">1</field>
  227. </depends>
  228. <label>Gift Wrap Class For Single Product</label>
  229. <validate>required-entry</validate>
  230. <source_model>Magento\Tax\Model\TaxClass\Source\Product</source_model>
  231. <comment><![CDATA[Class for gift wrap of single product]]></comment>
  232. </field>
  233. <field id="giftwrap_item_code" translate="label" type="text" sortOrder="100" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
  234. <depends>
  235. <field id="tax/vertex_settings/enable_vertex">1</field>
  236. </depends>
  237. <label>Gift Wrap Code Prefix For Single Product</label>
  238. <validate>required-entry</validate>
  239. <comment><![CDATA[Prefix will be used for giftwrap item. Each code will be {{prefix}}-{{sku}}]]></comment>
  240. </field>
  241. <field id="printed_giftcard_class" translate="label" type="select" sortOrder="110" showInDefault="1" showInWebsite="1" showInStore="1">
  242. <depends>
  243. <field id="tax/vertex_settings/enable_vertex">1</field>
  244. </depends>
  245. <label>Item Line Class For Printed Gift Card</label>
  246. <validate>required-entry</validate>
  247. <source_model>Magento\Tax\Model\TaxClass\Source\Product</source_model>
  248. <comment><![CDATA[Product Class for printed giftcard line item]]></comment>
  249. </field>
  250. <field id="printed_giftcard_code" translate="label" type="text" sortOrder="120" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
  251. <depends>
  252. <field id="tax/vertex_settings/enable_vertex">1</field>
  253. </depends>
  254. <label>Item Line Code For Printed Gift Card</label>
  255. <validate>required-entry</validate>
  256. <comment><![CDATA[Product code for printed giftcard line item]]></comment>
  257. </field>
  258. <field id="reward_points_class" translate="label" type="select" sortOrder="130" showInDefault="1" showInWebsite="1" showInStore="1">
  259. <depends>
  260. <field id="tax/vertex_settings/enable_vertex">1</field>
  261. </depends>
  262. <label>Class For Reward Points Discount Line Item</label>
  263. <validate>required-entry</validate>
  264. <source_model>Magento\Tax\Model\TaxClass\Source\Product</source_model>
  265. <comment><![CDATA[Product Class for reward points order discount.]]></comment>
  266. </field>
  267. <field id="reward_points_code" translate="label" type="text" sortOrder="140" showInDefault="1" showInWebsite="1" showInStore="1" canRestore="1">
  268. <depends>
  269. <field id="tax/vertex_settings/enable_vertex">1</field>
  270. </depends>
  271. <label>Product Code For Reward Points Discount Line Item</label>
  272. <validate>required-entry</validate>
  273. <comment><![CDATA[Product code for reward points order discount]]></comment>
  274. </field>
  275. </group>
  276. <group id="vertex_logging" translate="label" sortOrder="900" showInDefault="1" showInWebsite="1"
  277. showInStore="0">
  278. <label>Vertex Logging</label>
  279. <depends>
  280. <field id="tax/vertex_settings/enable_vertex">1</field>
  281. </depends>
  282. <field id="enable_logging" translate="label comment" type="select" sortOrder="10" showInDefault="1"
  283. showInWebsite="1" showInStore="0" canRestore="1">
  284. <label>Vertex Request Logging</label>
  285. <source_model>Magento\Config\Model\Config\Source\Enabledisable</source_model>
  286. <comment><![CDATA[When enabled, all API requests are tracked.]]></comment>
  287. </field>
  288. <field id="enable_rotation" translate="label comment" type="select" sortOrder="20" showInDefault="1"
  289. showInWebsite="0" showInStore="0" canRestore="1">
  290. <label>Log Rotation</label>
  291. <source_model>Magento\Config\Model\Config\Source\Enabledisable</source_model>
  292. <comment><![CDATA[Perform an action on logs over a certain age at a regular interval]]></comment>
  293. </field>
  294. <field id="rotation_action" translate="label comment" type="select" sortOrder="30" showInDefault="1"
  295. showInWebsite="0" showInStore="0">
  296. <label>Rotation Action</label>
  297. <validate>required-entry</validate>
  298. <source_model>Vertex\Tax\Model\Config\Source\RotationAction</source_model>
  299. <depends>
  300. <field id="enable_rotation">1</field>
  301. </depends>
  302. <comment><![CDATA[When exported, entries are stored at <strong>var/vertexlog_Y-m-d.csv</strong>]]></comment>
  303. </field>
  304. <field id="entry_lifetime" translate="label comment" type="text" sortOrder="40" showInDefault="1"
  305. showInWebsite="0" showInStore="0">
  306. <label>Log Entry Lifetime (days)</label>
  307. <validate>required-entry</validate>
  308. <depends>
  309. <field id="enable_rotation">1</field>
  310. </depends>
  311. <comment><![CDATA[How long a log should exist before it is eligible to be rotated. A value of 0 will mark all logs as eligible]]></comment>
  312. </field>
  313. <field id="rotation_frequency" translate="label comment" type="select" sortOrder="50" showInDefault="1"
  314. showInWebsite="0" showInStore="0">
  315. <label>Rotation Frequency</label>
  316. <validate>required-entry</validate>
  317. <depends>
  318. <field id="enable_rotation">1</field>
  319. </depends>
  320. <source_model>Magento\Cron\Model\Config\Source\Frequency</source_model>
  321. <backend_model>Vertex\Tax\Model\Config\Backend\LogFrequency</backend_model>
  322. <comment><![CDATA[How often the Rotation Action should be applied to the logs]]></comment>
  323. </field>
  324. <field id="rotation_runtime" translate="label" type="time" sortOrder="60" showInDefault="1"
  325. showInWebsite="0" showInStore="0">
  326. <label>Rotation Time</label>
  327. <backend_model>Vertex\Tax\Model\Config\Backend\LogFrequency</backend_model>
  328. <depends>
  329. <field id="enable_rotation">1</field>
  330. </depends>
  331. <comment><![CDATA[The time of day the Rotation Action should occur]]></comment>
  332. </field>
  333. </group>
  334. </section>
  335. </system>
  336. </config>