Integrate Avalara for Point of Sale

Set Up Tax Engine

Important Use Avalara V2 integration. Avalara V2 synchronizes detailed tax information, including item tax, shipping tax, and total tax, with Avalara's system to verify accurate tax calculations for all orders. Avalara V1 doesn't offer syncing support and can result in tax miscalculations.

1. In CMS, go to Integrations | Tax Engine Configuration.
2. Click Create.
3. Under Tax Engine, select Avalara V2.
4. Configure the remaining fields. For field descriptions, see Integrate Tax Engines.
5. (Optional) After filling out the fields under Connectivity and Authentication, click Verify to test the connection to Avalara.
6. In CMS, go to Store Management | Store Settings | OMS | Advanced.
7. Turn on Pre-generate order ID and use it as cart ID. This setting enables Avalara's Sales Invoice Number to use Point of Sale's Order ID.
8. Save your changes.

Product Field Mapping

1. In CMS, go to Feeds | Field Mapping | Products.
2. Under Source Fields, map the tax custom attributes to a different custom attribute. For example, map taxClassID to CustomString12.
3. In CMS, go to Store Management | Store Settings | Checkout.
4. Expand Tax.
5. Under Product Field to read tax class, enter the custom string you previously mapped in camelCase format (for example, customString12).

Note Don't send a separate tax class field in the product feed.

This screenshot shows the tax class "GENERIC" configured in the product feed. During offline processing, this tax class determines the tax rate. Your tax class can differ (for example, PC040100 or PC000000) based on your Avalara mapping.

Offline process requires this product feed setting because offline processing supports a default tax class configured for all store locations.

Note Upload the product feed after completing these settings.

Schedule Tax Rate File Download

1. In CMS, go to Feeds | Scheduled Upload.
2. Click the plus (+) icon and select Tax Rates.
3. Configure the date and time of the schedule. For field descriptions, see Scheduling Feeds.
4. Under Feed Source Type, select Avalara.
5. Under Account ID, enter your Avalara account ID.
6. Under License Key, enter your Avalara license key.
7. Under Base URL, enter the Avalara base URL (for example, https://sandbox-rest.avatax.com/api/v2).
8. Under Feed File Type, select the feed file type (for example, CSV or TSV).

Note A separate feed file for the tax rate isn't required.

Commit Tax Transaction

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

Enable Value-added Tax (VAT)

1. In CMS, go to Store Management | Store Settings | Tax.
2. Turn on Is VAT enabled for this merchant.

OMS Integration

1. In CMS, go to Integrations | OMS Configuration.
2. Click Create.
3. Select the OMS type and configure the remaining fields.

Additional Information

Example JSON Request

When Point of Sale calls Avalara's API, we provide the following information and more:

• Product IDs
• Tax classes
• Shipping addresses
• Store addresses

Example

Tax service request: {
 "createTransactionModel": {
   "code": "PS00270499",
   "type": "SalesInvoice",
   "companyCode": "DEFAULT",
   "date": "2023-11-28",
   "purchaseOrderNo": "PS00270499",
   "currencyCode": "USD",
   "lines": [
     {
       "number": "1",
       "quantity": 1,
       "amount": 40.00,
       "taxCode": "P0000000",
       "itemCode": "HRL75-RF1A",
       "description": "CRMSN SPARKLE DRESS-TM D",
       "addresses": {
         "shipFrom": {
           "line1": "75 Rockefeller Plaza",
           "city": "New York",
           "region": "NY",
           "postalCode": "10019"
       },
       "shipTo": {
         "line1": "75 Rockefeller Plaza",
         "city": "New York",
         "region": "NY",
         "postalCode": "10019"
       }
     }
   },
   {
     "number": "2",
     "quantity": 1,
     "amount": 0.05,
     "itemCode": "ECHOBAGNY05",
     "description": "ORDINANCE BAG TAX",
     "addresses": {
       "shipFrom": {
         "line1": "75 Rockefeller Plaza",
         "city": "New York",
         "region": "NY",
         "postalCode": "10019"
     },
     "shipTo": {
       "line1": "75 Rockefeller Plaza",
       "city": "New York",
       "region": "NY",
       "postalCode": "10019"
     }
   }
 }
 ],
   "addresses": {
     "shipFrom": {
       "line1": "75 Rockefeller Plaza",
       "city": "New York",
       "region": "NY",
       "postalCode": "10019"
  },
   "shipTo": {
     "line1": "75 Rockefeller Plaza",
     "city": "New York",
     "region": "NY",
     "postalCode": "10019"
    }
  },
  "customerCode": "Guest"
}
}, apiEndpoint: /transactions/createoradjust, method:POST

Known Issues and Restrictions