@codat/bank-feeds

Bank Feeds API

Bank Feeds API enables your SMB users to set up bank feeds from accounts in your application to supported accounting platforms.

SDK Installation

NPM

npm add @codat/bank-feeds

Yarn

yarn add @codat/bank-feeds

SDK Example Usage

import { CodatBankFeeds } from "@codat/bank-feeds";
import { CreateBankTransactionsResponse } from "@codat/bank-feeds/dist/sdk/models/operations";
import { DataType, PushChangeType, PushOperationStatus } from "@codat/bank-feeds/dist/sdk/models/shared";

const sdk = new CodatBankFeeds({
  security: {
    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
  },
});

sdk.bankAccountTransactions.create({
  createBankTransactions: {
    accountId: "corrupti",
    transactions: [
      {
        amount: 7151.9,
        date: "2022-10-23T00:00:00.000Z",
        description: "unde",
        id: "d8d69a67-4e0f-4467-8c87-96ed151a05df",
      },
      {
        amount: 7781.57,
        date: "2022-10-23T00:00:00.000Z",
        description: "at",
        id: "df7cc78c-a1ba-4928-bc81-6742cb739205",
      },
      {
        amount: 6176.36,
        date: "2022-10-23T00:00:00.000Z",
        description: "iste",
        id: "396fea75-96eb-410f-aaa2-352c5955907a",
      },
    ],
  },
  accountId: "EILBDVJVNUAGVKRQ",
  allowSyncOnPushComplete: false,
  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
  timeoutInMinutes: 958950,
}).then((res: CreateBankTransactionsResponse) => {
  if (res.statusCode == 200) {
    // handle response
  }
});

Available Resources and Operations

bankAccountTransactions

• create - Create bank transactions
• get - List push options for bank account bank transactions
• list - List bank transactions for bank account

bankFeedAccounts

• create - Create bank feed bank accounts
• get - List bank feed bank accounts
• update - Update bank feed bank account

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
• proxy - Proxy
• unlinkConnection - Unlink connection

SDK Generated by Speakeasy