@codat/sync-for-payroll v2.0.0

Sync for Payroll

Push payroll to accounting platforms.

SDK Installation

NPM

npm add @codat/sync-for-payroll

Yarn

yarn add @codat/sync-for-payroll

Example Usage

SDK Example Usage

Example

import { CodatSyncPayroll } from "@codat/sync-for-payroll";

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

    const result = await sdk.companies.create({
        description: "Requested early access to the new financing scheme.",
        groups: [
            {
                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
            },
        ],
        name: "Bank of Dave",
    });

    // Handle the result
    console.log(result);
}

run();

Available Resources and Operations

companies

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

connections

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

accounts

• create - Create account
• get - Get account
• getCreateModel - Get create account model
• list - List accounts

journalEntries

• create - Create journal entry
• delete - Delete journal entry
• get - Get journal entry
• getCreateModel - Get create journal entry model
• list - List journal entries

journals

• create - Create journal
• get - Get journal
• getCreateModel - Get create journal model
• list - List journals

manageData

• getDataStatus - Get data status
• getPullOperation - Get pull operation
• getPushOperation - Get push operation
• list - List push operations
• listPullOperations - List pull operations
• refreshAllDataTypes - Refresh all data
• refreshDataType - Refresh data type

companyInfo

• getAccountingProfile - Get company accounting profile

trackingCategories

• get - Get tracking categories
• list - List tracking categories

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

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 { CodatSyncPayroll } from "@codat/sync-for-payroll";

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

    const result = await sdk.companies.create(
        {
            description: "Requested early access to the new financing scheme.",
            groups: [
                {
                    id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
                },
            ],
            name: "Bank of Dave",
        },
        {
            retries: {
                strategy: "backoff",
                backoff: {
                    initialInterval: 1,
                    maxInterval: 50,
                    exponent: 1.1,
                    maxElapsedTime: 100,
                },
                retryConnectionErrors: false,
            },
        }
    );

    // Handle the result
    console.log(result);
}

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 { CodatSyncPayroll } from "@codat/sync-for-payroll";

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

    const result = await sdk.companies.create({
        description: "Requested early access to the new financing scheme.",
        groups: [
            {
                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
            },
        ],
        name: "Bank of Dave",
    });

    // Handle the result
    console.log(result);
}

run();

Error Handling

All SDK methods 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.

Example

import { CodatSyncPayroll } from "@codat/sync-for-payroll";

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

    let result;
    try {
        result = await sdk.companies.create({
            description: "Requested early access to the new financing scheme.",
            groups: [
                {
                    id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
                },
            ],
            name: "Bank of Dave",
        });
    } catch (err) {
        // Handle errors here
        throw err;
    }

    // Handle the result
    console.log(result);
}

run();

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx 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:

import { CodatSyncPayroll } from "@codat/sync-for-payroll";

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

    const result = await sdk.companies.create({
        description: "Requested early access to the new financing scheme.",
        groups: [
            {
                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
            },
        ],
        name: "Bank of Dave",
    });

    // Handle the result
    console.log(result);
}

run();

Override Server URL Per-Client

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

import { CodatSyncPayroll } from "@codat/sync-for-payroll";

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

    const result = await sdk.companies.create({
        description: "Requested early access to the new financing scheme.",
        groups: [
            {
                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
            },
        ],
        name: "Bank of Dave",
    });

    // Handle the result
    console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { CodatSyncPayroll } from "@codat/sync-for-payroll";
import { HTTPClient } from "@codat/sync-for-payroll/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000);
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new CodatSyncPayroll({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

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

import { CodatSyncPayroll } from "@codat/sync-for-payroll";

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

    const result = await sdk.companies.create({
        description: "Requested early access to the new financing scheme.",
        groups: [
            {
                id: "60d2fa12-8a04-11ee-b9d1-0242ac120002",
            },
        ],
        name: "Bank of Dave",
    });

    // Handle the result
    console.log(result);
}

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