caret

Important changes to the Practice Manager (WorkflowMax) API coming soon

You’ll need to upgrade to API v3 to keep your connection live.

We’re 100% committed to protecting the data and privacy of our partners and customers, and in uncertain times like these, that’s more important than ever.

To meet compliance rules that are being set out by tax offices around the world and to continue leading in best practice, we’re implementing new global security standards for digital services providers with add-on marketplaces. You can read more about what will be required here.

Depending on how you use the WorkflowMax API (choose your scenario below), the first thing you might need to do is complete a security self-assessment questionnaire by 30 June 2020. In order to pass the assessment, you need to upgrade your API to v3 which will be available from 6 April 2020.

We understand that upgrading your API connections by 30 June might be challenging right now. Even if you’re unable to complete the AP upgrade in this timeframe, we still need you to fill in the security assessment as best you can by 30 June 2020. Then we’ll get in touch and agree an extension for you to complete the upgrade.


Here’s what’s changing for the WorkflowMax API

The existing WorkflowMax API has been split to manage business connections and practice connections, and there will be more stringent security requirements. We have created a new Xero Practice Manager API (XPM API) specifically for the accounting and bookkeeping channel and a new WorkflowMax v3 API (WFM API). There’s a different set of instructions and deadlines for each.


What you need to do

To ensure continued connection, you’ll need to upgrade your existing API connection to the new XPM API. If your app needs access to both the XPM API and WFM API, you’ll need to create two connections for your WorkflowMax and Xero Practice Manager customers.

There will also be authentication and URL changes which you will need to make to complete the upgrade.

To find out how these changes will affect you, click the link (or links) that best describes how you connect via the API to your account.

XPM user of an app I don’t own

Example: I’m an accountant using Xero Practice Manager and I also use the Practice Ignition app to integrate my client engagements, proposals and payments.

See instructions

XPM developer of an app others connect to

Example: I’m a developer and I’ve created an app for accountants and bookkeepers that integrates with XPM, like AccountKit.

See instructions

XPM bespoke, generic key, or 1:1 integrations

Example: I’m an XPM user who paid for a bespoke integration between my XPM account and another application I own, for instance my XPM account and a marketing website.

See instructions