[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 /integrations
• platformKey in the URL for
  • GET ​/integrations​/{platformKey}​/branding
  • PUT ​/integrations​/{platformKey}​/enabled
  • DELETE ​/integrations​/credentials​/{platformKey}
• platformKey in the URL for and key in the response from GET ​/integrations​/{platformKey}

Key mappings

Accounting (sandbox)

Accounting (live)

Commerce (sandbox)

Commerce (live)

Banking (sandbox)

Banking (live)