Skip to content

codatio/client-sdk-typescript

Repository files navigation

Codat TypeScript (Node)

The API for lending and embedded accounting automation

Codat makes it quicker and easier to build fintech products, like corporate cards, business dashboards, or SMB lending applications, that are integrated with the other systems small businesses use.

Beta Release

Exciting news! Our first TypeScript (Node) library beta release is here, simplifying your development workflow with an effortless build process.

Authentication

Codat uses API keys to control access to the API. Learn more about authentication and managing API keys here.

You must keep the API key secret, so make sure it isn't available in publicly accessible areas, such as GitHub and client-side code. Codat recommends the API key is only inserted at release time, and the number of people at your organization with access to your API key is minimised.

Codat expects the API key to be included in all API requests to the server, Base64 encoded within an 'Authorization' header.

Authorization: Basic BASE_64_ENCODED(API_KEY)

Getting your Authorization Header

To get your authorization header from the Codat Portal:

  1. In the navigation bar, click Developers > API keys.
  2. In the API Keys section, copy your authorization header rather than the API key itself.

Client Libraries

Library Description npm
Platform Manage the building blocks of Codat, including companies, connections, and more. NPM version
Bank Feeds Set up bank feeds from accounts in your application to supported accounting platforms. NPM version
Sync for Commerce Push merchants' data from your ecommerce or point-of-sale (POS) platform into your merchants' accounting platform. NPM version
Sync for Expenses Push expenses to accounting platforms. NPM version
Lending Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. NPM version
Sync for Payroll Push payroll to accounting platforms. NPM version
Sync for Payables Streamline your customers' accounts payable workflow. NPM version

Alternative products and versions

Library Description npm
Common Manage the building blocks of Codat, including companies, connections, and more. NPM version
Accounting Access standardized accounting data from our accounting integrations. NPM version
Banking Access standardized banking data from our banking integrations. NPM version
Commerce Access standardized commerce data from our commerce integrations. NPM version
Assess Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. NPM version
Sync for Commerce version 1 Push merchants' data from your ecommerce or point-of-sale (POS) platform into your merchants' accounting platform. NPM version
Sync for Expenses version 1 Push expenses to accounting platforms. NPM version
Sync for Payables version 1 Push expenses to accounting platforms. NPM version
Files Use Codat's Files API to upload your SMB customers' files. NPM version

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.