[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

Key mappings

Accounting (sandbox)

Name

Old key

New key

Codat Sandbox

sandbox

mqjo

QuickBooks Online Sandbox

quickbooksonlinesandbox

ndsk

Accounting (live)

Name

Old key

New key

Clear Books

clearbooks

jhch

Dynamics 365 Business Central

dynamics365businesscentral

trji

Exact (Netherlands)

exactnetherlands

qudb

Exact (UK)

exact

pbbf

FreeAgent

freeagent

fbrh

FreshBooks

freshbooks

vxvy

KashFlow

kashflow

wvzu

Kashoo

kashoo

lcvn

MYOB AccountRight and Essentials

myobaccountright
myobessentials

pdvj

Oracle NetSuite

netsuite

akxx

Pandle

pandle

vjms

QuickBooks Desktop

quickbooksdesktop

pqsw

QuickBooks Online

quickbooksonline

qhyg

Sage 50 (UK)

sage50

hbql

Sage 200cloud

sage200cloud

jcrp

Sage Intacct

'sageintacct'

`knfz

Sage Business Cloud Accounting

sageone

tgff

Wave

wave

pbtz

Xero

xero

gbol

Zoho Books

zohobooks

rwuv

Commerce (sandbox)

Name

Old key

New key

Codat Commerce Sandbox

commercesandbox

aiwb

Stripe Test

stripetest

yzth

Commerce (live)

Name

Old key

New key

Amazon Seller Central

amazonsellercentral

qkdj

BigCommerce

bigcommerce

vqzp

Clover

clover

fqly

Mollie

mollie

dxfw

PayPal

paypal

gvom

PrestaShop

prestashop

zgbz

Shopify

shopify

fztf

Square

square

zsth

Stripe

stripe

exgd

SumUp

sumup

pshf

WooCommerce

woocommerce

ltpp

Zettle

izettlego

ugxp

Banking (sandbox)

Name

Old key

New key

Codat Banking Sandbox

bankingsandbox

qhnd

TrueLayer Demo Bank

demobank_truelayer

syin

Banking (live)

Name

Old key

New key

Plaid

plaid

suuo

Allied Irish Bank Corporate

aib_corporate_uk

yqyd

Allied Irish Banks

aib_ie

mqqy

Allied Irish Banks Business

aib_business_ie

hftm

Amex

amex_uk

evqv

Banco Bilbao Vizcaya Argentaria

bbva_es

dtff

Banco BPM

bancobpm_it

thnn

Banco de Sabadell

bancodesabadell_es

xjhq

Banco Santander

santander_es

wnfg

Bank of Ireland

bankofireland_ie

yhlt

Bank of Ireland Business

bankofireland_business_ie

lyhq

Bank of Scotland

bos_uk

zwab

Bank of Scotland Business

bos_business_uk

lvxw

Banque Populaire

banquepopulaire_fr

tpyh

Barclaycard

barclaycard_uk

qdlq

Barclays

barclays_uk

rbxl

Barclays Business

barclays_business_uk

jopr

BNP Paribas

bnpparibas_fr

bsdr

Caisse d'Epargne

caissedepargne_fr

vrfk

Caixa

caixa_es

vksz

Capital One

capitalone_uk

tqsf

Chelsea Building Society

chelseabuildingsociety_uk

bypc

Comdirect

comdirect_de

pvfv

Commerzbank

commerzbank_de

zsqs

Coop

coop_uk

exne

Credit Agricole

creditagricole_fr

zcgh

Credit Mutuel

creditmutuel_fr

ztlw

Danske Bank

danskebank_uk

rmdk

Danske Bank Business

danskebank_business_uk

hstz

Deutsche Bank

deutschebank_de

bvsk

First Direct

first_direct_uk

zgto

Halifax

halifax_uk

mbkg

Hello bank!

hellobank_fr

vmys

HSBC

hsbc_uk

ryvk

HSBC Business

hsbc_business_uk

mhzc

HypoVereinsbank

hypovereinsbank_de

ycdt

ING Germany

ing_de

dxmc

ING Poland

ing_pl

rlnb

Intesa San Paolo

intesasanpaolo_it

vdng

Lloyds

lloyds_uk

jdze

Lloyds Business

lloyds_business_uk

eyqo

Lloyds Commercial

lloyds_commercial_uk

scxl

Marks and Spencer

ms_uk

ioei

mBank

mbank_pl

slmx

MBNA

mbna

kmtu

MetroBank

metro_uk

igxq

Monzo

monzo_uk

trmk

NatWest

natwest_uk

isdq

Nationwide

nationwide_uk

cghu

NatWest Business

natwest_business_uk

ncmp

PermanentTSB

ptsb_ie

pskn

Poste Italiane

posteitaliane_it

qvvk

RBS

rbs_uk

sqqe

Revolut

revolut

gbhu

Revolut France

revolut_fr

ftxj

Revolut Germany

revolut_de

rjbk

Revolut Ireland

revolut_ie

hnnk

Revolut Italy

revolut_it

wpkn

Revolut Spain

revolut_es

zwbb

Royal Bank of Scotland Business

rbs_business_uk

tzvy

Santander

santander_uk

lrfp

Santander Bank Polska

santander_pl

vdcw

SEB Bank

sebbank_lt

pkxy

Societe Generale

societegenerale_fr

jwmd

Sparkasse

sparkasse_de

ckgw

Starling

starling_uk

mgxb

SwedBank Lithuania

swedbank_lt

flxm

Tesco Bank

tescobank_uk

njvn

Tide

ujxx

cbjq

TSB

tsb_uk

cebt

Ulster Bank Ireland

ulster_ie

ektr

Ulster Bank UK

ulster_uk

ysyd

Ulster Business

ulster_business_uk

bbmg

Unicredit

unicredit

kblh

Virgin Money

virginmoney_uk

pqmj

Wise

wise_uk

jxsm

Wise France

wise_fr

lywm

Wise Germany

wise_de

tjjx

Wise Ireland

wise_ie

hrfq

Wise Italy

wise_it

ztbs

Wise Spain

wise_es

wbqx

Yorkshire Building Society

yorkshirebuildingsociety_uk

hhqr