[Completed: 2022-07-11] Changing platform keys to unique, four-letter codes
On July 11, 2022 we will be replacing the current platformKey
values (such as xero, quickbooksdesktop, sageone) with unique, four-letter codes. The new codes will be used by all endpoints that require or return a platform key.
This is to remove the platform key's dependence on a platform's display name, which may change from time to time and is outside Codat's control.
Note: This change was previously announced, and subsequently delayed, in 2021.
Action required
Update any code which interacts with any of the impacted endpoints to use the new keys.
If you'd like to test your code before this change goes live, you can either:
- enable the new behaviour for a request by adding
useDefaultKeys=false
to the query string you send to any of the impacted endpoints, or - contact our support team and request for the change to be enabled on one or all of your Codat accounts.
Expected impact if no action is taken
If your code expects the old keys, it will cease to work from July 11, 2022. Additionally, if your code sends old keys to impacted endpoints, you'll get either a 400: The specified PlatformKey ({key}) is not valid
error or a 404: No integration was found with key {key}
error depending on the endpoint you're sending an old key to.
Additional information
Impacted endpoints
platformType
sent in the body to POST /companies- the body sent to POST /companies/{companyId}/connections
key
in the response from GET /integrationsplatformKey
in the URL forplatformKey
in the URL for andkey
in the response from GET /integrations/{platformKey}
Key mappings
Accounting (sandbox)
Name | Old key | New key |
---|---|---|
Codat Sandbox |
|
|
QuickBooks Online Sandbox |
|
|
Accounting (live)
Name | Old key | New key |
---|---|---|
Clear Books |
|
|
Dynamics 365 Business Central |
|
|
Exact (Netherlands) |
|
|
Exact (UK) |
|
|
FreeAgent |
|
|
FreshBooks |
|
|
KashFlow |
|
|
Kashoo |
|
|
MYOB AccountRight and Essentials |
|
|
Oracle NetSuite |
|
|
Pandle |
|
|
QuickBooks Desktop |
|
|
QuickBooks Online |
|
|
Sage 50 (UK) |
|
|
Sage 200cloud |
|
|
Sage Intacct | 'sageintacct' | `knfz |
Sage Business Cloud Accounting |
|
|
Wave |
|
|
Xero |
|
|
Zoho Books |
|
|
Commerce (sandbox)
Name | Old key | New key |
---|---|---|
Codat Commerce Sandbox |
|
|
Stripe Test |
|
|
Commerce (live)
Name | Old key | New key |
---|---|---|
Amazon Seller Central |
|
|
BigCommerce |
|
|
Clover |
|
|
Mollie |
|
|
PayPal |
|
|
PrestaShop |
|
|
Shopify |
|
|
Square |
|
|
Stripe |
|
|
SumUp |
|
|
WooCommerce |
|
|
Zettle |
|
|
Banking (sandbox)
Name | Old key | New key |
---|---|---|
Codat Banking Sandbox |
|
|
TrueLayer Demo Bank |
|
|
Banking (live)
Name | Old key | New key |
---|---|---|
Plaid |
|
|
Allied Irish Bank Corporate |
|
|
Allied Irish Banks |
|
|
Allied Irish Banks Business |
|
|
Amex |
|
|
Banco Bilbao Vizcaya Argentaria |
|
|
Banco BPM |
|
|
Banco de Sabadell |
|
|
Banco Santander |
|
|
Bank of Ireland |
|
|
Bank of Ireland Business |
|
|
Bank of Scotland |
|
|
Bank of Scotland Business |
|
|
Banque Populaire |
|
|
Barclaycard |
|
|
Barclays |
|
|
Barclays Business |
|
|
BNP Paribas |
|
|
Caisse d'Epargne |
|
|
Caixa |
|
|
Capital One |
|
|
Chelsea Building Society |
|
|
Comdirect |
|
|
Commerzbank |
|
|
Coop |
|
|
Credit Agricole |
|
|
Credit Mutuel |
|
|
Danske Bank |
|
|
Danske Bank Business |
|
|
Deutsche Bank |
|
|
First Direct |
|
|
Halifax |
|
|
Hello bank! |
|
|
HSBC |
|
|
HSBC Business |
|
|
HypoVereinsbank |
|
|
ING Germany |
|
|
ING Poland |
|
|
Intesa San Paolo |
|
|
Lloyds |
|
|
Lloyds Business |
|
|
Lloyds Commercial |
|
|
Marks and Spencer |
|
|
mBank |
|
|
MBNA |
|
|
MetroBank |
|
|
Monzo |
|
|
NatWest |
|
|
Nationwide |
|
|
NatWest Business |
|
|
PermanentTSB |
|
|
Poste Italiane |
|
|
RBS |
|
|
Revolut |
|
|
Revolut France |
|
|
Revolut Germany |
|
|
Revolut Ireland |
|
|
Revolut Italy |
|
|
Revolut Spain |
|
|
Royal Bank of Scotland Business |
|
|
Santander |
|
|
Santander Bank Polska |
|
|
SEB Bank |
|
|
Societe Generale |
|
|
Sparkasse |
|
|
Starling |
|
|
SwedBank Lithuania |
|
|
Tesco Bank |
|
|
Tide |
|
|
TSB |
|
|
Ulster Bank Ireland |
|
|
Ulster Bank UK |
|
|
Ulster Business |
|
|
Unicredit |
|
|
Virgin Money |
|
|
Wise |
|
|
Wise France |
|
|
Wise Germany |
|
|
Wise Ireland |
|
|
Wise Italy |
|
|
Wise Spain |
|
|
Yorkshire Building Society |
|
|