Codat.BankFeeds.SourceAccounts (codat v1.0.0)

Manage source bank accounts for bank feeds.

Source accounts are the bank/credit card accounts in your application that you want to feed into a customer's accounting software.

Lifecycle

Create a bank feed connection via Codat.Platform.Connections.create/3 with the appropriate Bank Feeds integration key
Create source accounts here
Ask the customer to map source accounts to their chart of accounts via Codat.BankFeeds.AccountMapping
Push transactions via Codat.BankFeeds.Transactions

Example

{:ok, account} = Codat.BankFeeds.SourceAccounts.create(client, company_id, conn_id, %{
  accountName: "Business Checking",
  accountNumber: "12345678",
  accountType: "Checking",
  currency: "USD",
  balance: 10_000.00
})

Summary

Functions

create(client_or_company_id, company_or_conn_id, conn_or_body, body_or_opts \\ %{})

Creates a new bankFeedAccounts (async). Returns a push operation.

delete(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

Deletes a bankFeedAccounts by ID (async).

fetch_all(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

Fetches all bankFeedAccounts across all pages concurrently.

get(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

Fetches a single bankFeedAccounts by ID.

get_create_model(client_or_company_id, company_or_conn_id, opts \\ [])

Returns the push model for creating bankFeedAccounts.

get_update_model(client_or_company_id, company_or_conn_id, conn_or_resource_id, resource_id_or_opts \\ [])

Returns the push model for updating a bankFeedAccounts record.

list(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

Returns a paginated list of bankFeedAccounts.

stream(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

Returns a lazy Stream of all results.

update(client_or_company_id, company_or_conn_id, conn_or_resource_id, resource_or_body, body_or_opts \\ %{})

Updates an existing bankFeedAccounts (async).

update_batch(client_or_company_id, company_or_conn_id, conn_or_accounts, accounts_or_opts \\ [])

Updates multiple source accounts in a single request.

Functions

create(client_or_company_id, company_or_conn_id, conn_or_body, body_or_opts \\ %{})

@spec create(
  Codat.Client.t() | String.t(),
  String.t(),
  String.t() | map(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Creates a new bankFeedAccounts (async). Returns a push operation.

delete(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

@spec delete(Codat.Client.t() | String.t(), String.t(), String.t() | keyword()) ::
  {:ok, nil} | {:error, Codat.Error.t()}

Deletes a bankFeedAccounts by ID (async).

fetch_all(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

@spec fetch_all(Codat.Client.t() | String.t(), String.t() | keyword(), keyword()) ::
  {:ok, [map()]} | {:error, Codat.Error.t()}

Fetches all bankFeedAccounts across all pages concurrently.

get(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

@spec get(Codat.Client.t() | String.t(), String.t(), String.t() | keyword()) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Fetches a single bankFeedAccounts by ID.

get_create_model(client_or_company_id, company_or_conn_id, opts \\ [])

@spec get_create_model(Codat.Client.t() | String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Returns the push model for creating bankFeedAccounts.

get_update_model(client_or_company_id, company_or_conn_id, conn_or_resource_id, resource_id_or_opts \\ [])

@spec get_update_model(
  Codat.Client.t() | String.t(),
  String.t(),
  String.t() | keyword(),
  keyword()
) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Returns the push model for updating a bankFeedAccounts record.

list(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

@spec list(Codat.Client.t() | String.t(), String.t() | keyword(), keyword()) ::
  {:ok, Codat.Pagination.t()} | {:error, Codat.Error.t()}

Returns a paginated list of bankFeedAccounts.

stream(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

@spec stream(Codat.Client.t() | String.t(), String.t() | keyword(), keyword()) ::
  Enumerable.t()

Returns a lazy Stream of all results.

update(client_or_company_id, company_or_conn_id, conn_or_resource_id, resource_or_body, body_or_opts \\ %{})

@spec update(
  Codat.Client.t() | String.t(),
  String.t(),
  String.t(),
  String.t() | map(),
  map() | keyword()
) :: {:ok, map()} | {:error, Codat.Error.t()}

Updates an existing bankFeedAccounts (async).

update_batch(client_or_company_id, company_or_conn_id, conn_or_accounts, accounts_or_opts \\ [])

@spec update_batch(
  Codat.Client.t() | String.t(),
  String.t(),
  String.t() | list(),
  list() | keyword()
) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Updates multiple source accounts in a single request.

Example

{:ok, accounts} = Codat.BankFeeds.SourceAccounts.update_batch(
  client, company_id, conn_id,
  [%{id: "acc-1", balance: 12_500.00}, %{id: "acc-2", balance: 500.00}]
)