Integrate the Native Tax Engine

Onboard a merchant for integrating with Point of Sale's inbuilt tax engine - the native tax engine. By default, POS supports the native tax engine.

  • Modern POS App Build: 5.x.x or above
  • Platform Support: iPhone
  • Offline Support: Yes
  • Technical Prerequisites
    • Merchants are responsible for providing the product feed having mapping for tax class for each product. Refer to Product Field Mapping to learn more about changes needed in product field mapping specific to tax functionality.
    • Merchants are responsible for providing the tax rate feed. Refer to Tax Rate Feed Specification and Setup
Important
Important

As of 2025, support for the Native Tax Engine has been discontinued. Originally designed as a back-up tax solution and not a primary tax engine, the Native Tax Engine is no longer supported with technical updates or maintenance for any new or existing customers. To ensure uninterrupted business operations, all customers still using the Native Tax Engine must migrate to an alternative solution immediately.

  • Pre-built Integrations: Point of Sale includes native connectors to seamlessly support Avalara , OneSource (Sabrix), and Vertex.
  • Custom Solutions: For any other third-party tax provider, an SPI is available to facilitate your integration.

Set Up the Tax Engine

  1. Integration screen from CMS allows setting up the native tax engine.
  2. Integration screen: CMS > Integrations > Tax Engine Configurations
  3. Provide these details to set up the native tax engine
    1. Tax Engine: Native
    2. Merchants in the Portugal Region can only select Native as their tax engine.
    3. Environment: Testing or Production.
    4. Currency: Currency Code. for example. USD.

Schedule Tax Rate File Upload

Per the specification mentioned in Tax Rate Feed Specification and Setup, you can upload the tax rate feed manually or schedule an upload. From these CMS screens, you can upload the tax rate feed.

  1. One time manual upload: Feeds > Manual Upload > Store > Tax Rates
  2. Scheduled upload: Feeds > Scheduled Upload > Tax Rates (SFTP)

Product Field Mapping

  • Point of Sale Product Feed has 13 custom attributes. They are named CustomString0, CustomString1,..., CustomString10, CustomString12.
  • You can use one of these custom attributes to receive tax class in the Point of Sale system through the feed file.
  • The custom attribute that is selected for tax class then needs to be configured in CMS's Store Setting - (CMS > Store Management > Store Setting > MODULES> Checkout > tax.field) For exxample, if CustomString12 is selected for taxClass, then configure it under this store setting. Make sure to provide it as customString12, because it's case-sensitive. With this configuration Point of Sale system knows that which custom attribute is being used for tax class purposes.
  • Once the custom attribute is finalized, use the same in product feed mapping. Product field mapping specifies the mapping between feed file attributes and Point of Sale system product attributes. The mapping is configured in CMS under the field mapping section CMS > Feeds > Field Mapping > Products. The field mapping for tax class needs to be configured for either of the below scenarios
    1. Product-specific tax rates:
    2. If the tax rates are product specific then each product from the feed file will have its corresponding tax class.
    3. For example, the Product feed file has column taxClass which needs to map to CustomString12 which is the selected custom attribute for tax.
    4. Uniform tax rate across all products:
  • As all the products have the same tax rate so no need to provide tax class in the product feed. We can derive it automatically using field transformation and field mapping as below.
    1. Map the SKU / Product id field to tax class's custom attribute. In this case CustomString12.
    2. Using Field Transformation, which is available on the connecting line between SKU and CustomString12 specify the tax class. In this example, GENERIC is tax class and assumed that the same tax class would be provided in the tax feed file with its tax rate.
    3. The above configuration automatically maps all the products to tax class GENERIC without even providing the tax class column in the product feed.

POS Behavior

Refer to POS Tax to learn more about how the taxes, tax exemption, or tax overrides are shown in Point of Sale POS after making the underlying tax engine call.

Supported Tax Functionality

The native tax engine supports all the tax functionality.