Core concepts

Throughout this documentation, you will come across a number of core concepts and terms used throughout our Products:

Concept

Description

Next Steps

Companies

A company represents a SME user who has granted you access to view a subset of their accounting, commerce or banking data (referred to as their consented data).

Each company has one or more data connections that connect the company to a Codat integration for accounting, commerce or banking.

Read more about Companies

Follow our guide to creating your first Company

Data Connections

A data connection represents the connection between a company and one of their sources of business data, such as an accounting app or payments system.

Each data connection is unique to a specified Codat integration.

Data connections have a current state; a linkUrl to allow SME users to authorize or reauthorize the data connection to their contributed data; and other metadata, such as the last refresh date.

Read more about Data Connections

Follow our guide to creating your first Company

Integrations

An integration is a connection to an external source of business data in an accounting, commerce or banking app or platform used by a SME. For example, the Xero, Shopify and Plaid integrations.

Integrations are designed, built and maintained by Codat, and updated periodically to accommodate changes to the source data and provider APIs.

Integrations have a sourceType that describes the type of data they provide: either Accounting, Commerce (sales data), or Banking.

Read more about Integrations

Configure your Accounting Integrations

Configure your Banking Integrations

Configure your Accounting Integrations

Sync Settings

Codat allows you to configure the types of data and frequency you update the data from data connections

Configuring your Sync Settings

Alerts

Codat allows you to receive notifications by webhook or email for a number of events, such as when a Company has refreshed their data or a Data Connection has become deauthorized so you can take the appropriate action.

Setup and Configure your Alerts

Users

Codat allows you to add users to your instance, with different roles and permissions; and also to manage Single Sign On with Google or Microsoft.

Read more about administrating users on your Codat instance

Data Status

When looking at the status of a refresh of data in the Codat Portal, you may see datasets in various states, such as Completed, Queued or AuthError.

Read more about the possible statuses and what they mean


Did this page help you?