@codat/sync-for-expenses

Sync for Expenses

Embedded accounting integrations for corporate card providers.

SDK Installation

NPM

npm add @codat/sync-for-expenses

PNPM

pnpm add @codat/sync-for-expenses

Bun

bun add @codat/sync-for-expenses

Yarn

yarn add @codat/sync-for-expenses zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

Example Usage

SDK Example Usage

Example

import { CodatSyncExpenses } from "@codat/sync-for-expenses";

const codatSyncExpenses = new CodatSyncExpenses({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncExpenses.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

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

run();

Available Resources and Operations

companies

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

connections

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

configuration

• get - Get company configuration
• set - Set company configuration

mappingOptions

• getMappingOptions - Mapping options

sync

• getLastSuccessfulSync - Last successful sync
• getLatestSync - Latest sync status
• list - List sync statuses
• get - Get sync status

transactionStatus

• list - List sync transactions
• get - Get sync transaction

expenses

• create - Create expense transaction
• update - Update expense transactions

transfers

• create - Create transfer transaction

adjustments

• create - Create adjustment transaction

reimbursements

• create - Create reimbursable expense transaction
• update - Update reimbursable expense transaction

attachments

• upload - Upload attachment

manageData

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

pushOperations

• list - List push operations
• get - Get push operation

accounts

• create - Create account
• getCreateModel - Get create account model

customers

• list - List customers
• get - Get customer
• create - Create customer
• update - Update customer

suppliers

• list - List suppliers
• get - Get supplier
• create - Create supplier
• update - Update supplier

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

const codatSyncExpenses = new CodatSyncExpenses({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncExpenses.companies.list(
        {
            page: 1,
            pageSize: 100,
            query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
            orderBy: "-modifiedDate",
        },
        {
            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 { CodatSyncExpenses } from "@codat/sync-for-expenses";

const codatSyncExpenses = new CodatSyncExpenses({
    retryConfig: {
        strategy: "backoff",
        backoff: {
            initialInterval: 1,
            maxInterval: 50,
            exponent: 1.1,
            maxElapsedTime: 100,
        },
        retryConnectionErrors: false,
    },
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncExpenses.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

    // 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.

Error Object	Status Code	Content Type
errors.ErrorMessage	400,401,402,403,404,429,500,503	application/json
errors.SDKError	4xx-5xx	/

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted string since validation errors can list many issues and the plain error string may be difficult read when debugging.

import { CodatSyncExpenses } from "@codat/sync-for-expenses";
import { SDKValidationError } from "@codat/sync-for-expenses/sdk/models/errors";

const codatSyncExpenses = new CodatSyncExpenses({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    let result;
    try {
        result = await codatSyncExpenses.companies.list({
            page: 1,
            pageSize: 100,
            query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
            orderBy: "-modifiedDate",
        });
    } catch (err) {
        switch (true) {
            case err instanceof SDKValidationError: {
                // Validation errors can be pretty-printed
                console.error(err.pretty());
                // Raw value may also be inspected
                console.error(err.rawValue);
                return;
            }
            case err instanceof errors.ErrorMessage: {
                console.error(err); // handle exception
                return;
            }
            default: {
                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:

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

import { CodatSyncExpenses } from "@codat/sync-for-expenses";

const codatSyncExpenses = new CodatSyncExpenses({
    serverIdx: 0,
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncExpenses.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

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

const codatSyncExpenses = new CodatSyncExpenses({
    serverURL: "https://api.codat.io",
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncExpenses.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

    // 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 { CodatSyncExpenses } from "@codat/sync-for-expenses";
import { HTTPClient } from "@codat/sync-for-expenses/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 CodatSyncExpenses({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme
authHeader	apiKey	API key

To authenticate with the API the authHeader parameter must be set when initializing the SDK client instance. For example:

import { CodatSyncExpenses } from "@codat/sync-for-expenses";

const codatSyncExpenses = new CodatSyncExpenses({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncExpenses.companies.list({
        page: 1,
        pageSize: 100,
        query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
        orderBy: "-modifiedDate",
    });

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

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { CodatSyncExpenses } from "@codat/sync-for-expenses";

const codatSyncExpenses = new CodatSyncExpenses({
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
    const result = await codatSyncExpenses.attachments.upload({
        companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
        syncId: "6fb40d5e-b13e-11ed-afa1-0242ac120002",
        transactionId: "336694d8-2dca-4cb5-a28d-3ccb83e55eee",
    });

    // 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