@codat/sync-for-commerce-version-1

Sync for Commerce version 1

Embedded accounting integrations for POS and eCommerce platforms.

SDK Installation

NPM

npm add @codat/sync-for-commerce-version-1

Yarn

yarn add @codat/sync-for-commerce-version-1

Example Usage

SDK Example Usage

Example

import { CodatSyncCommerce } from "@codat/sync-for-commerce-version-1";
import { Locale } from "@codat/sync-for-commerce-version-1/dist/sdk/models/shared";

async function run() {
    const sdk = new CodatSyncCommerce({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.syncFlowPreferences.getConfigTextSyncFlow({
        locale: Locale.EnUs,
    });

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

run();

Available Resources and Operations

syncFlowPreferences

• getConfigTextSyncFlow - Retrieve preferences for text fields on sync flow
• getSyncFlowUrl - Retrieve sync flow url
• getVisibleAccounts - List visible accounts
• updateConfigTextSyncFlow - Update preferences for text fields on sync flow
• updateVisibleAccountsSyncFlow - Update the visible accounts on sync flow

companies

• deleteCompany - Delete a company
• getCompany - Get company
• updateCompany - Update company

connections

• deleteConnection - Delete connection
• getConnection - Get connection
• unlink - Unlink connection

accountingBankAccounts

• getAccountingBankAccount - Get bank account
• listAccountingBankAccounts - List bank accounts

commerceCustomers

• getCommerceCustomer - Get customer
• listCommerceCustomers - List customers

commerceCompanyInfo

• getCommerceCompanyInfo - Get company info

commerceLocations

• getCommerceLocation - Get location
• listCommerceLocations - List locations

commerceOrders

• getCommerceOrder - Get order
• listCommerceOrders - List orders

commercePayments

• getCommercePayment - Get payment
• getMethod - Get payment method
• listCommercePayments - List payments
• listMethods - List payment methods

commerceProducts

• getCommerceProduct - Get product
• listCommerceProducts - List products

commerceTransactions

• getCommerceTransaction - Get transaction
• listCommerceTransactions - List transactions

accountingAccounts

• createAccountingAccount - Create account
• getAccountingAccount - Get account
• listAccountingAccounts - List accounts

accountingCreditNotes

• createAccountingCreditNote - Create credit note

accountingCustomers

• createAccountingCustomer - Create customer

accountingDirectIncomes

• createAccountingDirectIncome - Create direct income

accountingInvoices

• createAccountingInvoice - Create invoice

accountingJournalEntries

• createAccountingJournalEntry - Create journal entry

accountingPayments

• createAccountingPayment - Create payment

refreshData

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

accountingCompanyInfo

• getAccountingCompanyInfo - Get company info
• refresh - Refresh company info

pushData

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

sync

• getSyncStatus - Get status for a company's syncs
• requestSync - Sync new
• requestSyncForDateRange - Sync range

configuration

• getConfiguration - Retrieve config preferences set for a company
• setConfiguration - Create or update configuration

integrations

• getIntegrationBranding - Get branding for an integration
• listIntegrations - List integrations

companyManagement

• createCompany - Create sync for commerce company
• createConnection - Create connection
• listCompanies - List companies
• listConnections - List data connections
• updateConnection - Update data connection

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { CodatSyncCommerce } from "@codat/sync-for-commerce-version-1";
import { Locale } from "@codat/sync-for-commerce-version-1/dist/sdk/models/shared";

async function run() {
    const sdk = new CodatSyncCommerce({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.syncFlowPreferences.getConfigTextSyncFlow(
        {
            locale: Locale.EnUs,
        },
        {
            strategy: "backoff",
            backoff: {
                initialInterval: 1,
                maxInterval: 50,
                exponent: 1.1,
                maxElapsedTime: 100,
            },
            retryConnectionErrors: false,
        }
    );

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

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { CodatSyncCommerce } from "@codat/sync-for-commerce-version-1";
import { Locale } from "@codat/sync-for-commerce-version-1/dist/sdk/models/shared";

async function run() {
    const sdk = new CodatSyncCommerce({
        retry_config: {
            strategy: "backoff",
            backoff: {
                initialInterval: 1,
                maxInterval: 50,
                exponent: 1.1,
                maxElapsedTime: 100,
            },
            retryConnectionErrors: false,
        },
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.syncFlowPreferences.getConfigTextSyncFlow({
        locale: Locale.EnUs,
    });

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

run();

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.

Error Object	Status Code	Content Type
errors.SDKError	400-600	/

Example

import { CodatSyncCommerce } from "@codat/sync-for-commerce-version-1";
import { Locale } from "@codat/sync-for-commerce-version-1/dist/sdk/models/shared";

async function run() {
    const sdk = new CodatSyncCommerce({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    let res;
    try {
        res = await sdk.syncFlowPreferences.getConfigTextSyncFlow({
            locale: Locale.EnUs,
        });
    } catch (err) {
        if (err instanceof errors.SDKError) {
            console.error(err); // handle exception
            throw err;
        }
    }

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

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

#	Server	Variables
0	https://api.codat.io	None

Example

import { CodatSyncCommerce } from "@codat/sync-for-commerce-version-1";
import { Locale } from "@codat/sync-for-commerce-version-1/dist/sdk/models/shared";

async function run() {
    const sdk = new CodatSyncCommerce({
        serverIdx: 0,
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.syncFlowPreferences.getConfigTextSyncFlow({
        locale: Locale.EnUs,
    });

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

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: str optional parameter when initializing the SDK client instance. For example:

import { CodatSyncCommerce } from "@codat/sync-for-commerce-version-1";
import { Locale } from "@codat/sync-for-commerce-version-1/dist/sdk/models/shared";

async function run() {
    const sdk = new CodatSyncCommerce({
        serverURL: "https://api.codat.io",
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.syncFlowPreferences.getConfigTextSyncFlow({
        locale: Locale.EnUs,
    });

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

run();

Custom HTTP Client

The Typescript SDK makes API calls using the axios HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance object.

For example, you could specify a header for every request that your sdk makes as follows:

import { @codat/sync-for-commerce-version-1 } from "CodatSyncCommerce";
import axios from "axios";

const httpClient = axios.create({
    headers: {'x-custom-header': 'someValue'}
})

const sdk = new CodatSyncCommerce({defaultClient: httpClient});

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
authHeader	apiKey	API key

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { CodatSyncCommerce } from "@codat/sync-for-commerce-version-1";
import { Locale } from "@codat/sync-for-commerce-version-1/dist/sdk/models/shared";

async function run() {
    const sdk = new CodatSyncCommerce({
        security: {
            authHeader: "Basic BASE_64_ENCODED(API_KEY)",
        },
    });

    const res = await sdk.syncFlowPreferences.getConfigTextSyncFlow({
        locale: Locale.EnUs,
    });

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

run();

Support

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.

Library generated by Speakeasy