Platform keys

Platform keys are identifiers used to interact with integrations. You can get a list of available platform keys under the Integrations endpoint.

🚧

Changes to platform keys

To easily manage branding changes of external data sources/integrations, we have updated our platform keys to globally unique identifiers. In line with Codat's deprecation policy, you will be able to use the current platform keys until November 10, 2021.

Using the query parameter ?useDefaultKeys=false, you can view the new platform keys in the response data of endpoints that return a platform key (they could be named “key”, “sourceName”, “integrationName”, “platformKey”). Also, you can use them as input for endpoints that require a “platformKey” in the path variable or in the request body, for example:

  • POST /companies, or
  • POST /connections.

Accounting platform keys

Data source

Current

New

Sandbox

Expense Sandbox

expensesandbox

dcft

Sandbox

sandbox

mqjo

Platforms

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

pdvj

MYOB Essentials**

myobessentials

qzab

Oracle NetSuite

netsuite

akxx

Pandle

pandle

vjms

QuickBooks Desktop

quickbooksdesktop

pqsw

QuickBooks Online

quickbooksonline

qhyg

QuickBooks Online Sandbox

quickbooksonlinesandbox

ndsk

Sage 50 (UK)

sage50

hbql

Sage 200cloud

sage200cloud

jcrp

Sage Business Cloud Accounting

sageone

tgff

Wave

wave

pbtz

Xero

xero

gbol

Zoho Books

zohobooks

rwuv

📘

MYOB Essentials

As announced by MYOB, companies using MYOB Essentials are being migrated to MYOB Essentials (new). Most MYOB companies have already been migrated to this new version of MYOB, which is using the same API and keys as MYOB AccountRight.

Only instruct your clients to use MYOB Essentials if they have not been migrated to MYOB Essentials (new). If your clients have been migrated to MYOB Essentials (new), they must exclusively use our MYOB AccountRight and Essentials to link their company successfully.

Banking platform keys

Data source

Current

New

Sandbox

Banking Sandbox

bankingsandbox

qhnd

Platforms

Barclaycard

barclaycard_uk

qdlq

Barclays

barclays_uk

rbxl

Barclays Business

barclays_business_uk

jopr

Bank of Scotland

bos_uk

zwab

Demo Bank

demobank_truelayer

syin

First Direct

first_direct_uk

zgto

Halifax

halifax_uk

mbkg

HSBC

hsbc_uk

ryvk

HSBC Business

hsbc_business_uk

mhzc

Lloyds

lloyds_uk

jdze

Lloyds Business

lloyds_business_uk

eyqo

Marks and Spencer

ms_uk

ioei

MBNA

mbna

kmtu

Monzo

monzo_uk

trmk

NatWest

natwest_uk

isdq

Nationwide

nationwide_uk

cghu

Plaid

plaid

suuo

RBS

rbs_uk

sqqe

Revolut

revolut

gbhu

Santander

santander_uk

lrfp

Starling

starling_uk

mgxb

TSB

tsb_uk

cebt

Ulster Bank Ireland

ulster_ie

ektr

Ulster Bank UK

ulster_uk

ysyd

Commerce platform keys

Data source

Current

New

Sandbox

Commerce Sandbox

commercesandbox

aiwb

Platforms

Shopify

shopify

fztf

Square

square

zsth

Stripe

stripe

exgd

WooCommerce

woocommerce

ltpp

Zettle

izettlego

ugxp

Zettle Food and Drink

izettlepro

ymls


Did this page help you?