bigcapital/packages/server/src/interfaces/Plaid.ts

import { Knex } from "knex";

export interface IPlaidItemCreatedEventPayload {
  tenantId: number;
  plaidAccessToken: string;
  plaidItemId: string;
  plaidInstitutionId: string;
}

export interface PlaidItemDTO {
  publicToken: string;
  institutionId: string;
}

export interface PlaidAccount {
  account_id: string;
  balances: {
    available: number;
    current: number;
    iso_currency_code: string;
    limit: null;
    unofficial_currency_code: null;
  };
  mask: string;
  name: string;
  official_name: string;
  persistent_account_id: string;
  subtype: string;
  type: string;
}

export interface PlaidTransaction {
  date: string;
  account_id: string;
  amount: number;
  authorized_date: string;
  name: string;
  category: string[];
  check_number: number | null;
  iso_currency_code: string;
  transaction_id: string;
  transaction_type: string;
  payment_meta: { reference_number: string | null; payee: string | null };
}

export interface PlaidFetchedTransactionsUpdates {
  added: any[];
  modified: any[];
  removed: any[];
  accessToken: string;
  cursor: string;
}

export interface SyncAccountsTransactionsTask {
  tenantId: number;
  plaidAccountId: number;
  plaidTransactions: PlaidTransaction[];
}

export interface IPlaidTransactionsSyncedEventPayload {
  tenantId: number;
  plaidAccountId: number;
  batch: string;
  trx?: Knex.Transaction
}