TreasuryPrime.Business (TreasuryPrime v1.0.0)

Copy Markdown View Source

The canonical, current record for a business associated with one or more accounts — created automatically when its TreasuryPrime.BusinessApplication is approved.

Unlike TreasuryPrime.BusinessApplication (a point-in-time snapshot taken at application time), Business reflects current information and can be updated as it changes.

There is no list/2 for this resource — fetch a business by an id found in a TreasuryPrime.Account's business_ids.

Summary

Functions

Fetches a single business by id.

Updates a business's current information.

Types

t()

@type t() :: %TreasuryPrime.Business{
  account_ids: [String.t()] | nil,
  bank_id: String.t() | nil,
  bankdata: map() | nil,
  created_at: String.t() | nil,
  dba: String.t() | nil,
  description: String.t() | nil,
  established_on: String.t() | nil,
  id: String.t() | nil,
  incorporation_state: String.t() | nil,
  legal_structure: String.t() | nil,
  mailing_address: map() | nil,
  naics: String.t() | nil,
  naics_description: String.t() | nil,
  name: String.t() | nil,
  phone_number: String.t() | nil,
  physical_address: map() | nil,
  updated_at: String.t() | nil,
  userdata: map() | nil
}

Functions

get(client, id)

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

Fetches a single business by id.

get!(client, id)

@spec get!(TreasuryPrime.Client.t(), String.t()) :: t()

update(client, id, params)

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

Updates a business's current information.

update!(client, id, params)

@spec update!(TreasuryPrime.Client.t(), String.t(), map()) :: t()