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 recommends for testing your Codat build.

Using a test instance

We recommend you use an additional instance of Codat for testing purposes. We work directly with our Full access clients to arrange test instance creation and copy the following details and settings:

  • All users with access to the existing client
  • Client settings and feature overrides
  • Enabled solutions and deprecations
  • Integration-specific settings and credentials
  • Client syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. settings
  • WebhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. consumer endpoints and settings
  • Auth flow settings

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 APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. 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 APIsAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms..

  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 APIAPI A set of rules and protocols that allows different software applications to communicate with each other. Codat provides APIs for accessing financial data from accounting, banking, and commerce platforms. 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 SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. testing

    Involve one of your real SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. customers to perform authentication via your front-end digital application flow. Then, verify that the data syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. between the relevant platform and Codat and triggers a webhookWebhook An automated notification sent from Codat to your application when specific events occur, such as when data syncs complete or connections change status. into your system to start the data read.

Back-end integration testing

When testing your integrations throughout the implementation, it is important to check you can authorize and complete the connectionsConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform. before you proceed to live SMBSMB The primary customer segment that Codat helps businesses serve, typically companies with annual revenues under $500 million. testing.

We recommend using Codat Sandbox integrations that contain sample data generated as a tool for developer testing. When you linkLink The authorization flow that allows end users to connect their accounting, banking, or commerce platforms to your application via Codat. 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 connectionsConnection A link between a Codat company and a data source (like an accounting platform). Each connection represents authorized access to pull or push data from that platform., but may not provide sample data.

Overview of integrations' test accounts

PlatformIntegration typeAccount typeNotes
Codat SandboxSandbox integrationDemo companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.Active companies connected only to Codat Sandbox are excluded from billing in your production instance.
Read more about testing this integration.
Clear BooksLive integrationFree trial
Exact NLLive integrationFree trial
FreeAgentLive integrationFree trialTemporary free account at the FreeAgent Sandbox.
FreshBooksLive integrationFree trial
MYOBLive integrationDemo companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.Codat 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 companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.Active 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 companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.Demo does not include automatic bank feedsBank Feeds A Codat product that enables automatic synchronization of bank transaction data into a company's accounting software. and the ability to invite other users. You are able to add your own data, but the demo companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources. resets itself after 28 days.
Read more about testing this integration.
Zoho BooksLive integrationTest companyCompany In Codat, a company represents your customer's business entity. Companies can have multiple connections to different data sources.When setting up a test organization, 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?
👏
👍
🤔
👎
😭