Connections

Concept overview and key details

A data connection represents a company's connection to a data source and allows you to synchronize data (read and/or write) with that source.

A company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:

Accounting data - 1 active connection.
Banking data - Multiple active connections.
Commerce data - Multiple active connections.

Any combination of accounting, banking, and commerce data connections is allowed.

Before you can use a data connection to read or write data, the company must grant you access to their business data by linking the connection.

Connection status

Connections can have one of the statuses described in the following table.

Status	Definition
`Linked`	The connection is linked to a data source; you can use it to read and write a company's consented data to and from the underlying provider's platform.
`PendingAuth`	The company hasn't authorized access to their financial platform (the data source). The SMB customer selected the platform in Link but did not complete the authorization flow.
`Deauthorized`	The connection was linked but is no longer able to access data from the underlying provider's platform. You can access any data that was already read or written using this data connection. However, you can't perform any new read or write operations until the connection is re-linked. A data connection usually becomes Deauthorized if the company revoked your access or an expiry time was reached.
`Unlinked`	The data connection was previously linked but you asked for your access to be revoked (see Disconnect a data connection to revoke your access to a data source). Similar to Deauthorized, you can still access any data that was already read or written using the data connection, but can't perform any new read or write operations unless the connection is re-linked.
No connections	The company has been created but does not have any connections to financial platforms established in any of the above statuses.

Linked data connection example

Verify that a connection returns a Linked status using one of our Connections endpoints.

In the response, note the following fields:

sourceId identifies the source of information, like a bank or accounting software;
integrationId identifies the Codat integration that supports the data source.

GET /companies/{companyId}/connections
{
  "id": "00000000-0000-0000-0000-000000000000",
  "integrationId": "18cb53c4-3807-4a5a-8da9-303053a40002",
  "sourceId": "58e1d32f-a092-438a-bffb-3bf6af9ba8ec",
  "platformName": "Sage 50 (UK & Ireland)",
  "linkUrl": "https://link.codat.io/companies/00000000-0000-0000-0000-000000000000/connections/00000000-0000-0000-0000-000000000000/start",
  "status": "Linked",
  "lastSync": "2022-01-01T12:00:00.0000000Z",
  "created": "2021-01-01T12:00:00Z",
  "sourceType": "Accounting"
}

Disconnect a data connection to revoke your access to a data source

You can disconnect a data connection using the Codat Portal. Navigate to Companies, choose the company you want to manage connections for, then select Manage connections and use the three-dot menu to unlink the connection.

This revokes your access to synchronize data with the linked company and sets the data connection's status to Unlinked.

Alternatively, you can use our Unlink connection endpoint. To disconnect a data connection, you'll need to provide:

The companyId of the linked company as a path parameter.
The connectionId of the data connection to disconnect as a path parameter.
A status of Unlinked in the request body.

When a connection is set to Unlinked, you can continue to access any data that was already read or written to the data source, but you can't perform any new read or write operations (unless the connection is re-linked).

Unlinking data connections

Only Linked data connections can be unlinked.

Example: Disconnect a data connection

cURL
Python
TypeScript
Go
C#

curl --request PATCH \
      --url "https://api.codat.io/companies/{companyId}/connections/{connectionId}" \
      --header "Authorization: {codatAuthHeader}" \
      --header "accept: application/json" \
      --header "content-type: application/json" \
      --data '{
        "status": "Unlinked"
      }'

from codat_platform import CodatPlatform
from codat_platform.models import operations, shared

codat_platform = CodatPlatform(
    security=shared.Security(
        auth_header='{codatAuthHeader}',
    ),
)

req = codat_platform.connections.unlink(request={
        "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
        "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
        "update_connection_status": {
            "status": shared.DataConnectionStatus.UNLINKED,
        },
    }
)

import { CodatPlatform } from "@codat/platform";

const codatPlatform = new CodatPlatform({
  authHeader: "",
});

codatPlatform.connections
  .unlink({
    companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
    connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    updateConnectionStatus: {
      status: "Unlinked",
    },
  })
  .then((res) => {
    if (res) {
      // handle response
    }
  });

package main

import(
	"context"
	"log"
	"github.com/codatio/client-sdk-go/platform"
	"github.com/codatio/client-sdk-go/platform/pkg/models/shared"
	"github.com/codatio/client-sdk-go/platform/pkg/models/operations"
)

func main() {
    codatPlatform := codatplatform.New(
        codatplatform.WithSecurity(shared.Security{
            AuthHeader: "{codatAuthHeader}",
        }),
    )

    ctx := context.Background()
    res, err := codatPlatform.Connections.Unlink(ctx, operations.UnlinkConnectionRequest{
        UpdateConnection: &shared.UpdateConnection{
            Status: shared.DataConnectionStatusUnlinked.ToPointer(),
        },
        CompanyID: "{companyId}",
        ConnectionID: "{connectionId}",
    })
    if err != nil {
        log.Fatal(err)
    }

    if res.Connection != nil {
        // handle response
    }
}

