Integrate Anrok & Zuora

Introduction

This guide outlines the process for linking your Zuora account with Anrok. This will allow you to automatically synchronize transactions and update sales tax to your Zuora invoices, credit memos, and debit memos.

 

Step 1 — Create an API user role in Zuora

You will need a user with administrator access to your Zuora tenant in order to proceed.

  1. Log in to Zuora Group 1 (1).png.
  2. Click on the user name in the very top right of the Zuora app and click Administration under the settings icon.
  3. In the Administration Settings page, click Manage User Roles.
  4. On the Manage Roles page, click Add New Role.
  5. In the Basic Info section on the New Role page, enter Anrok API User in the Role Name.
  6. In the Platform Permissions section, select:
    • API Write Access
    • Run Data Queries (in UI or API)
    • Events & Notifications View Access
    • Events & Notifications Resend Access
    • Events & Notifications Manage Access
    • Leave the UI Access box unchecked. 
  7. Click Save

 

Step 2 — Create an API user for Anrok

  1. Click the user name at the top right and click Administration.
  2. On the Administration Settings page, click Manage Users.
  3. On the Users page, click Add Single User to create a new user.
  4. Fill in the following fields:
    • First Name: Anrok
    • Last Name: API
    • The user Work Email and Login Name can either be an integration service user email on your end or you can use our integration service user billing-integration-support@anrok.com
    • Select Anrok API User for the Zuora Platform Role option.
    • Leave the rest of the roles as Standard User roles.
  5. Click Save to create the user. 

 

Step 3 — Respond to the Zuora invitation

  1. Visit the email inbox of your integration service user. Copy and paste the set password link into a new browser window set to INCOGNITO MODE.
  2. Follow the instructions after copying the link into an incognito browser to set up the Zuora user.
  3. Since UI access is not enabled for this user, the error message at the end of the setup flow is expected and can be ignored.

Step 4 — Create an OAuth client

  1. Head back to your main Zuora administrator account in the normal browser window. Click the user name at the top right and click Administration.
  2. On the Administration Settings page, click Manage Users.
  3. Click on any linked field for the Anrok API user.
  4. Scroll down to the New OAuth Client section. For Client Name, use Anrok OAuth Client.
  5. If you have multi-entity features enabled, select which entities the OAuth client will be permitted to access.
  6. Click Create. Zuora will display the Client ID and Client Secret for the OAuth client. This is the only time you can see the Client Secret. Please save both the Client ID and Client Secret securely in a private note.
  7. Click OK.

 

Step 5 — Create and configure the Anrok tax code

  1. Click the user name at the top right and navigate to Settings > Billing.
  2. Click Set Up Taxation Codes.
  3. Click Add New Tax Code.
  4. Enter the following information in the Basic Information panel:
    • Tax Code Name: Anrok
    • Tax Engine: Select Zuora Tax
    • At the bottom of the page in the Zuora Tax Engine: Tax Rates section, click the link to download the Tax Rate Import File.
    • Click Choose File and re-upload the file you just downloaded without modifying it.
    • Click Import Tax Rates.
    • Click Ok.
  5. Click Save.

 

Step 6 — Activate the Anrok tax code

  1. In the upper left, click < back to Tax Code list and click Activate to activate the Anrok tax code if not already active.

 

Step 7 — Connect to Anrok

  1. In the Anrok app CleanShot 2023-07-20 at 12.02.21@2x.png, go to Data sources. Take me there!
  2. Select Integrate system, then under Accounting time zoneselect the time zone that matches your Zuora account.
  3. Under Data source, select Zuora.
  4. Select the Environment to match your Zuora URL bar. Input the Zuora Client ID, the Zuora Client Secret, and the Tax Code name (should be Anrok).
  5. Click Connect to finalize the connection. During connection, Anrok will automatically mark Zuora products as "Taxable" within the selected environment. Anrok will also automatically set up Zuora event triggers.

Step 8 — Add your Zuora products as product IDs

In Anrok, your Zuora products will be called product IDsProduct ID
They describe the specific product or service that was sold to your customer. Product IDs are passed to Anrok from your billing system as the product(s) you are including on the invoice.
CleanShot 2023-08-17 at 11.17.48@2x.png
Each product ID you sell must be mapped to a corresponding tax configuration in Anrok, which signals what taxability ruleset to apply to the product.
. These product IDs are the key drivers for calculating taxability. It's important that you add your current and previous Zuora products into Anrok. See What are product IDs?

