https://github.com/codatio/client-sdk-typescript
Typescript Client SDK for Codat APIs
https://github.com/codatio/client-sdk-typescript
accounting api banking commerce node sdk typescript
Last synced: 11 months ago
JSON representation
Typescript Client SDK for Codat APIs
- Host: GitHub
- URL: https://github.com/codatio/client-sdk-typescript
- Owner: codatio
- Created: 2023-02-20T22:23:45.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-19T11:48:32.000Z (12 months ago)
- Last Synced: 2025-04-02T20:41:40.419Z (11 months ago)
- Topics: accounting, api, banking, commerce, node, sdk, typescript
- Language: TypeScript
- Homepage: https://docs.codat.io/using-the-api/overview
- Size: 14.6 MB
- Stars: 3
- Watchers: 9
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
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](https://docs.codat.io/using-the-api/authentication).
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.
```bash
Authorization: Basic BASE_64_ENCODED(API_KEY)
```
### Getting your Authorization Header
To get your authorization header from the [Codat Portal](https://app.codat.io):
1. In the navigation bar, click [**Developers > API keys**](https://app.codat.io/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](https://github.com/codatio/client-sdk-typescript/tree/main/platform)** | Manage the building blocks of Codat, including companies, connections, and more. | [](https://www.npmjs.com/package/@codat/platform) |
| **[Bank Feeds](https://github.com/codatio/client-sdk-typescript/tree/main/bank-feeds)** | Set up bank feeds from accounts in your application to supported accounting platforms. | [](https://www.npmjs.com/package/@codat/bank-feeds) |
| **[Sync for Commerce](https://github.com/codatio/client-sdk-typescript/tree/main/sync-for-commerce)** | Push merchants' data from your ecommerce or point-of-sale (POS) platform into your merchants' accounting platform. | [](https://www.npmjs.com/package/@codat/sync-for-commerce) |
| **[Sync for Expenses](https://github.com/codatio/client-sdk-typescript/tree/main/sync-for-expenses)** | Push expenses to accounting platforms. | [](https://www.npmjs.com/package/@codat/sync-for-expenses) |
| **[Lending](https://github.com/codatio/client-sdk-typescript/tree/main/lending)** | Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. | [](https://www.npmjs.com/package/@codat/lending) |
| **[Sync for Payroll](https://github.com/codatio/client-sdk-typescript/tree/main/sync-for-payroll)** | Push payroll to accounting platforms. | [](https://www.npmjs.com/package/@codat/sync-for-payroll) |
| **[Sync for Payables](https://github.com/codatio/client-sdk-typescript/tree/main/sync-for-payables)** | Streamline your customers' accounts payable workflow. | [](https://www.npmjs.com/package/@codat/sync-for-payables) |
### Alternative products and versions
| Library | Description | npm |
| :- |:- |:- |
| **[Common](https://github.com/codatio/client-sdk-typescript/tree/main/previous-versions/common)** | Manage the building blocks of Codat, including companies, connections, and more. | [](https://www.npmjs.com/package/@codat/common) |
| **[Accounting](https://github.com/codatio/client-sdk-typescript/tree/main/previous-versions/accounting)** | Access standardized accounting data from our accounting integrations. | [](https://www.npmjs.com/package/@codat/accounting) |
| **[Banking](https://github.com/codatio/client-sdk-typescript/tree/main/previous-versions/banking)** | Access standardized banking data from our banking integrations. | [](https://www.npmjs.com/package/@codat/banking) |
| **[Commerce](https://github.com/codatio/client-sdk-typescript/tree/main/previous-versions/commerce)** | Access standardized commerce data from our commerce integrations. | [](https://www.npmjs.com/package/@codat/commerce) |
| **[Assess](https://github.com/codatio/client-sdk-typescript/tree/main/previous-versions/assess)** | Make credit decisions backed by enhanced financials, metrics, reports, and data integrity features. | [](https://www.npmjs.com/package/@codat/assess) |
| **[Sync for Commerce version 1](https://github.com/codatio/client-sdk-typescript/tree/main/previous-versions/sync-for-commerce-version-1)** | Push merchants' data from your ecommerce or point-of-sale (POS) platform into your merchants' accounting platform. | [](https://www.npmjs.com/package/@codat/sync-for-commerce-version-1) |
| **[Sync for Expenses version 1](https://github.com/codatio/client-sdk-typescript/tree/main/previous-versions/sync-for-expenses-version-1)** | Push expenses to accounting platforms. | [](https://www.npmjs.com/package/@codat/sync-for-expenses-version-1) |
| **[Sync for Payables version 1](https://github.com/codatio/client-sdk-typescript/tree/main/previous-versions/sync-for-payables-version-1)** | Push expenses to accounting platforms. | [](https://www.npmjs.com/package/@codat/sync-for-payables-version-1) |
| **[Files](https://github.com/codatio/client-sdk-typescript/tree/main/previous-versions/files)** | Use Codat's Files API to upload your SMB customers' files. | [](https://www.npmjs.com/package/@codat/files) |
## 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](mailto:support@codat.io).
We're here to help ensure a smooth experience for you.