using CodatPlatform;
using CodatPlatform.Models.Shared;
using CodatPlatform.Models.Operations;

var codatPlatform = new CodatPlatformSDK(
    security: new Security() {
        AuthHeader = "{codatAuthHeader}",
    }
);

var res = await codatPlatform.Connections.UnlinkAsync(new UnlinkConnectionRequest() {
    UpdateConnection = new UpdateConnection() {
        Status = DataConnectionStatus.Unlinked,
    },
    CompanyId = "{companyId}",
    ConnectionId = "{connectionId}",
});

Sample response to `Unlinked` request

{
  "id": "69c25cc8-e1cd-4b63-b43d-75da021df35d",
  "integrationId": "43b64770-a953-46d6-ab30-46c21094a276",
  "sourceId": "9a96f326-226a-4e0f-923a-6758fdba40cc",
  "platformName": "Stripe",
  "linkUrl": "https://link.codat.io/link/start/c9219b93-4eff-4806-99d8-ed3337b6ded2/69c25cc8-e1cd-4b63-b43d-75da021df35d",
  "status": "Unlinked",
  "lastSync": "2021-02-11T12:12:13.1988465Z",
  "created": "2021-02-11T12:04:53Z",
  "sourceType": "Commerce"
}

Delete a data connection

You can delete a data connection using the Codat Portal. Navigate to Companies, choose the company you want to manage connections for, then select Manage connections and use the three-dot menu to delete the connection.

Alternatively, you can send a request to the DELETE /connectionId endpoint and provide the companyId and connectionId as path parameters.

cURL
Python
TypeScript
Go
C#

curl --request DELETE \
      --url "https://api.codat.io/companies/{companyId}/connections/{connectionId}" \
      --header "Authorization: {codatAuthHeader}" \

from codat_platform import CodatPlatform
from codat_platform.models import operations, shared

codat_platform = CodatPlatform(
    security=shared.Security(
        auth_header="{codatAuthHeader}",
    ),
)

res = codat_platform.connections.delete(
  request={
        "company_id": "8a210b68-6988-11ed-a1eb-0242ac120002",
        "connection_id": "2e9d2c44-f675-40ba-8049-353bfcb5e171",
    }
)

import { CodatPlatform } from "@codat/platform";

const codatPlatform = new CodatPlatform({
  authHeader: "{codatAuthHeader}",
});

codatPlatform.connections
  .delete({
    companyId: "{companyId}",
    connectionId: "{connectionId}",
  })
  .then((res) => {
    console.log("Connection deleted successfully");
  });

package main

import(
  "context"
  "log"
  "github.com/codatio/client-sdk-go/platform"
  "github.com/codatio/client-sdk-go/platform/pkg/models/shared"
  "github.com/codatio/client-sdk-go/platform/pkg/models/operations"
)

func main() {
    codatPlatform := codatplatform.New(
        codatplatform.WithSecurity(shared.Security{
            AuthHeader: "{codatAuthHeader}",
        }),
    )

    ctx := context.Background()
    res, err := codatPlatform.Connections.Delete(ctx, operations.DeleteConnectionRequest{
        CompanyID: "{companyId}",
        ConnectionID: "{connectionId}",
    })
    if err != nil {
        log.Fatal(err)
    }

    if res.StatusCode == http.StatusOK {
        log.Print("Connection deleted successfully")
    }
}

using CodatPlatform;
using CodatPlatform.Models.Shared;
using CodatPlatform.Models.Operations;

var codatPlatform = new CodatPlatformSDK(
    security: new Security() {
        AuthHeader = "{codatAuthHeader}",
    }
);

var res = await codatPlatform.Connections.DeleteAsync(new DeleteConnectionRequest() {
    CompanyId = "{companyId}",
    ConnectionId = "{connectionId}",
});

if(res.StatusCode == 200){
  Console.WriteLine("Connection deleted successfully");
}

When you delete a data connection:

You can't make any data read or write operations against the underlying data provider.
The data connection isn't returned by GET /connections or GET /companies.

Provide credentials or tokens for a data connection

If you are migrating an existing integration to use Codat, you can provide tokens for the connection to migrate your users access. You can read more about how to do this on our migration page.

Connections

Connection status

Linked data connection example

Disconnect a data connection to revoke your access to a data source

Example: Disconnect a data connection

Sample response to `Unlinked` request

Delete a data connection

Provide credentials or tokens for a data connection

Read next

Contents

ConnectionConnection 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. status​

Linked data connectionConnection 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. example​

Example: Disconnect a data connectionConnection 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.​

Sample response to Unlinked request​

Delete a data connectionConnection 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.​

Provide credentials or tokens for a data connectionConnection 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.​

Read next​

Contents

Connection status

Linked data connection example

Example: Disconnect a data connection

Sample response to `Unlinked` request

Delete a data connection

Provide credentials or tokens for a data connection

Read next