This is a staging build of the docs
We've reorganized our products to make building with Codat easier than ever
Skip to main content

Test your Codat solution

Review our suggestions, best practices, and strategies for testing your Codat build

Testing is a key component of any software development process, both during the implementation and after go-live if changes are made to the solution. Here is what Codat recomments for testing your Codat build.

Using a test instance​

We recommend you use an additional instance of Codat for testing purposes. Upgrade to our Start-up plan, and we will automatically clone your existing client to create a test instance for you. We copy the following details and settings:

  • All users with access to the existing client
  • Client settings and feature overrides
  • Enabled products and deprecations
  • Integration-specific settings and credentials
  • Client sync settings
  • Webhook rules and settings
  • Auth flow settings

We work directly with our Enterprise clients to arrange test instance creation.

Users can switch between the production client and the test client by using the client dropdown in the Codat Portal.

Tips and pitfalls​

  1. Your test client will have a separate set of API keys, and you may need to maintain different credentials for the integrations in the test instance.

  2. To see the new client once it's been created, you will need to reauthenticate. Log out and log back in if you are using Portal, or get a new token if you are using our APIs.

  3. Test clients are limited to 50 active connected companies and are not included in the billing.

Testing strategy​

When planning a testing strategy and scope for your implementation, consider including the following approaches:

  1. Back-end integration testing

    Once you complete the initial API build to Codat's endpoints, you need to ensure the integration is working as expected. We recommend performing the validation using sandbox data.

  2. Live SMB testing

    Involve one of your real SMB customers to perform authentication via your front-end digital application flow. Then, verify that the data syncs between the relevant platform and Codat and triggers a webhook into your system to start the data pull.

Back-end integration testing​

When testing your integrations throughout the implementation, it is important to check you can authorize and complete the connections before you proceed to live SMB testing.

We recommend using Codat Sandbox integrations that contain sample data generated as a tool for developer testing. When you link to these integrations, you can choose from a number of different datasets that provide varying levels of detail. These integrations are enabled by default and do not require any credentials to authorize.

You can also sign up and test with Xero and QuickBooks Online, both of which offer demo or sandbox companies equipped with sample data. Other integrations also provide free trials in order to test the connections, but may not provide sample data.

Testing in production instance

In your production instance, active companies that are connected only to Codat Sandbox or QuickBooks Online Sandbox are excluded from billing.

Overview of integrations' test accounts​

PlatformIntegration typeAccount typeNotes
Codat SandboxSandbox integrationDemo companyActive companies connected only to Codat Sandbox are excluded from billing in your production instance.
Read more about testing this integration.
ClearBooksLive integrationFree trial
ExactLive integrationFree trial
FreeAgentLive integrationFree trialTemporary free account at the FreeAgent Sandbox.
FreshBooksLive integrationFree trial
KashFlowLive integrationFree trialContact KashFlow support to request a test developer account.
MYOBLive integrationDemo companyCodat only supports data hosted online. When setting up the account, you will receive instructions on loading demo files.
Microsoft 365 Dynamics Business CentralLive integrationSandbox environmentRead more about testing this integration.
QuickBooks DesktopLive integrationFree trial
QuickBooks OnlineSandbox integrationDemo companyActive companies connected only to QuickBooks Online Sandbox are excluded from billing in your production instance.
Read more about testing this integration.
Sage 50 and Business CloudLive integrationFree trialSage also provides a Postman collection with pre-filled test data.
PandleLive integrationFree account
WaveLive integrationFree account
XeroLive integrationDemo companyDemo does not include automatic bank feeds and the ability to invite other users. You are able to add your own data, but the demo company resets itself after 28 days.
Read more about testing this integration.
Zoho BooksLive integrationTest companyWhen setting up a test organisation, you can choose to import or create test data.
Read more about testing this integration.
PlaidLive integrationSandbox environmentInitial setup for Plaid needs to be complete to gain access to the sandbox environment with demo data.
Read more about testing this integration.
Was this page useful?
❤️
👍
🤔
👎
😭

Contents

Suggest edits