Try adding your Zuora products in the demo above ☝️

  1. Under New products detected, select a corresponding Product type and Tax category for each product detected. See What tax configuration should I select?
  2. If you'd like to assign a Product type and Tax category to multiple products at once, click the checkbox  anrok_checkbox.png  next to each product, then select Batch assign.
  3. When you are finished, scroll down and click Continue

 

Step 9 — Import your Zuora transactions

Now that you've assigned all of your product IDs, you can begin importing your historical transactions from Zuora into Anrok.

Try importing your Zuora transactions in the demo above ☝️

  1. Under Select transactions to import, select one of the following options:
    • Import all past transactions — all transactions will be imported into Anrok. This will result in a complete picture of your economic nexus and exposure.
    • Import transactions from a specific date — some past transactions will not be imported into Anrok. This may result in an incomplete picture of your economic nexus and exposure to date.
    • Continue without importing past transactions — none of your historical transactions will be imported into Anrok. This may result in an incomplete picture of your economic nexus and exposure.
  2. Select Import transactions (or Mark as finished depending on your previous selection).
  3. When your transactions have finished importing, select Mark complete.

 

Step 10 — Generate an Anrok API key

  1. In the Anrok app CleanShot 2023-07-20 at 12.02.21@2x.png, stay on Data sources. Take me there!
  2. Under Integration sources, click the option menu button anrok_option_menu.png next to Zuora, then select Manage Anrok API key.
  3. Click Generate Anrok API key, then copy  anrok_copy.png  the API key.
  4. When you are finished, click Done.

 

Step 11 — Set up the Anrok tax engine

  1. In Zuora Group 1 (1).png, click the user name at the top right and navigate to Settings > Billing.
  2. On the Billing Settings page, click Manage Features.
  3. Scroll down and check that Connect Tax Engine is enabled. If not, click Enable.
  4. Head back to the Billing Settings page and click Set Up Tax Engine and Tax Date.
  5. Click Setup New Tax Engine and select Anrok from the dropdown list.
    • Engine Name: Anrok
    • Authentication Type: Private Token
    • Security Token: paste your Anrok API key from the previous step.
  6. Click Test Connection to validate the API key.
  7. To find your Company Code, head back to the Anrok app CleanShot 2023-07-20 at 12.02.21@2x.png Data sources. Take me there!
    • Make sure you are in the right Anrok environment for this particular connection. If you have multiple Anrok environments, toggle in the upper left to the correct account.
    • In the URL bar of Anrok, your company code will be the text highlighted in green: app.anrok.com/copy-this-code/data-sources
  8. Click Save.

 

Step 12 — Associate the Anrok tax code with the Anrok tax engine

  1. In Zuora Group 1 (1).png, click the user name at the top right and navigate to Settings > Billing.
  2. On the Billing Settings page, click Set Up Taxation Codes.
  3. Click Edit next to the Anrok tax code.
  4. Set the Tax Engine to Anrok.
  5. Select the External Company Code that you set up in the previous step. 
  6. Click Save.

 

Step 13 — Add the Canada provincial tax ID custom field (Optional)

  1. In Zuora Group 1 (1).png, click the user name at the top right and navigate to Settings > Billing.
  2. On the Billing Settings page, click Manage Custom Fields.
  3. Click the Edit icon next to the Account object.
  4. Click the icon to create a new custom field.
    • Name: Province Tax ID
    • API Name: provinceTaxID__c
    • Field Type: Text
    • Max Length: 255
  5. Click Save & Close.
  6. In Zuora, click the user name at the top right and navigate to Settings > Billing.
  7. Click Set Up Tax Engine and Tax Date.
  8. Click on Anrok.
  9. Scroll down to Advanced Settings and toggle on.
  10. Click + Custom Fields on the right to add a custom field and click + Select.
  11. Check the box next to Province Tax ID and click Done.
  12. Click Use Default Template.
  13. Scroll back up to the top of the page and click Save to confirm selection of the custom field.

 

 

Can't find what you're looking for?

Submit a request to our customer care team!