Manage the building blocks of Codat, including companies, connections, and more.

npm add @codat/common

yarn add @codat/common

import { CodatCommon } from "@codat/common";

(async () => {
    const sdk = new CodatCommon({
        security: {
            authHeader: "",
        },
    });

    const res = await sdk.companies.create({
        description: "Requested early access to the new financing scheme.",
        name: "Bank of Dave",
    });

    if (res.statusCode == 200) {
        // handle response
    }
})();

• create - Create company
• delete - Delete a company
• get - Get company
• list - List companies
• update - Update company

• create - Create connection
• delete - Delete connection
• get - Get connection
• list - List connections
• unlink - Unlink connection
• updateAuthorization - Update authorization

• get - Get integration
• getBranding - Get branding
• list - List integrations

• getModelOptions - Get push options
• getOperation - Get push operation
• listOperations - List push operations

• all - Refresh all data
• byDataType - Refresh data type
• get - Get data status
• getPullOperation - Get pull operation
• listPullOperations - List pull operations

• createApiKey - Create API key
• deleteApiKey - Delete API key
• getProfile - Get profile ⚠️ Deprecated
• getSyncSettings - Get sync settings
• listApiKeys - List API keys
• updateProfile - Update profile
• updateSyncSettings - Update all sync settings

• configure - Configure
• getConfiguration - Get configuration

• create - Create webhook
• get - Get webhook
• list - List webhooks

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.