Sync for Expenses is an API and a set of supporting tools. It has been built to enable corporate card and expense management platforms to provide high-quality integrations with multiple accounting software through a standardized API.

Explore product | See our OpenAPI spec

Not seeing the endpoints you're expecting? We've reorganized our products, and you may be using a different version of Sync for Expenses.

Endpoints

Endpoints	Description
Companies	Create and manage your SMB users' companies.
Connections	Create new and manage existing data connections for a company.
Configuration	View and manage mapping configuration and defaults for expense transactions.
Sync	Monitor the status of data syncs.
Expenses	Create and update transactions that represent your customers' spend.
Transfers	Create and update transactions that represent the movement of your customers' money.
Reimbursements	Create and update transactions that represent your customers' repayable spend.
Attachments	Attach receipts to a transaction for a complete audit trail.
Transaction status	Monitor the status of individual transactions in data syncs.
Manage data	Control and monitor the retrieval of data from an integration.
Push operations	View historic push operations.
Accounts	Create accounts and view account schemas.
Customers	Get, create, and update customers.
Suppliers	Get, create, and update suppliers.

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

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

Available methods

accounts

create - Create account
getCreateModel - Get create account model

adjustments

create - Create adjustment transaction

attachments

upload - Upload attachment

bankAccounts

create - Create bank account
getCreateModel - Get create bank account model

companies

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

companyInfo

get - Get company info

configuration

get - Get company configuration
set - Set company configuration

connections

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

customers

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

expenses

create - Create expense transaction
update - Update expense transactions

manageData

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

mappingOptions

getMappingOptions - Mapping options

pushOperations

list - List push operations
get - Get push operation

reimbursements

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

suppliers

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

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

transfers

create - Create transfer transaction

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. By default, an API error will throw a errors.SDKError.

If a HTTP request fails, an operation my also throw an error from the sdk/models/errors/httpclienterrors.ts module:

HTTP Client Error	Description
RequestAbortedError	HTTP request was aborted by the client
RequestTimeoutError	HTTP request timed out due to an AbortSignal signal
ConnectionError	HTTP client was unable to make a request to a server
InvalidRequestError	Any input used to create a request is invalid
UnexpectedClientError	Unrecognised or unexpected error

In addition, when custom error responses are specified for an operation, the SDK may throw their associated Error type. You can refer to respective Errors tables in SDK docs for more details on possible error types for each operation. For example, the list method may throw the following errors:

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

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

    // Handle the result
    console.log(result);
  } 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 ErrorMessage): {
        // Handle err.data$: ErrorMessageData
        console.error(err);
        return;
      }
      default: {
        throw err;
      }
    }
  }
}

run();

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.

Server Selection

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string 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.

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

accountsCreate - Create account
accountsGetCreateModel - Get create account model
adjustmentsCreate - Create adjustment transaction
attachmentsUpload - Upload attachment
bankAccountsCreate - Create bank account
bankAccountsGetCreateModel - Get create bank account model
companiesCreate - Create company
companiesDelete - Delete a company
companiesGet - Get company
companiesList - List companies
companiesUpdate - Update company
companyInfoGet - Get company info
configurationGet - Get company configuration
configurationSet - Set company configuration
connectionsCreate - Create connection
connectionsCreatePartnerExpenseConnection - Create partner expense connection
connectionsDelete - Delete connection
connectionsGet - Get connection
connectionsList - List connections
connectionsUnlink - Unlink connection
customersCreate - Create customer
customersGet - Get customer
customersList - List customers
customersUpdate - Update customer
expensesCreate - Create expense transaction
expensesUpdate - Update expense transactions
manageDataGet - Get data status
manageDataGetPullOperation - Get pull operation
manageDataListPullOperations - List pull operations
manageDataRefreshAllDataTypes - Refresh all data
manageDataRefreshDataType - Refresh data type
mappingOptionsGetMappingOptions - Mapping options
pushOperationsGet - Get push operation
pushOperationsList - List push operations
reimbursementsCreate - Create reimbursable expense transaction
reimbursementsUpdate - Update reimbursable expense transaction
suppliersCreate - Create supplier
suppliersGet - Get supplier
suppliersList - List suppliers
suppliersUpdate - Update supplier
syncGet - Get sync status
syncGetLastSuccessfulSync - Last successful sync
syncGetLatestSync - Latest sync status
syncList - List sync statuses
transactionStatusGet - Get sync transaction
transactionStatusList - List sync transactions
transfersCreate - Create transfer transaction

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();

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

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

const sdk = new CodatSyncExpenses({ debugLogger: console });

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

FAQs

What is @codat/sync-for-expenses?

Is @codat/sync-for-expenses well maintained?

Package last updated on 26 Nov 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

@codat/sync-for-expenses

Sync for Expenses

Summary