Integrate OneSource (Sabrix)

Facilitate tax calculations during sale transactions with OneSource (Sabrox) tax engine. Ensure that the OneSource engine handles all necessary tax computations. The process operates as follows: a real-time request is sent to OneSource with the cart details, and the corresponding VAT information is retrieved. For transactions occurring in offline mode, the necessary data is stored to enable offline processing.

  • Modern POS App Build: 6.5.4 or greater
  • Platform Support: iPad & iPhone
  • Offline Support: Yes, however, tier taxes and tax overrides are not supported offline.
  • Technical Prerequisites:
    • Merchants are responsible for configuring the tax rates directly into the OneSource system.
    • The Product Feed file should have mapping for the tax class for each product. Refer to changes needed in the Product Field Mapping .
    • Merchants are to provide the supported tax exemptions (exempt code and exempt name). Refer to step 5 from Onboarding Merchant for OneSource Integration

    • Configure the tax engine through CMS as mentioned in Set Up Tax Engine

  • Special Fee Support: Refer to Special Fees to know more about prerequisites needed for fees.

Supported Tax Functionality

These tax-related functions are supported by the POS if it is powered by the OneSource tax engine:

  • Calculate taxes and fees: Refer to Special Fees to learn more about fees
  • Tax exemption
  • Tax override: If overridden, tax rates (for example tax holidays), are configured in OneSource
  • Tier taxes: If Tier taxes are configured in OneSource
  • Tax exemption during offline

Set Up Tax Engine

The integration screen from CMS allows setting up the OneSource within the Point of Sale system.

  1. In CMS, go to Integrations | Tax Engine Configurations.
  2. Click Create.
  3. Under General Settings, provide these details:
    1. Tax Engine: Select "Sabrix".
    2. Environment: Select the environment (Testing or Production).
    3. Currency: Select the currency code (for example, USD).
  4. Under Connectivity and Authentication, provide these details:
    1. Base URL: Input the OneSource WSDL URL, e.g., https://kpmg-uat.hostedtax.thomsonreuters.com/sabrix/services/taxcalculationservice/2011-09-01/taxcalculationservice.
    2. Merchant Gateway ID: Provide OneSource's tax calculation service username.
    3. Merchant Key: Provide OneSource's tax calculation service's password.
    4. Merchant Reference Code: Provide the external company ID.
  5. Under Shipping Tax Configuration, configure custom shipping costs and the default shipping cost.
  6. Under Advanced, configure the values for CallingSystemNumber and HostSystemNumber if required for tax calculations. The specified values will be included in all tax requests. If a value is saved, it's sent with each request. If no value is provided, the field is omitted. A settings page shows general settings, contextual links, and authentication settings.

Schedule Tax Rate File Download

As taxes are computed directly by OneSource, the tax feed isn't necessary for online processing. However, to calculate the taxes during the offline mode, the tax feed needs to be downloaded directly from OneSource.

To download the tax rate file from OneSource, schedule a download job in CMS as mentioned below:

Note
Note As a prerequisite, the tax engine should be configured for OneSource per Set Up Tax Engine.
  1. In CMS, go to Feeds | Scheduled Upload.
  2. Click + to create a job and select Tax Rates.
  3. Under Feed Source Type, select "Sabrix".
  4. Configure the rest of the required fields. A settings menu to schedule a feed import.
  5. Save your changes.
Note
Note No need to provide a separate feed file for tax rate.

Ad Hoc Tax Rate File Download

As mentioned in the earlier section, the tax feed is important for tax calculation during offline mode and it can also be downloaded as and when needed along with the above option of scheduled download. To download the tax rate file from OneSource into Point of Sale, the 'Import Now' option from the scheduled job can be used as below:

  1. In CMS, go to Feeds | Scheduled Upload.
  2. Edit the previously configured Tax Rate job.
  3. Click Import Now.
Note
Note If the job is not scheduled, schedule it per the instruction in Schedule Tax Rate File Download, and then use Import Now.

Product Field Mapping

To support tax calculation in offline mode, the following product feed attribute mapping is needed to add tax type dynamically while setting up the field mapping for product feed.

  1. In CMS, go to Feeds | Field Mapping | Products.
  2. Using Field Transformation, map the SKU / Product ID field from the product feed file to CustomString12. CustomString12 is the Point of Sale attribute for the product-level tax class used by the POS app during offline mode.

A diagram shows source fields mapped to target fields.A form displays field transformation from SKU to custom string.

Commit Tax Transaction

The POS allows committing the tax transaction conditionally in OneSource after-sale transactions. The conditional commit allows merchants to complete the tax transaction after the invoicing is done on the sale transaction. By default, the POS doesn't commit the tax transaction but lets the merchant commit it. But to enable the auto-commit after completing the sale transaction in the POS app, the following CMS config needs to be set:

  1. In CMS, go to Store Management | Store Settings | Modules | Tax.
  2. Turn on Submit/Finalize Tax Details After Order Submission.
  3. Save your changes.

Onboarding Merchant for OneSource Integration

  1. Merchants are to provide the OneSource details per the Technical Prerequisites.
  2. Point of Sale's integration with OneSource is SOAP-based.
  3. For offline transactions, Point of Sale supports the tax rate file download from OneSource. Point of Sale uses CalculateTax SOAP API to obtain the taxes for all stores and tax classes from respective stores. The same API determines the tax exemption rates for all stores and tax classes.
  4. Product feed changes for OneSource integration. The CMS configurations listed under Product Field Mapping are required for proper tax computation during offline transactions.
  5. Merchants are to provide the supported tax exemptions (exempt code and exempt name) to configure in the system. The job, mentioned in Step #3, that downloads the tax exemption data directly from OneSource, needs this list of supported tax exemptions for the first time run.

Online vs Offline

Online

In online mode, the process begins with items being added to the cart. Subsequently, detailed cart data, including product IDs, tax codes, and quantities, are sent to OneSource for tax computation. OneSource then calculates and returns the VAT amounts based on the provided data. Following the VAT computation, the transaction moves to the tendering phase where payment is processed. The process concludes with the completion of the order, during which the Transaction Log (tLog) and Electronic Journal (EJ) record the total order amount and the VAT component.

Offline

In the offline mode, the POS system autonomously downloads the tax data from OneSource. This data is then leveraged to accurately compute the VAT amounts for orders processed without an active internet connection.

Known Issues and Restrictions

These features aren't supported as part of OneSource integration and hence, merchants that use OneSource can't use them.

  • Tier taxes in offline mode: OneSource has a limitation where it does not provide the tier tax rates for offline calculation.
  • Tax override in offline mode.