NAV Navbar

Introduction

This is the Alpha version of the API, extra features such as pagination, performance endpoints and reporting endpoints will be available in future releases of the API.

This describes the resources that make up the official BridgeFT REST API v2.

This API reference provides information on available endpoints and how to interact with it. To read more about Bridge Financial Technology, please visit the Bridge Website .

To read more about the various Endpoints that BridgeFT offers, please refer to the API Endpoints section for a list of Endpoints. In general, every endpoint will start with a description of what the endpoint represents and a table featuring the fields associated with that resource. Any relationships between resources are shown in this table, which could be one-to-one, many-to-many, many-to-one or just a foreign key relationship.

You may use the Search bar on the left-hand navigation column to search for a specific Endpoint. Some of the resources have special relationships which is detailed in the Terminology section below.


Terminology

Accounts and Households

Accounts and Households are two separate resources that may be used to reference another resource associated with that Account or Household. For example, a Position resource will either have an Account ID or a Household ID assigned to that object. There is a one-to-many relationship between a Household and its Accounts where a Household can contain multiple Accounts, but an Account is only associated to a single Household. The main reasoning behind this is to make data aggregation and calculations easier by allowing calculations on an Account basis or a Household basis.

PDF Reporting

We currently do not support any Reporting or Performance endpoints. However the PDF Report resource may be used to custom-create PDF Reports based on a clients' needs. We allow for single PDF Report object creation using the HTTP POST request method. Further details are given under the Pdf Reports section.

Getting Started

Bridge Financial Technology wants to make available all the financial data that our Atlas product currently uses and much more on top of that.

By default, all requests to https://app.bridgeft.com/api/v2/ receive the v2 version of the REST API.

Making Requests

As per RESTful design patterns, BridgeFT API v2 implements the following HTTP verbs:

When making requests, arguments can be passed as params, form data or JSON with the correct Content-Type header. Most resources are bound to a specific account belonging to the authenticated user. The authenticated user is controlled by the requesting user profile's firm id.

Possible Error Codes

401 Unauthorized - This will return if any request is made with the wrong permissions.

404 Not Found - This will return if any request is made to a resource that doesn't exist.

500 Internal Server Error - This will return if the API is down for maintenance or to catch most other errors.

Authentication

There are two ways to authenticate through BridgeFT API v2. Requests that require authentication will return either 404 Not Found or 401 Unauthorized, in some cases. We use OAuth2 to authenticate our API users.

Basic Authentiation

curl -u "username" https://app.bridgeft.com/api/v2/

You will be prompted for your password upon making the above request.

OAuth2 token (sent in a header)

curl -H "Authorization: Bearer OAUTH-TOKEN" https://app.bridgeft.com/api/v2/

Replace the OAUTH-TOKEN placeholder with your assigned OAuth2 token. If you don't have one, get one below.

Create an OAuth2 token to use when making requests

curl -X POST -u "username" https://app.bridgeft.com/api/v2/apiauth/access-tokens

You will be prompted for your password upon making the above request. The POST will return a JSON package with an OAuth2 token in the token field.

We call this token an Access Token and it is represented in the form of a JSON Web Token (JWT) as per the OAuth2 standard.

Access Tokens

An Access Token holds the OAuth2 signed JWT within the token field. A User will include the token field of the Access Token to validate themselves when making requests to the BridgeFT API. Access Tokens can be only created or retrieved.

access token

Attributes
id Integer The unique resource id for this Access Token.
token String The JSON Web Token string used to authenticate a User.
created_dt_utc DateTime The Date and Time that this token was created.
user_id Integer The id of the associated User for this Access Token.
expiration_dt_utc DateTime The Date and Time that this token expires.
duration Integer The expiration time of this Access Token. Defaults to 7 days.
token_type String The type of authentication used in this Access Token i.e. Bearer Auth.

List all access tokens

GET https://app.bridgeft.com/api/v2/apiauth/access-tokens

Returns a list of access-tokens

Arguments: None

Status: 200 OK

[
  {
    "created_dt_utc": "2018-10-04T14:26:04.308702",
    "duration": 604800,
    "expiration_dt_utc": "2018-10-11T14:26:04.308702",
    "id": 1,
    "token": "GB39QHGL0732389014876GciOiJIUzI1NiJ9.eyJpc3MiOiJodHGB39QHGL0732389014876di5hdXRoMC5jb20vIiwic3ViIjoiYXV0aGB39QHGL0732389014876R0cHM6Ly9icmlkZ2VmdC1kZXYuY29tL2FwaS92Mi8iLCJpYXQiOjE1MzGB39QHGL0732389014876zOTc5MzA0OSwiYXpwIjoidW95WjN0Y0lXNGo5VFY0QWNHWmN0NWZwOTdtbGB39QHGL0732389014876Nzd29yZCJ9.54nvBMAlMUkfkkU-6nI4UFhoSHCE4rYry31E63vBB1w",
    "token_type": "Bearer",
    "user_id": 3
  }
]

Retrieve an access token

GET https://app.bridgeft.com/api/v2/apiauth/access-tokens/{id}

Returns an access token based on a single ID

Arguments
id Required. The unique resource id for the Access Token.

Status: 200 OK

{
  "created_dt_utc": "2018-10-04T14:26:04.308702",
  "duration": 604800,
  "expiration_dt_utc": "2018-10-11T14:26:04.308702",
  "id": 1,
  "token": "GB39QHGL0732389014876GciOiJIUzI1NiJ9.eyJpc3MiOiJodHRGB39QHGL0732389014876di5hdXRoMC5jb20vIiwic3ViIjoiYXV0aGB39QHGL0732389014876R0cHM6Ly9icmlkZ2VmdC1kZXYuY29tL2FwaS92Mi8iLCJpYXQiOjE1MzGB39QHGL0732389014876zOTc5MzA0OSwiYXpwIjoidW95WjN0Y0lXNGo5VFY0QWNHWmN0NWZwOTdtbGB39QHGL0732389014876Nzd29yZCJ9.54nvBMAlMUkfkkU-6nI4UFhoSHCE4rYry31E63vBB1w",
  "token_type": "Bearer",
  "user_id": 3
}

Create an access token

POST https://app.bridgeft.com/api/v2/apiauth/access-tokens

Returns the access token that was created.

The username and password (Basic Auth) below will be sent to Auth0 for verification. After being verified Auth0 will generate a JWT Access Token and return it (Bearer Token Auth).

Arguments
username Required. The unique Username for your User.
password Required. The secret Password for your User.

Status: 201 Created

{
  "created_dt_utc": "2018-10-04T14:26:04.308702",
  "duration": 604800,
  "expiration_dt_utc": "2018-10-11T14:26:04.308702",
  "id": 1,
  "token": "GB39QHGL0732389014876GciOiJIUzI1NiJ9.eyJpc3MiOiJodHRGB39QHGL0732389014876di5hdXRoMC5jb20vIiwic3ViIjoiYXV0aGB39QHGL0732389014876R0cHM6Ly9icmlkZ2VmdC1kZXYuY29tL2FwaS92Mi8iLCJpYXQiOjE1MzGB39QHGL0732389014876zOTc5MzA0OSwiYXpwIjoidW95WjN0Y0lXNGo5VFY0QWNHWmN0NWZwOTdtbGB39QHGL0732389014876Nzd29yZCJ9.54nvBMAlMUkfkkU-6nI4UFhoSHCE4rYry31E63vBB1w",
  "token_type": "Bearer",
  "user_id": 3
}

API Endpoints:

Positions

A Position resource is a representation of a portfolios' assets in any security. The position resources are linked by a foreign key to a certain Account/Household and also to the security that it represents. The position resource allows a user to request portfolio metrics based on the current price of a security and how that is reflected in the position.

position

Attributes
id Integer The unique resource id for the Position.
account_id Integer The id of the Account associated with this Position.
household_id Integer The id of the Household associated with this Postion.
security_id Integer The id of the Security associated with this Position.
original_face Decimal The original face of this Position.
purchase_date Date Date of purchase for this Position.
settle_date Date Date the buying/selling of this Position has settled.
quantity Decimal The amount of shares in this Position.
market_value Decimal The current market value of this Positon.
unamortized_cost Decimal The unamortized cost of this Position.
u_commission Decimal The unamortized commission of this Position.
u_market_price Decimal The unamortized market price of this Position.
u_current_yield Decimal The unamortized current yield of this Position.
u_unsupervised_flag String The unamortized unsupervised flag for this Position.
u_tax_lot_accrued_income Decimal The unamortized tax lot accrued income from this Position.
symbol String The symbol of this Position.
cusip String The unique cusip value of this Position.
as_of_date Date The current date for this Positon.

List all positions

GET https://app.bridgeft.com/api/v2/data/custodian/positions

Returns a list of positions.

Arguments: None

Status: 200 OK

[
  {
    "original_face": 0.00, 
    "unamortized_cost": 100.00, 
    "u_unsupervised_flag": "", 
    "u_market_price": 10.00, 
    "u_current_yield": 0.00, 
    "security_id": 2, 
    "settle_date": "2018-09-05", 
    "u_commission": 0.00, 
    "quantity": 10.00, 
    "household_id": null, 
    "purchase_date": "2018-09-05", 
    "market_value": 100.00,
    "symbol": "", 
    "cusip": "", 
    "as_of_date": "2018-09-05", 
    "id": 2, 
    "u_tax_lot_accrued_income": 0.00, 
    "account_id": 2
  }
]

Retrieve a position

GET https://app.bridgeft.com/api/v2/data/custodian/positions/{id}

Returns a single position based on an ID.

Arguments
id Required. The unique resource id for the Position.

Status: 200 OK

{
  "original_face": 0.00, 
  "unamortized_cost": 100.00, 
  "u_unsupervised_flag": "", 
  "u_market_price": 10.00, 
  "u_current_yield": 0.00, 
  "security_id": 2, 
  "settle_date": "2018-09-05", 
  "u_commission": 0.00, 
  "quantity": 10.00, 
  "household_id": null, 
  "purchase_date": "2018-09-05", 
  "market_value": 100.00,
  "symbol": "", 
  "cusip": "", 
  "as_of_date": "2018-09-05", 
  "id": 2, 
  "u_tax_lot_accrued_income": 0.00, 
  "account_id": 2
}

Balances

A Balance resource represents an Account/Households' total balances based an Accounts' associated holdings. Calculating market value and account income is also a task for the balance resources. When changes to securities prices or position amounts change, Balances will be updated and if necessary, built from the current day's position data.

balance

Attributes
id Integer The unique resource id for the Balance.
as_of_date Date The current date for this Balance.
frequency String The time series for the extract information being fed into the Balance.
account_id Integer The id of the Account associated with this Balance.
household_id Integer The id of the Household associated with this Balance.
cash_value Decimal The cash value of this Balance.
equity_value Decimal The equity value of this Balance.
fixed_income_value Decimal The fixed income value of this Balance.
other_value Decimal The other value of this Balance.
alt_value Decimal The alternative value for this Balance.
unclassified_value Decimal The unclassified value for this Balance.
etf_value Decimal The etf value of this Balance.
mf_value Decimal The mf value of this Balance.
total_market_value Decimal The Sum of positions without any accrued or paid income.
raw_total_contribution Decimal The sum of net RCV and DLV values.
unexplained_total_contribution Decimal Balance delta - raw total contribution - paid income.
unexplained_contribution_percentage Decimal The unexplained_total_contribution as a percentage of total value (when > 0) on the NATURAL SCALE.
accrued_income Decimal The promised but unpaid income of for this Balance.
paid_income Decimal The income that has been distributed (offsets accrued income).
total_income Decimal The sum of the accrued income and paid income.
total_fees Decimal Sum of all fees paid out - this is always on a cash basis.
total_value Decimal The sum of total market value and accrued income.
source String The source of Balance information (either Extracts or Historical).

List all balances

GET https://app.bridgeft.com/api/v2/data/custodian/balances

Returns a list of balances.

Arguments: None

Status: 200 OK

[
  {
    "unexplained_contribution_percentage": 0.00, 
    "other_value": null, 
    "alt_value": null, 
    "fixed_income_value": null, 
    "paid_income": null, 
    "cash_value": null, 
    "raw_total_contribution": 0.00, 
    "total_fees": null, 
    "etf_value": null, 
    "source": "E", 
    "account_id": 1, 
    "household_id": null, 
    "total_income": null, 
    "equity_value": null, 
    "unexplained_total_contribution": 0.00, 
    "unclassified_value": null, 
    "total_market_value": null, 
    "frequency": "D", 
    "total_value": 0.00, 
    "as_of_date": "2018-09-05", 
    "mf_value": null, 
    "accrued_income": null, 
    "id": 1
  }
]

Retrieve a balance

GET https://app.bridgeft.com/api/v2/data/custodian/balances/{id}

Returns a single balance based on an ID.

Arguments
id Required. The unique resource id for the Balance.

Status: 200 OK

{
  "unexplained_contribution_percentage": 0.00, 
  "other_value": null, 
  "alt_value": null, 
  "fixed_income_value": null, 
  "paid_income": null, 
  "cash_value": null, 
  "raw_total_contribution": 0.00, 
  "total_fees": null, 
  "etf_value": null, 
  "source": "E", 
  "account_id": 1, 
  "household_id": null, 
  "total_income": null, 
  "equity_value": null, 
  "unexplained_total_contribution": 0.00, 
  "unclassified_value": null, 
  "total_market_value": null, 
  "frequency": "D", 
  "total_value": 0.00, 
  "as_of_date": "2018-09-05", 
  "mf_value": null, 
  "accrued_income": null, 
  "id": 1
}

Securities

A Security resource is a representation of a financial security that is used to keep track and calculate performance metrics. Every security has unique symbols and cusip to help identify them.

security

Attributes
id Integer The unique resource id for the Security.
symbol String The symbol used to represent the Security.
cusip String The cusip identifier unique to the Security.
description String The description of the Security.
master_asset_class String The master asset class of the Security (i.e. Equity).
broad_code Integer The broad asset type classification code of the Security.
issue_type_code Integer The major asset classification issue type code.
sic_code Integer The major asset classification sic code.
sacus Integer The sacus of the Security.
identifier String A unique asset identifier which could be the cusip or another string.
is_tracked Boolean Whether the security is currently tracked from ANY position.

List all securities

GET https://app.bridgeft.com/api/v2/data/custodian/securities

Returns a list of securities.

Arguments: None

Status: 200 OK

[
  {
    "broad_code": 1, 
    "sacus": 123456, 
    "identifier": "ElHQFHvozOCr", 
    "issue_type_code": 28, 
    "description": "Security Description", 
    "cusip": "eWeGXrUOliVE", 
    "symbol": "ZBpXRTeyzLmo", 
    "id": 1, 
    "sic_code": 4000, 
    "is_tracked": true, 
    "master_asset_class": "EQ"
  }
]

Retrieve a security

GET https://app.bridgeft.com/api/v2/data/custodian/securities/{id}

Returns a single security based on an ID.

Arguments
id Required. The unique resource id for the Security.

Status: 200 OK

{
  "broad_code": 1, 
  "sacus": 123456, 
  "identifier": "ElHQFHvozOCr", 
  "issue_type_code": 28, 
  "description": "Security Description", 
  "cusip": "eWeGXrUOliVE", 
  "symbol": "ZBpXRTeyzLmo", 
  "id": 1, 
  "sic_code": 4000, 
  "is_tracked": true, 
  "master_asset_class": "EQ"
}

Transactions

A transaction resource represents all transactions made with financial institutions and on bridge are aggregated over lots. A lot is defined by: - account/household short name - trade date - transaction code - security identifier A transaction resource is associated with the Account/Household that issued the transaction, auto populated transaction id, and various other metrics to determine the type and purpose for the transaction.

transaction

Attributes
id Integer The unique resource id for the Transaction.
transaction_id String Identifies a transaction across lots -- a transaction id is the same across lots of the transaction.
account_id Integer The id of the Account associated with this Transaction.
household_id Integer The id of the Household associated with this Transaction.
security_id Integer The id of the Security associated with this Transaction.
transaction_code String The transaction code of this Transaction.
cancel_flag String The cancel flag of this Transaction.
asset_type_broad String The broad asset type of this Transaction.
asset_type_major String The major asset type of this Transaction.
asset_type_minor String The minor asset type of this Transaction.
trade_date Date The trade date for this Transaction.
settle_date Date The date that this Transaction was settled.
transfer_date Date Listed as RECV or DLV date for this Transaction.
original_purchase_date Date The original purchase date of this Transaction.
quantity Decimal The quanity of shares for this Transaction.
amount Decimal The amount or unit price * quantity of shares purchased for this Transaction.
unit_price Decimal The unit price for this Transaction.
commission Decimal The commission from this Transaction.
broker_code String The broker code used for this Transaction.
orignal_face Decimal The orignal face of this Transaction.
transfer_proceeds Decimal The transfer proceeds for this Transaction.
original_cost Decimal The orignal cost of this Transaction.
security_description String The security description for the security associated with this Transaction.
cusip String The cusip of the security associated with this Transaction.
unsupervised_flag String The unsupervised flag of this Transaction.
cash_or_security_flag String The cash or security flag associated with this Transaction.
special_description_flag String The special description flag associated with this Transaction.
st_or_lt_flag String The st or lt flag for this Transaction.
transaction_date Date The transaction date that this Transaction went into action.

List all transactions

GET https://app.bridgeft.com/api/v2/data/custodian/transactions

Returns a list of transactions.

Arguments: None

Status: 200 OK

[
  {
    "cusip": "", 
    "quantity": 0.00, 
    "special_description_flag": "", 
    "transaction_id": "KyTGLDUZmXpw", 
    "transaction_code": "", 
    "asset_type_minor": "tMMCVlolDQHu", 
    "broker_code": "", 
    "original_cost": 0.00, 
    "asset_type_major": "tZjZKWWmbdmK", 
    "cash_or_security_flag": "", 
    "id": 2, 
    "original_face": 0.00, 
    "st_or_lt_flag": "", 
    "household_id": 4, 
    "transfer_date": "2018-09-05", 
    "transfer_proceeds": 0.00, 
    "original_purchase_date": "2018-09-05", 
    "unsupervised_flag": "", 
    "account_id": 2, 
    "unit_price": 50.00, 
    "asset_type_broad": "TPRVeJXxudgA", 
    "trade_date": "2018-09-05", 
    "cancel_flag": "JgPwwqOUtaLo", 
    "transaction_date": "2018-09-05", 
    "commission": 100.00, 
    "amount": 0.00, 
    "security_id": 2, 
    "security_description": "", 
    "settle_date": "2018-09-05"
  }
]

Retrieve a transaction

GET https://app.bridgeft.com/api/v2/data/custodian/transactions/{id}

Returns a single transaction based on an ID.

Arguments
id Required. The unique resource id for the Transaction.

Status: 200 OK

{
  "cusip": "", 
  "quantity": 0.00, 
  "special_description_flag": "", 
  "transaction_id": "KyTGLDUZmXpw", 
  "transaction_code": "", 
  "asset_type_minor": "tMMCVlolDQHu", 
  "broker_code": "", 
  "original_cost": 0.00, 
  "asset_type_major": "tZjZKWWmbdmK", 
  "cash_or_security_flag": "", 
  "id": 2, 
  "original_face": 0.00, 
  "st_or_lt_flag": "", 
  "household_id": 4, 
  "transfer_date": "2018-09-05", 
  "transfer_proceeds": 0.00, 
  "original_purchase_date": "2018-09-05", 
  "unsupervised_flag": "", 
  "account_id": 2, 
  "unit_price": 50.00, 
  "asset_type_broad": "TPRVeJXxudgA", 
  "trade_date": "2018-09-05", 
  "cancel_flag": "JgPwwqOUtaLo", 
  "transaction_date": "2018-09-05", 
  "commission": 100.00, 
  "amount": 0.00, 
  "security_id": 2, 
  "security_description": "", 
  "settle_date": "2018-09-05"
}

GainLosses

A realized gain or loss after an asset has been sold (in the case of a long position) or bought back (in the case of a short position).

gainloss

Attributes
id Integer The unique resource id for this Gain Loss object.
gainloss_id String An identifier across gains/losses that is the same across all lots.
security_id Integer Security is null if the gain/loss can't be mapped to a security in our system.
account_id Integer Non-null if it's an account-level gain-loss and null if it's a household gain/loss.
household_id Integer Non-null if it's a household-level gain/loss and null if it's an account-level gain/loss.
purchase_date Date The date the liquidated position was acquired (i.e. the underlying asset was purchase).
sale_date Date Date the asset was sold (long) or bought back (for a short).
quantity Decimal The quantity of shares being used with this gain/loss.
cost Decimal The cost associated with this gain/loss.
proceeds Decimal The amount of margin gained from this gain/loss transaction.
st_lt_flag String Short term and long term flag which classify a gain loss as being long term or short term based on length of holding.
special_transaction_flag String A special transaction flag used to distinguish gain loss values.
unsupervised_flag String A flag indicating whether the gain loss is ring fenced by account or firm.
security_description String The security description of the gain loss and is used if the security itself is not available.
symbol String The security symbol as it was when the gain/loss was recorded.
cusip String The security CUSIP as it was when the gain/loss was recorded.

List all gainlosses

GET https://app.bridgeft.com/api/v2/data/custodian/gainloss

Returns a list of gainlosses.

Arguments: None

Status: 200 OK

[
  {
    "id": 16048239,
    "household_id": 2969,
    "account_id": null,
    "quantity": 3650,
    "cost": 0,
    "symbol": "",
    "security_description": "",
    "sale_date": "2017-06-01",
    "st_lt_flag": "LT",
    "gainloss_id": "",
    "unsupervised_flag": "",
    "proceeds": 59329.46,
    "purchase_date": "1960-01-01",
    "security_id": 59,
    "special_transaction_flag": "",
    "cusip": ""
  }
]

Retrieve a gainloss

GET https://app.bridgeft.com/api/v2/data/custodian/gainloss/{id}

Returns a single gainloss based on an ID.

Arguments
id Required. The unique resource id for the GainLoss.

Status: 200 OK

  {
    "id": 16048239,
    "household_id": 2969,
    "account_id": null,
    "quantity": 3650,
    "cost": 0,
    "symbol": "",
    "security_description": "",
    "sale_date": "2017-06-01",
    "st_lt_flag": "LT",
    "gainloss_id": "",
    "unsupervised_flag": "",
    "proceeds": 59329.46,
    "purchase_date": "1960-01-01",
    "security_id": 59,
    "special_transaction_flag": "",
    "cusip": ""
  }

Firms

A firm is a collection of firm-wide settings for the firm and their associated relationship code.

firm

Attributes
id Integer The unique resource id for this Firm object.
name String Full name of the firm.
short_name String A three-letter lower cased code for the firm for easy reference.
relationship_code String The RELCODE that is internally generated in order to store firms uniquely.
logo_url String Public URL of the firm's logo.
disclosures String User entered disclosures to appear at the bottom of a report which is safe to render because it contains HTML.
reporting_frequency String The natural frequency with which a firm generates and sends their reports.
report_on_heldaway_acounts Boolean Option to include held-away assets in PDF reports.
show_bridge_logo Boolean If true and no logo_url provided then the dashboard will show bridge's logo.
show_firm_logo Boolean If true and a logo is provided then the firm's logo will be shown.
is_active Boolean Active firms are current subscribers of Atlas.
is_billing_active Boolean If true the firm uses Atlas to run their billing.
cp_enabled Boolean Whether the client portal is enabled for the firm's customers.
cp_web_reports_enabled Boolean Whether end clients can access their own web reports from the portal.
cp_printable_reports_enabled Boolean If true clients can download printable reports.
cp_invoices_enabled Boolean If true clients can view their invoices.
cp_shared_files_enabled Boolean If true clients can access shared files.
cp_heldaways_enabled Boolean If true clients can access and add heldaway assets.
parent_firm_id Integer When non-null this is a sub-firm and this FK points to its parent firm.
permissions [String] An array of permissions accessible to the firm.

List all firms

GET https://app.bridgeft.com/api/v2/firms/firms

Returns a list of firms

Arguments: None

200 Response

[
  {
    "id": 39,
    "cp_heldaways_enabled": true,
    "cp_shared_files_enabled": true,
    "parent_firm_id": null,
    "show_firm_logo": true,
    "report_on_heldaway_accounts": true,
    "relationship_code": "DM0717ILPL",
    "cp_enabled": true,
    "cp_web_reports_enabled": true,
    "permissions": [
        "*",
        "account_management.account.read",
        "account_management.account.update",
    ],
    "short_name": "dem",
    "disclosures": "",
    "logo_url": "https://s3.amazonaws.com/bridgeft-firm-logos/dem/logo.png",
    "name": "Demo Firm",
    "show_bridge_logo": true,
    "reporting_frequency": "q",
    "cp_printable_reports_enabled": true,
    "cp_invoices_enabled": true
  }
]

Retrieve a firm

GET https://app.bridgeft.com/api/v2/firms/firms/{id}

Returns a firm based on a single ID

Arguments
id Required. The unique resource id for the Firm.

200 Response

  {
    "id": 39,
    "cp_heldaways_enabled": true,
    "cp_shared_files_enabled": true,
    "parent_firm_id": null,
    "show_firm_logo": true,
    "report_on_heldaway_accounts": true,
    "relationship_code": "DM0717ILPL",
    "cp_enabled": true,
    "cp_web_reports_enabled": true,
    "permissions": [
        "*",
        "account_management.account.read",
        "account_management.account.update",
    ],
    "short_name": "dem",
    "disclosures": "",
    "logo_url": "https://s3.amazonaws.com/bridgeft-firm-logos/dem/logo.png",
    "name": "Demo Firm",
    "show_bridge_logo": true,
    "reporting_frequency": "q",
    "cp_printable_reports_enabled": true,
    "cp_invoices_enabled": true
  }

Update a firm

PUT https://app.bridgeft.com/api/v2/firms/firms/{id}

Returns the firm that was updated.

Arguments
id The unique resource id for this Firm object.
name Required. Full name of the firm.
short_name Required. A three-letter lower cased code for the firm for easy reference.
relationship_code Required. The RELCODE that is internally generated in order to store firms uniquely.
logo_url Required. Public URL of the firm's logo.
disclosures Required. User entered disclosures to appear at the bottom of a report which is safe to render because it contains HTML.
reporting_frequency Required. The natural frequency with which a firm generates and sends their reports.
report_on_heldaway_acounts Required. Option to include held-away assets in PDF reports.
show_bridge_logo Required. If true and no logo_url provided then the dashboard will show bridge's logo.
show_firm_logo Required. If true and a logo is provided then the firm's logo will be shown.
is_active Required. Active firms are current subscribers of Atlas.
is_billing_active Required. If true the firm uses Atlas to run their billing.
cp_enabled Required. Whether the client portal is enabled for the firm's customers.
cp_web_reports_enabled Required. Whether end clients can access their own web reports from the portal.
cp_printable_reports_enabled Required. If true clients can download printable reports.
cp_invoices_enabled Required. If true clients can view their invoices.
cp_shared_files_enabled Required. If true clients can access shared files.
cp_heldaways_enabled Required. If true clients can access and add heldaway assets.
parent_firm_id Required. When non-null this is a sub-firm and this FK points to its parent firm.
permissions Required. An array of permissions accessible to the firm.

Status: 200 OK

  {
    "id": 39,
    "cp_heldaways_enabled": true,
    "cp_shared_files_enabled": true,
    "parent_firm_id": null,
    "show_firm_logo": true,
    "report_on_heldaway_accounts": true,
    "relationship_code": "DM0717ILPL",
    "cp_enabled": true,
    "cp_web_reports_enabled": true,
    "permissions": [
        "*",
        "account_management.account.read",
        "account_management.account.update",
    ],
    "short_name": "dem",
    "disclosures": "",
    "logo_url": "https://s3.amazonaws.com/bridgeft-firm-logos/dem/logo.png",
    "name": "Demo Firm",
    "show_bridge_logo": true,
    "reporting_frequency": "q",
    "cp_printable_reports_enabled": true,
    "cp_invoices_enabled": true
  }

Bulk Update firms

PUT https://app.bridgeft.com/api/v2/firms/firms

Returns the list of firms that were updated.

Arguments
id The unique resource id for this Firm object.
name Required. Full name of the firm.
short_name Required. A three-letter lower cased code for the firm for easy reference.
relationship_code Required. The RELCODE that is internally generated in order to store firms uniquely.
logo_url Required. Public URL of the firm's logo.
disclosures Required. User entered disclosures to appear at the bottom of a report which is safe to render because it contains HTML.
reporting_frequency Required. The natural frequency with which a firm generates and sends their reports.
report_on_heldaway_acounts Required. Option to include held-away assets in PDF reports.
show_bridge_logo Required. If true and no logo_url provided then the dashboard will show bridge's logo.
show_firm_logo Required. If true and a logo is provided then the firm's logo will be shown.
is_active Required. Active firms are current subscribers of Atlas.
is_billing_active Required. If true the firm uses Atlas to run their billing.
cp_enabled Required. Whether the client portal is enabled for the firm's customers.
cp_web_reports_enabled Required. Whether end clients can access their own web reports from the portal.
cp_printable_reports_enabled Required. If true clients can download printable reports.
cp_invoices_enabled Required. If true clients can view their invoices.
cp_shared_files_enabled Required. If true clients can access shared files.
cp_heldaways_enabled Required. If true clients can access and add heldaway assets.
parent_firm_id Required. When non-null this is a sub-firm and this FK points to its parent firm.
permissions Required. An array of permissions accessible to the firm.

Status: 200 OK

[
  {
    "id": 39,
    "cp_heldaways_enabled": true,
    "cp_shared_files_enabled": true,
    "parent_firm_id": null,
    "show_firm_logo": true,
    "report_on_heldaway_accounts": true,
    "relationship_code": "DM0717ILPL",
    "cp_enabled": true,
    "cp_web_reports_enabled": true,
    "permissions": [
        "*",
        "account_management.account.read",
        "account_management.account.update",
    ],
    "short_name": "dem",
    "disclosures": "",
    "logo_url": "https://s3.amazonaws.com/bridgeft-firm-logos/dem/logo.png",
    "name": "Demo Firm",
    "show_bridge_logo": true,
    "reporting_frequency": "q",
    "cp_printable_reports_enabled": true,
    "cp_invoices_enabled": true
  }
]

Households

Each client is represented by an Account resource where a Household resource describes any client relationships between different Accounts.

household

Attributes
id Integer The unique resource id for the Household.
entity_id String The entity id for this Household.
short_name String The short name or nick name for this Household.
opening_date Date The date this Household was opened.
inception_date Date The date of inception for this Household.
close_date Date The close_date for this Household.
name String The name of this Household.
status String The status of this Household.
benchmark_ids [ Integers ] The ids of the benchmarks for this Household
managing_firm_id Integer The managing id of the firm associated with this Household.
firm_ids [ Integers ] The associated firm ids for this Household.
is_account Boolean Is this an Account object?
is_household Boolean Is this a Household object?

List all households

GET https://app.bridgeft.com/api/v2/accounts/households

Returns a list of households.

Arguments: None

200 Response

[
  {
    "entity_id": "H-UZGJVO", 
    "id": 1, 
    "benchmark_ids": [], 
    "firm_ids": [1], 
    "inception_date": "2018-01-01", 
    "close_date": null, 
    "status": "110", 
    "name": "Household: UaBRWFNhQEBa", 
    "is_account": false, 
    "is_household": true, 
    "short_name": "UZGJVO", 
    "opening_date": "2018-01-01", 
    "managing_firm_id": 1
  }
]

Retrieve a household

GET https://app.bridgeft.com/api/v2/accounts/households/{id}

Returns a single household based on an ID.

Arguments
id Required. The unique resource id for the Household.

200 Response

{
  "name": "Household: EBEUxxFcgeuK", 
  "close_date": null, 
  "short_name": "WBYRCA", 
  "is_account": false, 
  "opening_date": "2018-01-01", 
  "is_household": true, 
  "id": 4, 
  "benchmark_ids": [], 
  "status": "110", 
  "inception_date": "2018-01-01", 
  "managing_firm_id": 4, 
  "firm_ids": [4], 
  "entity_id": "H-WBYRCA"
}

Accounts

An Account resource represents a client under an Advisor. Each Account is associated with a Household to describe any client relationships.

account

Attributes
id Integer The unique resource id for the Account.
number String The account number for this Account.
master_number String The master number for this Account.
custodian String The custodian of this Account.
charge_unit_id Integer The id of the associated Charge Unit to this Account.
address_1 String The address 1st information for this Account.
address_2 String The address 2nd information for this Account.
address_3 String The address 3rd information for this Account.
city String The city address information for this Account.
state String The state address information for this Account.
zip_code String The zip code address information for this Account.
country String The country address information for this Account.
acct_type String The type of Account.
household_id Integer The id of the associated Household for this Account.
is_tax_deferred Boolean Is tax deferred for this Account.
is_taxable Boolean Is this Account taxable?
is_composite Boolean Is this Account composite?
payment_source String The payment source for this Account.
first_billable_date Date The first billable date for this Account.
billing_split_ids [ Integers ] The ids of the associated billing splits for this Account.
display_name String The display name for this Account.
display_number String The display number for this Account.
is_direct_billed Boolean Is direct billing active for this Account?
is_custodian_billed Boolean Is the custodian being billed for this Account?
is_active Boolean Is this Account active?
is_closed Boolean Is this Account closed?
custodian_name String The custodian name for this Account.
has_custodian_name Boolean Does this Account have a custodian name?
entity_id String The entity id for this Account.
short_name String The short name or nick name for this Account.
opening_date Date The date this Account was opened.
inception_date Date The date of inception for this Account.
close_date Date The close_date for this Account.
name String The name of this Account.
status String The status of this Account.
benchmark_ids [ Integers ] The ids of the benchmarks for this Account
managing_firm_id Integer The managing id of the firm associated with this Account.
firm_ids [ Integers ] The associated firm ids for this Account.
is_account Boolean Is this an Account object?
is_household Boolean Is this a Household object?

List all accounts

GET https://app.bridgeft.com/api/v2/accounts/accounts

Returns a list of accounts.

Arguments: None

Status: 200 OK

[
  {
    "name": "Account: uAQIRvhWMpeM", 
    "is_direct_billed": true, 
    "is_active": true, 
    "has_custodian_name": true, 
    "charge_unit_id": null, 
    "is_taxable": true, 
    "display_number": "XXXXX 687", 
    "address_2": "", 
    "billing_split_ids": [], 
    "number": "23543687", 
    "is_account": true, 
    "zip_code": "60605", 
    "household_id": 1, 
    "is_household": false, 
    "close_date": null, 
    "is_custodian_billed": false, 
    "address_3": "", 
    "custodian": "TDA", 
    "custodian_name": "TD Ameritrade", 
    "managing_firm_id": 1, 
    "master_number": "800983", 
    "short_name": "SN0000", 
    "state": "IL", 
    "address_1": "123 main street", 
    "country": "USA", 
    "payment_source": "D", 
    "id": 1, 
    "inception_date": "2017-01-01", 
    "display_name": "Account: uAQIRvhWMpeM IRA", 
    "acct_type": "IRA",
    "status": "22", 
    "firm_ids": [1], 
    "is_tax_deferred": false, 
    "opening_date": "2017-01-01", 
    "first_billable_date": "2018-03-01", 
    "city": "Anytown", 
    "is_composite": null, 
    "entity_id": "A-SN0000", 
    "is_closed": false, 
    "benchmark_ids": []
  }
]

Retrieve an account

GET https://app.bridgeft.com/api/v2/accounts/accounts/{id}

Returns a single account based on an ID.

Arguments
id Required. The unique resource id for the Account.

Status: 200 OK

{
  "entity_id": "A-SN0003", 
  "address_2": "", 
  "name": "Account: XqdVpqLTKXpg", 
  "is_direct_billed": true, 
  "is_tax_deferred": false, 
  "payment_source": "D", 
  "is_composite": null, 
  "custodian": "TDA", 
  "number": "45497688", 
  "acct_type": "IRA", 
  "first_billable_date": "2018-03-01", 
  "is_custodian_billed": false, 
  "household_id": 4, 
  "is_taxable": true, 
  "status": "22", 
  "managing_firm_id": 7, 
  "close_date": null, 
  "city": "Anytown", 
  "is_household": false, 
  "firm_ids": [7], 
  "country": "USA", 
  "is_account": true, 
  "is_closed": false, 
  "short_name": "SN0003", 
  "opening_date": "2017-01-01", 
  "benchmark_ids": [], 
  "address_1": "123 main street", 
  "charge_unit_id": null, 
  "custodian_name": "TD Ameritrade", 
  "billing_split_ids": [], 
  "id": 4, 
  "zip_code": "60605", 
  "address_3": "", 
  "display_name": "Account: XqdVpqLTKXpg IRA", 
  "master_number": "393076", 
  "is_active": true, 
  "has_custodian_name": true, 
  "inception_date": "2017-01-01", 
  "state": "IL", 
  "display_number": "XXXXX 688"
}

Update an account

PUT https://app.bridgeft.com/api/v2/accounts/accounts/{id}

Returns the account that was updated.

Arguments
id Required. The unique resource id for the Account.
number Required. The account number for this Account.
master_number Required. The master number for this Account.
custodian The custodian of this Account.
charge_unit_id Required. The id of the associated Charge Unit to this Account.
address_1 Required. The address 1st information for this Account.
address_2 Required. The address 2nd information for this Account.
address_3 Required. The address 3rd information for this Account.
city Required. The city address information for this Account.
state Required. The state address information for this Account.
zip_code Required. The zip code address information for this Account.
country Required. The country address information for this Account.
acct_type Required. The type of Account.
household_id Required. The id of the associated Household for this Account.
is_tax_deferred Required. Is tax deferred for this Account.
is_taxable Required. Is this Account taxable?
is_composite Required. Is this Account composite?
payment_source Required. The payment source for this Account.
first_billable_date Required. The first billable date for this Account.
billing_split_ids Required. The ids of the associated billing splits for this Account.
display_name The display name for this Account.
display_number The display number for this Account.
is_direct_billed Is direct billing active for this Account?
is_custodian_billed Is the custodian being billed for this Account?
is_active Is this Account active?
is_closed Is this Account closed?
custodian_name The custodian name for this Account.
has_custodian_name Does this Account have a custodian name?
entity_id Required. The entity id for this Account.
short_name Required. The short name or nick name for this Account.
opening_date Required. The date this Account was opened.
inception_date Required. The date of inception for this Account.
close_date Required. The close_date for this Account.
name Required. The name of this Account.
status Required. The status of this Account.
benchmark_ids Required. The ids of the benchmarks for this Account
managing_firm_id Required. The managing id of the firm associated with this Account.
firm_ids The associated firm ids for this Account.
is_account Is this an Account object?
is_household Is this a Household object?

Status: 200 OK

{
  "billing_split_ids": [], 
  "country": "USA", 
  "close_date": null, 
  "managing_firm_id": 7, 
  "is_taxable": true, 
  "is_composite": null, 
  "status": "22", 
  "name": "Account: QLwuTaaPwGAu", 
  "opening_date": "2017-01-01", 
  "acct_type": "IRA", 
  "charge_unit_id": null, 
  "has_custodian_name": true, 
  "short_name": "SN0003", 
  "is_active": true, 
  "custodian_name": "TD Ameritrade", 
  "is_tax_deferred": false, 
  "id": 4, 
  "custodian": "TDA", 
  "benchmark_ids": [], 
  "is_account": true, 
  "address_2": "", 
  "is_direct_billed": true, 
  "state": "IL", 
  "inception_date": "2017-01-01", 
  "number": "10932385", 
  "is_closed": false, 
  "master_number": "996106", 
  "first_billable_date": "2018-03-01", 
  "address_3": "", 
  "entity_id": "A-SN0003", 
  "display_name": "Account: QLwuTaaPwGAu IRA", 
  "firm_ids": [7], 
  "is_household": false, 
  "display_number": "XXXXX 385", 
  "zip_code": "60605", 
  "address_1": "123 main street", 
  "city": "Anytown", 
  "is_custodian_billed": false,
  "household_id": 4, 
  "payment_source": "D"
}

Bulk Update accounts

PUT https://app.bridgeft.com/api/v2/accounts/accounts

Returns the list of accounts that were updated.

Arguments (Note: A List of Accounts must be passed in)
id Required. The unique resource id for the Account.
number Required. The account number for this Account.
master_number Required. The master number for this Account.
custodian Required. The custodian of this Account.
charge_unit_id Required. The id of the associated Charge Unit to this Account.
address_1 Required. The address 1st information for this Account.
address_2 Required. The address 2nd information for this Account.
address_3 Required. The address 3rd information for this Account.
city Required. The city address information for this Account.
state Required. The state address information for this Account.
zip_code Required. The zip code address information for this Account.
country Required. The country address information for this Account.
acct_type Required. The type of Account.
household_id Required. The id of the associated Household for this Account.
is_tax_deferred Required. Is tax deferred for this Account.
is_taxable Required. Is this Account taxable?
is_composite Required. Is this Account composite?
payment_source Required. The payment source for this Account.
first_billable_date Required. The first billable date for this Account.
billing_split_ids Required. The ids of the associated billing splits for this Account.
display_name The display name for this Account.
display_number Optional. The display number for this Account.
is_direct_billed Optional. Is direct billing active for this Account?
is_custodian_billed Optional. Is the custodian being billed for this Account?
is_active Optional. Is this Account active?
is_closed Optional. Is this Account closed?
custodian_name Optional. The custodian name for this Account.
has_custodian_name Optional. Does this Account have a custodian name?
entity_id Required. The entity id for this Account.
short_name Required. The short name or nick name for this Account.
opening_date Required. The date this Account was opened.
inception_date Required. The date of inception for this Account.
close_date Required. The close_date for this Account.
name Required. The name of this Account.
status Required. The status of this Account.
benchmark_ids Required. The ids of the benchmarks for this Account
managing_firm_id The managing id of the firm associated with this Account.
firm_ids Optional. The associated firm ids for this Account.
is_account Optional. Is this an Account object?
is_household Optional. Is this a Household object?

200 Response

[
  {
    "billing_split_ids": [], 
    "country": "USA", 
    "close_date": null, 
    "managing_firm_id": 7, 
    "is_taxable": true, 
    "is_composite": null, 
    "status": "22", 
    "name": "Account: QLwuTaaPwGAu", 
    "opening_date": "2017-01-01", 
    "acct_type": "IRA", 
    "charge_unit_id": null, 
    "has_custodian_name": true, 
    "short_name": "SN0003", 
    "is_active": true, 
    "custodian_name": "TD Ameritrade", 
    "is_tax_deferred": false, 
    "id": 4, 
    "custodian": "TDA", 
    "benchmark_ids": [], 
    "is_account": true, 
    "address_2": "", 
    "is_direct_billed": true, 
    "state": "IL", 
    "inception_date": "2017-01-01", 
    "number": "10932385", 
    "is_closed": false, 
    "master_number": "996106", 
    "first_billable_date": "2018-03-01", 
    "address_3": "", 
    "entity_id": "A-SN0003", 
    "display_name": "Account: QLwuTaaPwGAu IRA", 
    "firm_ids": [7], 
    "is_household": false, 
    "display_number": "XXXXX 385", 
    "zip_code": "60605", 
    "address_1": "123 main street", 
    "city": "Anytown", 
    "is_custodian_billed": false,
    "household_id": 4, 
    "payment_source": "D"
  }
]

Billing Minimums

A Billing Minimum resource establishes a floor on services provided to clients regardless of account size. These can either be setup as a percentage of an accounts' balance or a flat fee.

billing minimum

Attributes
id Integer The unique resource id for this Billing Minimum.
firm_id Integer The firm id of the managing firm.
name String The name of this Billing Minimum.
value Integer The value of this Billing Minimum.
valuetype String The valuetype of this Billing Minimum's value.
firm Firm The managing firm of this Billing Minimum.

List all billing minimums

GET https://app.bridgeft.com/api/v2/billing/minimums

Returns a list of billing minimums

Arguments: None

Status: 200 OK

[
  {
    "firm_id": 14,
    "id": 1,
    "name": "Jones, Roberts and Davis",
    "value": 1000.0,
    "valuetype": "F"
  }
]

Retrieve a billing minimum

GET https://app.bridgeft.com/api/v2/billing/minimums/{id}

Returns a billing minimum based on a single ID

Arguments
id Required. The unique resource id for the Billing Minimum.

Status: 200 OK

{
  "firm_id": 14,
  "id": 1,
  "name": "Jones, Roberts and Davis",
  "value": 1000.0,
  "valuetype": "F"
}

Create a billing minimum

POST https://app.bridgeft.com/api/v2/billing/minimums

Returns the list of billings minimums that were created.

Arguments
id The unique resource id for this Billing Minimum.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Billing Minimum.
value Required. The value of this Billing Minimum.
valuetype Required. The value type of this Billing Minimum's value.
firm The managing firm of this Billing Minimum.

Status: 201 Created

[
  {
    "firm_id": 14,
    "id": 1,
    "name": "Jones, Roberts and Davis",
    "value": 1000.0,
    "valuetype": "F"
  }
]

Update a billing minimum

PUT https://app.bridgeft.com/api/v2/billing/minimums/{id}

Returns the list of billings minimums that were updated.

Arguments
id The unique resource id for this Billing Minimum.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Billing Minimum.
value Required. The value of this Billing Minimum.
valuetype Required. The value type of this Billing Minimum's value.
firm The managing firm of this Billing Minimum.

Status: 200 OK

{
  "firm_id": 14,
  "id": 1,
  "name": "Jones, Roberts and Davis",
  "value": 1000.0,
  "valuetype": "F"
}

Bulk Update billing minimums

PUT https://app.bridgeft.com/api/v2/billing/minimums

Returns the list of billings minimums that were updated.

Arguments
id The unique resource id for this Billing Minimum.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Billing Minimum.
value Required. The value of this Billing Minimum.
valuetype Required. The value type of this Billing Minimum's value.
firm The managing firm of this Billing Minimum.

Status: 200 OK

[
  {
    "firm_id": 14,
    "id": 1,
    "name": "Jones, Roberts and Davis",
    "value": 1000.0,
    "valuetype": "F"
  }
]

Delete a billing minimum

DELETE https://app.bridgeft.com/api/v2/billing/minimums/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Billing Minimum.

Status: 202 Accepted

{}

Bulk Delete billing minimums

POST https://app.bridgeft.com/api/v2/billing/minimums/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Billing Minimums that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Billing Splits

A Billing Split resource is used to track payouts to employees or other businesses.

billing splits

Attributes
id Integer The unique resource id for the Billing Split.
name String The name of the Billing Split, auto-generated if not supplied.
splitter_name String The name originally entered by the user.
splitter_slug String The sluggified version of the name field.
percentage Integer The percentage of the split stored on the natural scale.
firm_id Integer The id of the managing firm for this billing split.

List all billing splits

GET https://app.bridgeft.com/api/v2/billing/splits

Returns a list of billing splits

Arguments: None

Status: 200 OK

[
  {
    "firm_id": 13,
    "id": 1,
    "name": "Deleon Group",
    "percentage": 50.0,
    "splitter_name": "and Sons",
    "splitter_slug": "and-sons"
  }
]

Retrieve a billing split

GET https://app.bridgeft.com/api/v2/billing/splits/{id}

Returns a billing split based on a single ID

Arguments
id Required. The unique resource id for the Billing Split.

Status: 200 OK

{
  "firm_id": 13,
  "id": 1,
  "name": "Deleon Group",
  "percentage": 50.0,
  "splitter_name": "and Sons",
  "splitter_slug": "and-sons"
}

Create a billing split

POST https://app.bridgeft.com/api/v2/billing/splits

Returns the list of billings splits that were created.

Arguments
id The unique resource id for this Billing Split.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Billing Split.
splitter_name Required. The slugged name of this Billing Split.
splitter_slug Required. The slugged name of this Billing Split.
percentage Required. The percentage for this Billing Split.

Status: 201 Created

[
  {
    "firm_id": 13,
    "id": 1,
    "name": "Deleon Group",
    "percentage": 50.0,
    "splitter_name": "and Sons",
    "splitter_slug": "and-sons"
  }
]

Update a billing split

PUT https://app.bridgeft.com/api/v2/billing/splits/{id}

Returns the list of billings splits that were updated.

Arguments
id The unique resource id for this Billing Split.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Billing Split.
splitter_name Required. The slugged name of this Billing Split.
splitter_slug Required. The slugged name of this Billing Split.
percentage Required. The percentage for this Billing Split.

Status: 200 OK

  {
    "firm_id": 13,
    "id": 1,
    "name": "Deleon Group",
    "percentage": 50.0,
    "splitter_name": "and Sons",
    "splitter_slug": "and-sons"
  }

Bulk Update billing splits

PUT https://app.bridgeft.com/api/v2/billing/splits

Returns the list of billings splits that were updated.

Arguments
id The unique resource id for this Billing Split.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Billing Split.
splitter_name Required. The slugged name of this Billing Split.
splitter_slug Required. The slugged name of this Billing Split.
percentage Required. The percentage for this Billing Split.

Status: 200 OK

[
  {
    "firm_id": 13,
    "id": 1,
    "name": "Deleon Group",
    "percentage": 50.0,
    "splitter_name": "and Sons",
    "splitter_slug": "and-sons"
  }
]

Delete a billing split

DELETE https://app.bridgeft.com/api/v2/billing/splits/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Billing Split.

Status: 202 Accepted

{}

Bulk Delete billing splits

POST https://app.bridgeft.com/api/v2/billing/splits/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Billing Splits that you want to delete.

Status: 202 Accepted


{
  "n": 0
}

Charge Units

A Charge Unit resource, aka Fee Structure has a many to one relationship with a single Account. This resource is used to set various settings on how to calculate a firms' billings.

charge unit/fee structure

Attributes
id Integer The unique resource id for this Charge Unit.
created_by_id Integer The user profile id of the creator UserProfile.
firm_id Integer The firm id of the managing firm.
name String The name of this Charge Unit.
slug String The sluggified name of this Charge Unit.
calculation_type String The calculation type of this Charge Unit.
collection_type String The collection type of this Charge Unit.
frequency String The payment frequency for this Charge Unit.
quarter_cycle Integer The quarter billing cycle for this Charge Unit.
balance_type String The balance type for this Charge Unit.
flat_rate Decimal The flat rate for this Charge Unit.
flat_dollar_fee Decimal The flat dollar fee for this Charge Unit.
tiers_list [Tier] A list of Tier objects which share a many relationship with this Charge Unit.

List all charge units

GET https://app.bridgeft.com/api/v2/billing/charge-units

Returns a list of charge units

Arguments: None

Status: 200 OK

[
  {
    "balance_type": "E",
    "calculation_type": "T",
    "collection_type": "D",
    "created_by_id": null,
    "firm_id": 15,
    "flat_dollar_fee": null,
    "flat_rate": null,
    "frequency": "Q",
    "id": 1,
    "name": "Davenport LLC",
    "quarter_cycle": 3,
    "slug": "davenport-llc",
    "tiers_list": []
  }
]

Retrieve a charge unit

GET https://app.bridgeft.com/api/v2/billing/charge-units/{id}

Returns a charge unit based on a single ID

Arguments
id Required. The unique resource id for the Charge Unit.

Status: 200 OK

{
  "balance_type": "E",
  "calculation_type": "T",
  "collection_type": "D",
  "created_by_id": null,
  "firm_id": 15,
  "flat_dollar_fee": null,
  "flat_rate": null,
  "frequency": "Q",
  "id": 1,
  "name": "Davenport LLC",
  "quarter_cycle": 3,
  "slug": "davenport-llc",
  "tiers_list": []
}

Create a charge unit

POST https://app.bridgeft.com/api/v2/billing/charge-units

Returns the list of charge units that were created.

Arguments
id The unique resource id for this Charge Unit.
created_by_id Required. The user profile id of the creator UserProfile.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Charge Unit.
slug Required. The sluggified name of this Charge Unit.
calculation_type Required. The calculation type of this Charge Unit.
collection_type Required. The collection type of this Charge Unit.
frequency Required. The payment frequency for this Charge Unit.
quarter_cycle Required. The quarter billing cycle for this Charge Unit.
balance_type Required. The balance type for this Charge Unit.
flat_rate Required. The flat rate for this Charge Unit.
flat_dollar_fee Required. The flat dollar fee for this Charge Unit.
tiers_list Required. A list of Tier objects which share a many relationship with this Charge Unit.

Status: 201 Created

[
  {
    "balance_type": "E",
    "calculation_type": "T",
    "collection_type": "D",
    "created_by_id": null,
    "firm_id": 15,
    "flat_dollar_fee": null,
    "flat_rate": null,
    "frequency": "Q",
    "id": 1,
    "name": "Davenport LLC",
    "quarter_cycle": 3,
    "slug": "davenport-llc",
    "tiers_list": []
  }
]

Update a charge unit

PUT https://app.bridgeft.com/api/v2/billing/charge-units/{id}

Returns the charge unit that was updated.

Arguments
id The unique resource id for this Charge Unit.
created_by_id Required. The user profile id of the creator UserProfile.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Charge Unit.
slug Required. The sluggified name of this Charge Unit.
calculation_type Required. The calculation type of this Charge Unit.
collection_type Required. The collection type of this Charge Unit.
frequency Required. The payment frequency for this Charge Unit.
quarter_cycle Required. The quarter billing cycle for this Charge Unit.
balance_type Required. The balance type for this Charge Unit.
flat_rate Required. The flat rate for this Charge Unit.
flat_dollar_fee Required. The flat dollar fee for this Charge Unit.
tiers_list Required. A list of Tier objects which share a many relationship with this Charge Unit.

Status: 200 OK

{
  "balance_type": "E",
  "calculation_type": "T",
  "collection_type": "D",
  "created_by_id": null,
  "firm_id": 15,
  "flat_dollar_fee": null,
  "flat_rate": null,
  "frequency": "Q",
  "id": 1,
  "name": "Davenport LLC",
  "quarter_cycle": 3,
  "slug": "davenport-llc",
  "tiers_list": []
}

Bulk Update charge units

PUT https://app.bridgeft.com/api/v2/billing/charge-units

Returns the list of charge units that were updated.

Arguments (Note: A List of Charge Units must be passed in)
id The unique resource id for this Charge Unit.
created_by_id Required. The user profile id of the creator UserProfile.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Charge Unit.
slug Required. The sluggified name of this Charge Unit.
calculation_type Required. The calculation type of this Charge Unit.
collection_type Required. The collection type of this Charge Unit.
frequency Required. The payment frequency for this Charge Unit.
quarter_cycle Required. The quarter billing cycle for this Charge Unit.
balance_type Required. The balance type for this Charge Unit.
flat_rate Required. The flat rate for this Charge Unit.
flat_dollar_fee Required. The flat dollar fee for this Charge Unit.
tiers_list Required. A list of Tier objects which share a many relationship with this Charge Unit.

Status: 200 OK

[
  {
    "balance_type": "E",
    "calculation_type": "T",
    "collection_type": "D",
    "created_by_id": null,
    "firm_id": 15,
    "flat_dollar_fee": null,
    "flat_rate": null,
    "frequency": "Q",
    "id": 1,
    "name": "Davenport LLC",
    "quarter_cycle": 3,
    "slug": "davenport-llc",
    "tiers_list": []
  }
]

Delete a charge unit

DELETE https://app.bridgeft.com/api/v2/billing/charge-units/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Charge Unit.

Status: 202 Accepted

{}

Bulk Delete charge units

POST https://app.bridgeft.com/api/v2/billing/charge-units/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Charge Units that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Fee Upload Files

Everything about Fee Upload Files. This is where you would describe any authentication options.

fee upload file

Attributes
id Integer The unique resource id for this Fee Upload File.
created_dt_utc DateTime The date and time that this Fee Upload File was created.
firm_id Integer The firm id of the managing firm.
end_date Date The date that this Fee Upload File ends.
bucket String The bucket name for this Fee Upload File.
hashkey String The hashkey associated with this Fee Upload File.
archive_key String The archive key for this Fee Upload File.
file_key [String] A list of String file keys for this Fee Upload File.
num_files Integer The number of files for this Fee Upload File.
num_custodians Integer The number of custodians for this Fee Upload File.
num_accounts Integer The number of accounts for this Fee Upload File.
num_households Integer The number of households for this Fee Upload File.
total_annual_debit Decimal The total annual debit for this Fee Upload File.
total_period_debit Decimal The total period debit for this Fee Upload File.

List all fee upload files

GET https://app.bridgeft.com/api/v2/billing/fee-upload-files

Returns a list of fee upload files

Arguments: None

Status: 200 OK

[
  {
    "archive_key": "3592337513628135",
    "bucket": "NMC",
    "created_dt_utc": "2018-09-17T15:22:20.377454+00:00",
    "end_date": "1976-05-31",
    "file_keys": [],
    "firm_id": 17,
    "hashkey": "EsGZXuhxha",
    "id": 1,
    "num_accounts": 0,
    "num_custodians": 0,
    "num_files": 0,
    "num_households": 0,
    "total_annual_debit": 0.0,
    "total_period_debit": 0.0
  }
]

Retrieve a fee upload file

GET https://app.bridgeft.com/api/v2/billing/fee-upload-files/{id}

Returns a fee upload file based on a single ID

Arguments
id Required. The unique resource id for the Fee Upload File.

Status: 200 OK

{
  "archive_key": "3592337513628135",
  "bucket": "NMC",
  "created_dt_utc": "2018-09-17T15:22:20.377454+00:00",
  "end_date": "1976-05-31",
  "file_keys": [],
  "firm_id": 17,
  "hashkey": "EsGZXuhxha",
  "id": 1,
  "num_accounts": 0,
  "num_custodians": 0,
  "num_files": 0,
  "num_households": 0,
  "total_annual_debit": 0.0,
  "total_period_debit": 0.0
}

Invoices

An Invoice resource represents a generated report, similar to a Billing Report. An Invoice has the same information of a Billing Report, however is condensed by excluding some data that is not immediately necessary.

invoice

Attributes
id Integer The unique resource id for this Invoice.
firm_id Integer The firm id of the managing firm.
billing_group_id Integer The billing group id for this Invoice.
billing_date Date The billing date for this Invoice.
snapshot_date Date The snapshot date for this Invoice.
run_date Date The run date for this Invoice.
created_date Date The calendar date when the report was run.
billing_report_id Integer The associated billing report id for this Invoice.
account_value_on_snapshot_date Dict Maps account id to total account valuation on a particular date.
account_cash_on_snapshot_date Dict Maps the cash amount in the account as of the billing date.
account_value_on_run_date Dict Maps account id to total account valuation as of the report run date.
account_cash_on_run_date Dict Maps the cash amount in the account as of the report run date.
group_value_on_snapshot_date Dict Maps a group id to the total value of all accounts in the group on the snapshot date.
group_cash_on_snapshot_date Dict Maps group id to the total cash value of all accounts in the group on the snapshot date.
group_value_on_run_date Dict Maps a group id to the total value of all accounts in the group on the run date.
group_cash_on_run_date Dict Maps group id to the total cash value of all accounts in the group on the run date.
annual_fee Decimal The total fee and debited amount annualized just for this billing group.
annual_debit Decimal The annual debit for this Invoice.
total_balance Decimal The total group balance on the snapshot date.
period_debit Decimal The total debited amount for the period just for this billing grup on the snapshot date.
direct_billed_period_debit Decimal The direct billed period debit for this Invoice.
custodian_billed_period_debit Decimal The custodian billed period debit for this Invoice.
account_ids [Integer] The list of Account ids associated with this Invoice.
fee_structure_ids [Integer] The list of fee structure ids associated with this Invoice.
n_accounts Integer The numner of accounts in the report.
n_fee_structures Integer The number of fee structures in the report.
account_df Dict Serialized from the account_df dataframe on the billing calculator.
group_df Dict Serialized from group_df on the billing calculator.
minfee_df Dict Serialized from minimum fee on the billing calculator.
fee_structures_serialized Dict A serialization of fee structures as they existed at the time the report was generated.
asset_adjustments_serialized Dict Serialized asset adjustments at the time the report was generated.
billing_group_serialized Dict Serialized billing group at the time the invoice was created.
is_paid Boolean Indicates whether the invoice has been paid.

List all invoices

GET https://app.bridgeft.com/api/v2/billing/invoices

Returns a list of invoices

Arguments: None

Status: 200 OK

[
  {
    "account_cash_on_run_date": {},
    "account_cash_on_snapshot_date": {},
    "account_df": {},
    "account_ids": [],
    "account_value_on_run_date": {},
    "account_value_on_snapshot_date": {},
    "annual_debit": 0.0,
    "annual_fee": 0.0,
    "asset_adjustments_serialized": {},
    "billing_date": "2018-09-17",
    "billing_group_id": null,
    "billing_group_serialized": {},
    "billing_report_id": 2,
    "created_date": "2018-09-17",
    "custodian_billed_period_debit": 0.0,
    "direct_billed_period_debit": 0.0,
    "fee_structure_ids": [],
    "fee_structures_serialized": {},
    "firm_id": 20,
    "group_cash_on_run_date": {},
    "group_cash_on_snapshot_date": {},
    "group_df": {},
    "group_value_on_run_date": {},
    "group_value_on_snapshot_date": {},
    "id": 1,
    "is_paid": false,
    "minfee_df": {},
    "n_accounts": 0,
    "n_fee_structures": 0,
    "period_debit": 0.0,
    "run_date": "2018-09-17",
    "snapshot_date": "2018-09-17",
    "total_balance": 0.0
  }
]

Retrieve an invoice

GET https://app.bridgeft.com/api/v2/billing/invoices/{id}

Returns an invoice based on a single ID

Arguments
id Required. The unique resource id for the Invoice.

Status: 200 OK

{
  "account_cash_on_run_date": {},
  "account_cash_on_snapshot_date": {},
  "account_df": {},
  "account_ids": [],
  "account_value_on_run_date": {},
  "account_value_on_snapshot_date": {},
  "annual_debit": 0.0,
  "annual_fee": 0.0,
  "asset_adjustments_serialized": {},
  "billing_date": "2018-09-17",
  "billing_group_id": null,
  "billing_group_serialized": {},
  "billing_report_id": 2,
  "created_date": "2018-09-17",
  "custodian_billed_period_debit": 0.0,
  "direct_billed_period_debit": 0.0,
  "fee_structure_ids": [],
  "fee_structures_serialized": {},
  "firm_id": 20,
  "group_cash_on_run_date": {},
  "group_cash_on_snapshot_date": {},
  "group_df": {},
  "group_value_on_run_date": {},
  "group_value_on_snapshot_date": {},
  "id": 1,
  "is_paid": false,
  "minfee_df": {},
  "n_accounts": 0,
  "n_fee_structures": 0,
  "period_debit": 0.0,
  "run_date": "2018-09-17",
  "snapshot_date": "2018-09-17",
  "total_balance": 0.0
}

Account Groups

An Account Group resource, aka Billing Group is a grouping of Accounts in order to be used, when running a billing cycle.

account group

Attributes
id Integer The unique resource id for this Account Group.
firm_id Integer The firm id of the managing firm.
household_id Integer The id of the associated household for this Account Group.
name String The name of this Account Group.
slug String The sluggified name of this Account Group.
assignments_list [AccountGroupAssignment] A list of AccountGroupAssignment objects associated with this Account Group.
minimums_list [Integer] A list of billing minimum ids associated with this Account Group.

List all account groups

GET https://app.bridgeft.com/api/v2/billing/account-groups

Returns a list of account groups

Arguments: None

Status: 200 OK

[
  {
    "assignments_list": [],
    "firm_id": 18,
    "household_id": null,
    "id": 1,
    "minimums_list": [],
    "name": "Zhang-Pierce",
    "slug": "zhang-pierce"
  }
]

Retrieve an account group

GET https://app.bridgeft.com/api/v2/billing/account-groups/{id}

Returns an account group based on a single ID

Arguments
id Required. The unique resource id for the Account Group.

Status: 200 OK

{
  "assignments_list": [],
  "firm_id": 18,
  "household_id": null,
  "id": 1,
  "minimums_list": [],
  "name": "Zhang-Pierce",
  "slug": "zhang-pierce"
}

Create an account group

POST https://app.bridgeft.com/api/v2/billing/account-groups

Returns the list of account groups that were created.

Arguments
id The unique resource id for this Account Group.
firm_id Required. The firm id of the managing firm.
household_id Required. The id of the associated household for this Account Group.
name Required. The name of this Account Group.
slug Required. The slugged name of this Account Group.
assignments_list A list of AccountGroupAssignment objects associated with this Account Group.
minimums_list Required. A list of billing minimum ids associated with this Account Group.

Status: 201 Created

[
  {
    "assignments_list": [],
    "firm_id": 18,
    "household_id": null,
    "id": 1,
    "minimums_list": [],
    "name": "Zhang-Pierce",
    "slug": "zhang-pierce"
  }
]

Update an account group

PUT https://app.bridgeft.com/api/v2/billing/account-groups/{id}

Returns the list of account groups that were updated.

Arguments
id The unique resource id for this Account Group.
firm_id Required. The firm id of the managing firm.
household_id Required. The id of the associated household for this Account Group.
name Required. The name of this Account Group.
slug Required. The sluggified name of this Account Group.
assignments_list A list of AccountGroupAssignment objects associated with this Account Group.
minimums_list Required. A list of billing minimum ids associated with this Account Group.

Status: 200 OK

  {
    "assignments_list": [],
    "firm_id": 18,
    "household_id": null,
    "id": 1,
    "minimums_list": [],
    "name": "Zhang-Pierce",
    "slug": "zhang-pierce"
  }

Bulk Update account groups

PUT https://app.bridgeft.com/api/v2/billing/account-groups

Returns the list of account groups that were updated.

Arguments
id The unique resource id for this Account Group.
firm_id Required. The firm id of the managing firm.
household_id Required. The id of the associated household for this Account Group.
name Required. The name of this Account Group.
slug Required. The sluggified name of this Account Group.
assignments_list A list of AccountGroupAssignment objects associated with this Account Group.
minimums_list Required. A list of billing minimum ids associated with this Account Group.

Status: 200 OK

[
  {
    "assignments_list": [],
    "firm_id": 18,
    "household_id": null,
    "id": 1,
    "minimums_list": [],
    "name": "Zhang-Pierce",
    "slug": "zhang-pierce"
  }
]

Delete an account group

DELETE https://app.bridgeft.com/api/v2/billing/account-groups/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Account Group.

Status: 202 Accepted

{}

Bulk Delete an account group

POST https://app.bridgeft.com/api/v2/billing/account-groups/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Account Groups that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Asset Adjustments

An Asset Adjustment resource redefines how a balance is calculated for an account for any given period of time. For any given Account, records of that Accounts' balances are stored, however with an Asset Adjustment, these Balances must be derived from Positions in order to account for the adjustments. An example adjustment would be excluding AAPL from being included in an Accounts' performance calculations.

asset adjustment

Attributes
id Integer The unique resource id for this Asset Adjustment.
firm_id Integer The firm id of the managing firm.
name String The name of this Asset Adjustment.
slug String The sluggified name of this Asset Adjustment.
adjustment_type String The adjustment type for this Asset Adjustment which can be either Inclusion or Exclusion.
level String The level for this Asset Adjustment which can be either Firm or Account.
accounts_list [Integer] An account can be part of many adjustments and an adjustment can be applied to one or more accounts.
securities_list [Integer] A security can be part of many adjustments and an adjustment can have many securities.

List all asset adjustments

GET https://app.bridgeft.com/api/v2/billing/asset-adjustments

Returns a list of asset-adjustments

Arguments: None

Status: 200 OK

[
  {
    "accounts_list": [],
    "adjustment_type": "e",
    "firm_id": 19,
    "id": 1,
    "level": "a",
    "name": "Schneider-Burgess",
    "securities_list": [],
    "slug": "schneider-burgess"
  }
]

Retrieve an asset adjustment

GET https://app.bridgeft.com/api/v2/billing/asset-adjustments/{id}

Returns a asset adjustments based on a single ID

Arguments
id Required. The unique resource id for the Asset Adjustment.

Status: 200 OK

{
  "accounts_list": [],
  "adjustment_type": "e",
  "firm_id": 19,
  "id": 1,
  "level": "a",
  "name": "Schneider-Burgess",
  "securities_list": [],
  "slug": "schneider-burgess"
}

Create an asset adjustment

POST https://app.bridgeft.com/api/v2/billing/asset-adjustments

Returns the list of asset adjustments that were created.

Arguments
id The unique resource id for this Asset Adjustment.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Asset Adjustment.
slug Required. The sluggified name of this Asset Adjustment.
adjustment_type Required. The adjustment type for this Asset Adjustment which can be either Inclusion or Exclusion.
level Required. The level for this Asset Adjustment which can be either Firm or Account.
accounts_list Required. An account can be part of many adjustments and an adjustment can be applied to one or more accounts.
securities_list Required. A security can be part of many adjustments and an adjustment can have many securities.

Status: 201 Created

[
  {
    "accounts_list": [],
    "adjustment_type": "e",
    "firm_id": 19,
    "id": 1,
    "level": "a",
    "name": "Schneider-Burgess",
    "securities_list": [],
    "slug": "schneider-burgess"
  }
]

Update an asset adjustment

PUT https://app.bridgeft.com/api/v2/billing/asset-adjustments/{id}

Returns the list of asset adjustments that were updated.

Arguments
id The unique resource id for this Asset Adjustment.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Asset Adjustment.
slug Required. The sluggified name of this Asset Adjustment.
adjustment_type Required. The adjustment type for this Asset Adjustment which can be either Inclusion or Exclusion.
level Required. The level for this Asset Adjustment which can be either Firm or Account.
accounts_list Required. An account can be part of many adjustments and an adjustment can be applied to one or more accounts.
securities_list Required. A security can be part of many adjustments and an adjustment can have many securities.

Status: 200 OK

{
  "accounts_list": [],
  "adjustment_type": "e",
  "firm_id": 19,
  "id": 1,
  "level": "a",
  "name": "Schneider-Burgess",
  "securities_list": [],
  "slug": "schneider-burgess"
}

Bulk Update asset adjustments

PUT https://app.bridgeft.com/api/v2/billing/asset-adjustments

Returns the list of asset adjustments that were updated.

Arguments
id The unique resource id for this Asset Adjustment.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Asset Adjustment.
slug Required. The sluggified name of this Asset Adjustment.
adjustment_type Required. The adjustment type for this Asset Adjustment which can be either Inclusion or Exclusion.
level Required. The level for this Asset Adjustment which can be either Firm or Account.
accounts_list Required. An account can be part of many adjustments and an adjustment can be applied to one or more accounts.
securities_list Required. A security can be part of many adjustments and an adjustment can have many securities.

Status: 200 OK

[
  {
    "accounts_list": [],
    "adjustment_type": "e",
    "firm_id": 19,
    "id": 1,
    "level": "a",
    "name": "Schneider-Burgess",
    "securities_list": [],
    "slug": "schneider-burgess"
  }
]

Delete an asset adjustment

DELETE https://app.bridgeft.com/api/v2/billing/asset-adjustments/{id}

Returns an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Asset Adjustment.

Status: 202 Accepted

{}

Bulk Delete an asset adjustment

POST https://app.bridgeft.com/api/v2/billing/asset-adjustments/delete-many

Returns an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Asset Adjustments that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Billing Reports

A Billing Report resource stores a generated billing report and all the serialize data that comes with it. This report can be downloaded from the frontend as well.

billing report

Attributes
id Integer The unique resource id for this Billing Report.
firm_id Integer The firm id of the managing firm.
is_locked Boolean Locked reports can't be overwritten whereas unlocked reports are replaced when the same billing date is re-run.
created_invoices Boolean True if invoices were created when the report was created.
billing_date Date The input date to the Billing Report.
snapshot_date Date The closest date available to the billing date for which there's data at the time of running the report.
run_date Date The most recent market date corresponding to when the report date.
created_date Date The calendar date on which the report was generated / created.
annual_fee Decimal Total fee and debited amount annualized.
annual_debit Decimal The annual debit amount for this Billing Report.
total_balance Decimal Sum of all group balances on the billing date.
aum_on_billing_date Decimal All assets under management on the billing date.
period_debit Decimal Total debited amount for the period.
direct_billed_period_debit Decimal The direct billed period debit for this Billing Report.
custodian_billed_period_debit Decimal The custodian billed period debit for this Billing Report.
split_payout Decimal Total payout of all splits for this period.
split_payout_annualized Decimal Split payout on an annualized basis.
firm_share Decimal The firm's share for the period = period_debit - split_payout.
firm_share_annualized Decimal Firm's annualized share = annual_debit - split_payout_annualized.
account_value_on_snapshot_date Dict Maps account id to total account valuation on a particular date.
account_cash_on_snapshot_date Dict Maps the cash amount in the account as of the billing date.
account_value_on_run_date Dict Maps account id to total account valuation as of the report run date.
account_cash_on_run_date Dict Maps the cash amount in the account as of the report run date.
group_value_on_snapshot_date Dict Maps a group id to the total value of all accounts in the group on the snapshot date.
group_cash_on_snapshot_date Dict Maps group id to the total cash value of all accounts in the group on the snapshot date.
group_value_on_run_date Dict Maps a group id to the total value of all accounts in the group on the run date.
group_cash_on_run_date Dict Maps group id to the total cash value of all accounts in the group on the run date.
account_ids [Integer] The associated accounts ids for this Billing Report.
group_ids [Integer] The associated group ids for this Billing Report.
fee_structure_ids [Integer] The associated fee structure ids for this Billing Report.
billing_split_ids [Integer] The associated billing split ids for this Billing Report.
n_accounts Integer The number of accounts for this Billing Report.
n_groups Integer The number of groups for this Billing Report.
n_splits Integer The number of billing splits for this Billing Report.
n_fee_structures Integer The number of fee structures for this Billing Report.
account_df Dict The number of accounts in the report.
group_df Dict The number of groups in the report.
minfee_df Dict Serialized from minimum fee on the billing calculator.
splits_df Dict Serialized from splits on the billing calculator.
agg_splits_by_account_df Dict The aggregated splits mapped to the account dataframe.
agg_splits_by_splitter_df Dict The aggregated splits mapped to the splitter dataframe.
agg_splits_by_group_df Dict The aggregated splits mapped to the group dataframe.
structure_fees_by_group_fs Dict Keyed on (1) group id and (2) fee structure id where it is valued on a number representing the structure fee orresponding to that groupid / fee structure combination.
fee_structure_levels_by_group_fs Dict Lists out levels of a fee structure.
fs_level_descriptions_df_by_group_fs Dict Column-oriented data representing fee structure level descriptions.
fee_upload_file_id Integer The corresponding fee upload file model instance.
fee_structures_serialized Dict This is a list of serialized fee structures which was derived using ChargeUnitSerializer.
asset_adjustments_serialized Dict Serialized asset adjustments at the time the report was generated.
billing_groups_serialized Dict Serialized billing groups at the time the report was generated.
billing_minimums_serialized Dict Serialized minimums at the time the report was created.
splits_serialized Dict Serialized splits at the time the report was created.

List all billing reports

GET https://app.bridgeft.com/api/v2/billing/reports

Returns a list of billing reports

Arguments: None

Status: 200 OK

[
  {
    "account_cash_on_run_date": {},
    "account_cash_on_snapshot_date": {},
    "account_df": {},
    "account_ids": [],
    "account_value_on_run_date": {},
    "account_value_on_snapshot_date": {},
    "agg_splits_by_account_df": {},
    "agg_splits_by_group_df": {},
    "agg_splits_by_splitter_df": {},
    "annual_debit": 0.0,
    "annual_fee": 0.0,
    "asset_adjustments_serialized": {},
    "aum_on_billing_date": 0.0,
    "billing_date": "2018-09-17",
    "billing_groups_serialized": {},
    "billing_minimums_serialized": {},
    "billing_split_ids": [],
    "created_date": "2018-09-17",
    "created_invoices": false,
    "custodian_billed_period_debit": 0.0,
    "direct_billed_period_debit": 0.0,
    "fee_structure_ids": [],
    "fee_structure_levels_by_group_fs": {},
    "fee_structures_serialized": {},
    "fee_upload_file_id": null,
    "firm_id": 16,
    "firm_share": 0.0,
    "firm_share_annualized": 0.0,
    "fs_level_descriptions_df_by_group_fs": {},
    "group_cash_on_run_date": {},
    "group_cash_on_snapshot_date": {},
    "group_df": {},
    "group_ids": [],
    "group_value_on_run_date": {},
    "group_value_on_snapshot_date": {},
    "id": 1,
    "is_locked": false,
    "minfee_df": {},
    "n_accounts": 0,
    "n_fee_structures": 0,
    "n_groups": 0,
    "n_splits": 0,
    "period_debit": 0.0,
    "run_date": "2018-09-17",
    "snapshot_date": "2018-09-17",
    "split_payout": 0.0,
    "split_payout_annualized": 0.0,
    "splits_df": {},
    "splits_serialized": {},
    "structure_fees_by_group_fs": {},
    "total_balance": 0.0
  } 
]

Retrieve a billing report

GET https://app.bridgeft.com/api/v2/billing/reports/{id}

Returns a billing report based on a single ID

Arguments
id Required. The unique resource id for the Billing Report.

Status: 200 OK

{
  "account_cash_on_run_date": {},
  "account_cash_on_snapshot_date": {},
  "account_df": {},
  "account_ids": [],
  "account_value_on_run_date": {},
  "account_value_on_snapshot_date": {},
  "agg_splits_by_account_df": {},
  "agg_splits_by_group_df": {},
  "agg_splits_by_splitter_df": {},
  "annual_debit": 0.0,
  "annual_fee": 0.0,
  "asset_adjustments_serialized": {},
  "aum_on_billing_date": 0.0,
  "billing_date": "2018-09-17",
  "billing_groups_serialized": {},
  "billing_minimums_serialized": {},
  "billing_split_ids": [],
  "created_date": "2018-09-17",
  "created_invoices": false,
  "custodian_billed_period_debit": 0.0,
  "direct_billed_period_debit": 0.0,
  "fee_structure_ids": [],
  "fee_structure_levels_by_group_fs": {},
  "fee_structures_serialized": {},
  "fee_upload_file_id": null,
  "firm_id": 16,
  "firm_share": 0.0,
  "firm_share_annualized": 0.0,
  "fs_level_descriptions_df_by_group_fs": {},
  "group_cash_on_run_date": {},
  "group_cash_on_snapshot_date": {},
  "group_df": {},
  "group_ids": [],
  "group_value_on_run_date": {},
  "group_value_on_snapshot_date": {},
  "id": 1,
  "is_locked": false,
  "minfee_df": {},
  "n_accounts": 0,
  "n_fee_structures": 0,
  "n_groups": 0,
  "n_splits": 0,
  "period_debit": 0.0,
  "run_date": "2018-09-17",
  "snapshot_date": "2018-09-17",
  "split_payout": 0.0,
  "split_payout_annualized": 0.0,
  "splits_df": {},
  "splits_serialized": {},
  "structure_fees_by_group_fs": {},
  "total_balance": 0.0
} 

Delete a billing report

DELETE https://app.bridgeft.com/api/v2/billing/reports/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Billing Report.

Status: 202 Accepted

{}

Bulk Delete billing reports

POST https://app.bridgeft.com/api/v2/billing/reports/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Billing Reports that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Aum

AUM or Assets Under Management represent the sum of all the Account's being represented by a particular firm or advisor.

aum

Attributes
id Integer The unique resource id for this AUM.
firm_id Integer The firm id of the managing firm.
as_of_date Date The current date of the AUM.
frequency String The frequency for the AUM.
total Decimal The total assets under management for the AUM.

List all aums

GET https://app.bridgeft.com/api/v2/analytics/aum

Returns a list of aums

Arguments: None

200 Response

[
  {
    "as_of_date": "2018-09-17",
    "firm_id": 22,
    "frequency": "D",
    "id": 1,
    "total": 0.0
  }
]

Retrieve an aum

GET https://app.bridgeft.com/api/v2/analytics/aum/{id}

Returns an aum based on a single ID

Arguments
id Required. The unique resource id for the AUM.

200 Response

  {
    "as_of_date": "2018-09-17",
    "firm_id": 22,
    "frequency": "D",
    "id": 1,
    "total": 0.0
  }

Pdf Reports

A Pdf Report resource is used to represent a generated report for all the Accounts under a Firm or individual advisor.

pdf report

Attributes
id Integer The unique resource id for this PDF Report.
firm_id Integer The firm id of the managing firm.
household_id Integer The id of the associated Household.
created_by_user_id Integer The id of the creating User and is null for system-generated reports.
report_date Date The report date for this PDF Report.
frequency String The frequency of generation for this PDF Report.
start_date Date The starting date for this PDF Report.
end_date Date The ending date for this PDF Report.
s3_bucket String The AWS S3 bucket name for this PDF Report.
s3_keypath String The AWS S3 keypath for this PDF Report.
timestamp_utc Float The creation timestamp for this PDF Report.
dt_utc DateTime The last update timestamp for this PDF Report.
size_bytes Integer The size in bytes of this PDF Report.
docraptor_test_mode Boolean True if the docraptor test mode flag was used in the generation of the pdf.
client_accessible Boolean If true the report is accessible in the client portal.
tags [String] The list of tags specified by the user where system-generated reports are always untagged.
sub_reports [String] The list of sub reports included in this pdf report.
state String The state of this PDF Report in the generation cycle.
error_message String Any error messages from this PDF Report.

List all pdf reports

GET https://app.bridgeft.com/api/v2/pdfreporting/pdf-reports

Returns a list of pdf reports

Arguments: None

Status: 200 OK

[
  {
    "account_id": 6,
    "client_accessible": true,
    "created_by_user_id": 2,
    "docraptor_test_mode": false,
    "dt_utc": "2018-09-19 19:04:32.191484",
    "end_date": "2018-03-31",
    "error_message": "",
    "frequency": "M",
    "household_id": null,
    "id": 1,
    "report_date": "2018-09-19",
    "s3_bucket": "mybucket",
    "s3_keypath": "JrlVxscOxb.pdf",
    "size_bytes": 1000,
    "start_date": "2018-01-01",
    "state": "R",
    "sub_reports": [
        "account_summary",
        "performance_summary",
        "performance_chart",
        "appraisals",
        "asset_allocation_top_holdings",
        "buy_sells",
        "deposits_withdrawals",
        "income",
        "realized_gain_loss",
        "management_fees"
    ],
    "tags": [],
    "timestamp_utc": 1537383872.1914828
  }
]

Retrieve a pdf report

GET https://app.bridgeft.com/api/v2/pdfreporting/pdf-reports/{id}

Returns a pdf report based on a single ID

Arguments
id Required. The unique resource id for the PDF Report.

Status: 200 OK

{
  "account_id": 6,
  "client_accessible": true,
  "created_by_user_id": 2,
  "docraptor_test_mode": false,
  "dt_utc": "2018-09-19 19:04:32.191484",
  "end_date": "2018-03-31",
  "error_message": "",
  "frequency": "M",
  "household_id": null,
  "id": 1,
  "report_date": "2018-09-19",
  "s3_bucket": "mybucket",
  "s3_keypath": "JrlVxscOxb.pdf",
  "size_bytes": 1000,
  "start_date": "2018-01-01",
  "state": "R",
  "sub_reports": [
      "account_summary",
      "performance_summary",
      "performance_chart",
      "appraisals",
      "asset_allocation_top_holdings",
      "buy_sells",
      "deposits_withdrawals",
      "income",
      "realized_gain_loss",
      "management_fees"
  ],
  "tags": [],
  "timestamp_utc": 1537383872.1914828
}

Create a pdf report

POST https://app.bridgeft.com/api/v2/pdfreporting/pdf-reports

Returns the list of pdf reports that were created.

Arguments
id The unique resource id for this PDF Report.
firm_id Required. The firm id of the managing firm.
household_id Required. The id of the associated Household.
created_by_user_id Required. The id of the creating User and is null for system-generated reports.
report_date Required. The report date for this PDF Report.
frequency Required. The frequency of generation for this PDF Report.
start_date Required. The starting date for this PDF Report.
end_date Required. The ending date for this PDF Report.
s3_bucket Required. The AWS S3 bucket name for this PDF Report.
s3_keypath Required. The AWS S3 keypath for this PDF Report.
timestamp_utc Required. The creation timestamp for this PDF Report.
dt_utc Required. The last update timestamp for this PDF Report.
size_bytes Required. The size in bytes of this PDF Report.
docraptor_test_mode Required. True if the docraptor test mode flag was used in the generation of the pdf.
client_accessible Required. If true the report is accessible in the client portal.
tags Required. The list of tags specified by the user where system-generated reports are always untagged.
sub_reports Required. The list of sub reports included in this pdf report.
state Required. The state of this PDF Report in the generation cycle.
error_message Required. Any error messages from this PDF Report.

Status: 201 Created

[
  {
    "account_id": 6,
    "client_accessible": true,
    "created_by_user_id": 2,
    "docraptor_test_mode": false,
    "dt_utc": "2018-09-19 19:04:32.191484",
    "end_date": "2018-03-31",
    "error_message": "",
    "frequency": "M",
    "household_id": null,
    "id": 1,
    "report_date": "2018-09-19",
    "s3_bucket": "mybucket",
    "s3_keypath": "JrlVxscOxb.pdf",
    "size_bytes": 1000,
    "start_date": "2018-01-01",
    "state": "R",
    "sub_reports": [
        "account_summary",
        "performance_summary",
        "performance_chart",
        "appraisals",
        "asset_allocation_top_holdings",
        "buy_sells",
        "deposits_withdrawals",
        "income",
        "realized_gain_loss",
        "management_fees"
    ],
    "tags": [],
    "timestamp_utc": 1537383872.1914828
  }
]

Delete a pdf report

DELETE https://app.bridgeft.com/api/v2/pdfreporting/pdf-reports/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the PDF Report.

Status: 202 Accepted

{}

Bulk Delete a pdf report

POST https://app.bridgeft.com/api/v2/pdfreporting/pdf-reports/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the PDF Reports that you want to delete.

202 Response

{
  "n": 0
}

Background Jobs

A Job resource, aka Background Job represents a placeholder for an asynchronous task issued by a user. The current Job types include running billing or generating a pdf report.

background job

Attributes
id Integer The unique resource id for this Sub Report Display Setting.
firm_id Integer The firm id of the managing firm.
job_type String The job type for this Background Job.
created_dt_utc DateTime The date and time this Background Job was created.
last_updated_dt_utc DateTime The last date and time this Background Job was updated.
queued_dt_utc DateTime The date and time that this Background Job was queued.
started_dt_utc DateTime The date and time that this Background Job was started.
finished_dt_utc DateTime The date and time that this Background Job was finished.
revoked_dt_utc DateTime The date and time that this Background Job was revoked.
failed_dt_utc DateTime The date and time that this Background Job failed.
created_by_id Integer The user id for the user who created this Background Job.
is_finished Boolean Returns true if the job is finished.
is_running Boolean Returns true if the job has been dequeued and is running.
is_queued Boolean Returns true if the job hasn't started yet and it's waiting in the queue to be processed.
is_failed Boolean Returns true if the job failed due to an exception.
is_revoked Boolean Returns true if the job was canceled by the user.
num_steps Integer The progress of a job but note that the number of steps might not be known until the job is dequeued.
current_step Integer Zero corresponds to the job waiting to be processed.
email_notification Boolean If true this sends an email notification to the user who created the job.
email_notification_dt_utc DateTime The timestamp at which the email notification was sent which only applies when email_notification is enabled.
allow_concurrent_instances Boolean Whether to allow simultaneous executions of the same job across different users.
parameters String Parameters of the executing task which are stored as serialized json.
celery_task_id String The celery message queue task id for this Background Job.

List all background jobs

GET https://app.bridgeft.com/api/v2/jobs/jobs

Returns a list of background jobs

Arguments: None

Status: 200 OK

[
  {
    "allow_concurrent_instances": false,
    "celery_task_id": "BURST",
    "created_by_id": 1,
    "created_dt_utc": "2018-09-18T14:43:20.915103+00:00",
    "current_step": 10,
    "email_notification": false,
    "email_notification_dt_utc": "2018-09-18T14:43:20.915157+00:00",
    "failed_dt_utc": "2018-09-18T14:43:20.915134+00:00",
    "finished_dt_utc": "2018-09-18T14:43:20.915128+00:00",
    "firm_id": 23,
    "id": 1,
    "is_failed": false,
    "is_finished": false,
    "is_queued": true,
    "is_revoked": false,
    "is_running": false,
    "job_type": "pdfrp",
    "last_updated_dt_utc": "2018-09-18T14:43:20.915117+00:00",
    "num_steps": 100,
    "parameters": "Guernsey pound",
    "queued_dt_utc": "2018-09-18T14:43:20.915122+00:00",
    "revoked_dt_utc": "2018-09-18T14:43:20.915131+00:00",
    "started_dt_utc": "2018-09-18T14:43:20.915125+00:00"
  }
]

Retrieve a background job

GET https://app.bridgeft.com/api/v2/jobs/jobs/{id}

Returns a background job based on a single ID

Arguments
id Required. The unique resource id for the Background Job.

Status: 200 OK

{
  "allow_concurrent_instances": false,
  "celery_task_id": "BURST",
  "created_by_id": 1,
  "created_dt_utc": "2018-09-18T14:43:20.915103+00:00",
  "current_step": 10,
  "email_notification": false,
  "email_notification_dt_utc": "2018-09-18T14:43:20.915157+00:00",
  "failed_dt_utc": "2018-09-18T14:43:20.915134+00:00",
  "finished_dt_utc": "2018-09-18T14:43:20.915128+00:00",
  "firm_id": 23,
  "id": 1,
  "is_failed": false,
  "is_finished": false,
  "is_queued": true,
  "is_revoked": false,
  "is_running": false,
  "job_type": "pdfrp",
  "last_updated_dt_utc": "2018-09-18T14:43:20.915117+00:00",
  "num_steps": 100,
  "parameters": "Guernsey pound",
  "queued_dt_utc": "2018-09-18T14:43:20.915122+00:00",
  "revoked_dt_utc": "2018-09-18T14:43:20.915131+00:00",
  "started_dt_utc": "2018-09-18T14:43:20.915125+00:00"
}

Create a background job

POST https://app.bridgeft.com/api/v2/jobs/jobs

Returns the list of background jobs that were created.

Arguments
id The unique resource id for this Sub Report Display Setting.
firm_id Required. The firm id of the managing firm.
job_type Required. The job type for this Background Job.
created_dt_utc Required. The date and time this Background Job was created.
last_updated_dt_utc Required. The last date and time this Background Job was updated.
queued_dt_utc Required. The date and time that this Background Job was queued.
started_dt_utc Required. The date and time that this Background Job was started.
finished_dt_utc Required. The date and time that this Background Job was finished.
revoked_dt_utc Required. The date and time that this Background Job was revoked.
failed_dt_utc Required. The date and time that this Background Job failed.
created_by_id Required. The user id for the user who created this Background Job.
is_finished Required. Returns true if the job is finished.
is_running Required. Returns true if the job has been dequeued and is running.
is_queued Required. Returns true if the job hasn't started yet and it's waiting in the queue to be processed.
is_failed Required. Returns true if the job failed due to an exception.
is_revoked Required. Returns true if the job was canceled by the user.
num_steps Required. The progress of a job but note that the number of steps might not be known until the job is dequeued.
current_step Required. Zero corresponds to the job waiting to be processed.
email_notification Required. If true this sends an email notification to the user who created the job.
email_notification_dt_utc Required. The timestamp at which the email notification was sent which only applies when email_notification is enabled.
allow_concurrent_instances Required. Whether to allow simultaneous executions of the same job across different users.
parameters Required. Parameters of the executing task which are stored as serialized json.
celery_task_id Required. The celery message queue task id for this Background Job.

Status: 201 Created

[
  {
    "allow_concurrent_instances": false,
    "celery_task_id": "BURST",
    "created_by_id": 1,
    "created_dt_utc": "2018-09-18T14:43:20.915103+00:00",
    "current_step": 10,
    "email_notification": false,
    "email_notification_dt_utc": "2018-09-18T14:43:20.915157+00:00",
    "failed_dt_utc": "2018-09-18T14:43:20.915134+00:00",
    "finished_dt_utc": "2018-09-18T14:43:20.915128+00:00",
    "firm_id": 23,
    "id": 1,
    "is_failed": false,
    "is_finished": false,
    "is_queued": true,
    "is_revoked": false,
    "is_running": false,
    "job_type": "pdfrp",
    "last_updated_dt_utc": "2018-09-18T14:43:20.915117+00:00",
    "num_steps": 100,
    "parameters": "Guernsey pound",
    "queued_dt_utc": "2018-09-18T14:43:20.915122+00:00",
    "revoked_dt_utc": "2018-09-18T14:43:20.915131+00:00",
    "started_dt_utc": "2018-09-18T14:43:20.915125+00:00"
  }
]

Benchmarks

Benchmarks are a weighted average of various market indexes. Only a handful of indexes are enabled by default; please contact support (service@bridgeft.com) to request a specific index to be added to your selection pool. Benchmarks help your clients contextualize the performance of their account by creating a sensible comparison.

benchmark

Attributes
id Integer The unique resource id for this Benchmark.
name String The name of the Benchmark resource.
slug String The sluggified name of the Benchmark resource.
firm_id Integer The id of the managing firm for this Benchmark resource.
coefficients_list [BenchmarkCoefficient] A list of BenchmarkCoefficients used to correlate a particular index with a Benchmark for performance calculations.

List all benchmarks

GET https://app.bridgeft.com/api/v2/benchmarks/benchmarks

Returns a list of benchmarks

Arguments: None

Status: 200 OK

[
 {
    "coefficients_list": [],
    "firm_id": 27,
    "id": 1,
    "name": "RMYqCPHyTHbu",
    "slug": "rmyqcphythbu"
 }
]

Retrieve a benchmark

GET https://app.bridgeft.com/api/v2/benchmarks/benchmarks/{id}

Returns a benchmark based on a single ID

Arguments
id The unique resource id for this Benchmark.

Status: 200 OK

{
  "coefficients_list": [],
  "firm_id": 27,
  "id": 1,
  "name": "RMYqCPHyTHbu",
  "slug": "rmyqcphythbu"
}

Create a benchmark

POST https://app.bridgeft.com/api/v2/benchmarks/benchmarks

Returns the list of benchmarks that were created.

Arguments
id The unique resource id for this Benchmark.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Benchmark.
slug Required. The sluggified name of this Benchmark.
coefficients_list Required. A list of BenchmarkCoefficients that will be associated with this Benchmark

Status: 201 Created

[
  {
    "coefficients_list": [],
    "firm_id": 27,
    "id": 1,
    "name": "RMYqCPHyTHbu",
    "slug": "rmyqcphythbu"
  }
]

Update a benchmark

PUT https://app.bridgeft.com/api/v2/benchmarks/benchmarks/{id}

Returns the list of benchmarks that were updated.

Arguments
id The unique resource id for this Benchmark.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Benchmark.
slug Required. The sluggified name of this Benchmark.
coefficients_list Required. A list of BenchmarkCoefficients that will be associated with this Benchmark

Status: 200 OK

{
  "coefficients_list": [],
  "firm_id": 27,
  "id": 1,
  "name": "RMYqCPHyTHbu",
  "slug": "rmyqcphythbu"
}

Bulk Update benchmarks

PUT https://app.bridgeft.com/api/v2/benchmarks/benchmarks

Returns the list of benchmarks that were updated.

Arguments
id The unique resource id for this Benchmark.
firm_id Required. The firm id of the managing firm.
name Required. The name of this Benchmark.
slug Required. The sluggified name of this Benchmark.
coefficients_list Required. A list of BenchmarkCoefficients that will be associated with this Benchmark

Status: 200 OK

[
  {
    "coefficients_list": [],
    "firm_id": 27,
    "id": 1,
    "name": "RMYqCPHyTHbu",
    "slug": "rmyqcphythbu"
  }
]

Delete a benchmark

DELETE https://app.bridgeft.com/api/v2/benchmarks/benchmarks/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for this Benchmark.

Status: 202 Accepted

{}

Bulk Delete benchmarks

POST https://app.bridgeft.com/api/v2/benchmarks/benchmarks/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Benchmarks that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Indexes

An Index resource represents serialized index data. Indexes can't be created and are available to all firms and users (notwithstanding permissions)

index

Attributes
id Integer The unique resource id for this Index.
internal_name String The internal name of the Index resource.
vendor_name String The vendor name for this Index.
issuer_cusip String The cusip (unique id) for this Indexs' issuer.
cusip String The cusip (unique id) for this Index.
sedol String The sedol for this Index.
des1 String The first description field for this Index.
des2 String The second description field for this Index.
des3 String The third description field for this Index.
ts_start_date Date The timeseries start date for this Index.
ts_end_date Date The timeseries end date for this Index.
timeseries_length Integer The length of the timeseries for this Index.
market_values {Date: Float} A mapping of market values where they are available if the user is retrieving a specific index.

List all indexes

GET https://app.bridgeft.com/api/v2/benchmarks/indexes

Returns a list of indexes

Arguments: None

Status: 200 OK

[
  {
    "cusip": "123000000",
    "des1": "smPswqEkQpdz",
    "des2": "",
    "des3": "",
    "id": 1,
    "internal_name": "jNNqpKqcVW",
    "issuer_cusip": "",
    "market_values": {},
    "sedol": "XIONEM",
    "timeseries_length": null,
    "ts_end_date": null,
    "ts_start_date": null,
    "vendor_name": "jNNqpKqcVW (vendor)"
  }
]

Retrieve an index

GET https://app.bridgeft.com/api/v2/benchmarks/indexes/{id}

Returns an index based on a single ID

Arguments
id Required. The unique resource id for the Index.

Status: 200 OK

{
  "cusip": "123000000",
  "des1": "smPswqEkQpdz",
  "des2": "",
  "des3": "",
  "id": 1,
  "internal_name": "jNNqpKqcVW",
  "issuer_cusip": "",
  "market_values": {},
  "sedol": "XIONEM",
  "timeseries_length": null,
  "ts_end_date": null,
  "ts_start_date": null,
  "vendor_name": "jNNqpKqcVW (vendor)"
}

User Profiles

User Profile resources represent the users' profile and links a User resource with a Firm and applies certain permissions based on passed in settings.

user profile

Attributes
id Integer The unique resource id for this User Profile.
firm_id Integer The firm id for this User Profile.
invite_status String The invite status for the User Profile.
user_id Integer The user id associated with the User Profile.
account_access_level String The account access level given to this User Profile.
accessible_household_ids [Integer] A list of household ids that are accessible by this User Profile.
assigned_permissions [String] A list of permissions assigned to this User Profile.
user_permissions [String] A list of permissions assigned to the User Profiles' User.
is_owner Boolean Determines whether this User Profile is the owner.
end_client_household_id Integer The end client household's id.
user_role_id Integer The id of the User Role associated with the User Profile.
is_firm_user Boolean Whether this User Profile is a firm user.
is_client_user Boolean Whether this User Profile is a client user.
is_demo_user Boolean Whether this User Profile is a demo user.
is_verified Boolean Whether this User Profile has been verified.
verified_dt_utc DateTime The date and time that this User Profile was verified.
firm_ids [Integer] A list of firm ids associated with this UserProfile.
role_name String The role name for this User Profile.
username String The username for this User Profile.
first_name String The first name for this User Profile.
last_name String The last name for this User Profile.
full_name String The full name associated with this User Profile.
email String The email associated with this User Profile.

List all user profiles

GET https://app.bridgeft.com/api/v2/users/profiles

Returns a list of user-profiles

Arguments: None

Status: 200 OK

[
  {
    "accessible_household_ids": [],
    "account_access_level": "all",
    "assigned_permissions": [],
    "email": "user-3@example.org",
    "end_client_household_id": null,
    "firm_id": 28,
    "firm_ids": [
        28
    ],
    "first_name": "pNubz",
    "full_name": "pNubz VodfKUlTmX",
    "id": 1,
    "invite_status": "",
    "is_client_user": false,
    "is_demo_user": false,
    "is_firm_user": true,
    "is_owner": false,
    "is_verified": true,
    "last_name": "VodfKUlTmX",
    "role_name": "firm_user",
    "user_id": 4,
    "user_permissions": [],
    "user_role_id": null,
    "username": "user-3",
    "verified_dt_utc": "2018-11-09T22:21:04.776937"
  }
]

Retrieve an user profile by id

GET https://app.bridgeft.com/api/v2/users/profiles/{id}

Returns an user profile based on a single ID

Arguments
id Required. The unique resource id for the User Profile.

Status: 200 OK

{
  "accessible_household_ids": [],
  "account_access_level": "all",
  "assigned_permissions": [],
  "email": "user-3@example.org",
  "end_client_household_id": null,
  "firm_id": 28,
  "firm_ids": [
      28
  ],
  "first_name": "pNubz",
  "full_name": "pNubz VodfKUlTmX",
  "id": 1,
  "invite_status": "",
  "is_client_user": false,
  "is_demo_user": false,
  "is_firm_user": true,
  "is_owner": false,
  "is_verified": true,
  "last_name": "VodfKUlTmX",
  "role_name": "firm_user",
  "user_id": 4,
  "user_permissions": [],
  "user_role_id": null,
  "username": "user-3",
  "verified_dt_utc": "2018-11-09T22:21:04.776937"
}

Create a user profile

POST https://app.bridgeft.com/api/v2/users/profiles

Returns the list of user profiles that were created.

Arguments
id The unique resource id for this User Profile.
firm_id Required. The firm id for this User Profile.
invite_status Required. The invite status for the User Profile.
user_id Required. The user id associated with the User Profile.
account_access_level Required. The account access level given to this User Profile.
accessible_household_ids Required. A list of household ids that are accessible by this User Profile.
assigned_permissions Required. A list of permissions assigned to this User Profile.
user_permissions Required. A list of permissions assigned to the User Profiles' User.
is_owner Required. Determines whether this User Profile is the owner.
end_client_household_id Required. The end client household's id.
user_role_id Required. The id of the User Role associated with the User Profile.
is_firm_user Required. Whether this User Profile is a firm user.
is_client_user Required. Whether this User Profile is a client user.
is_demo_user Required. Whether this User Profile is a demo user.
is_verified Required. Whether this User Profile has been verified.
verified_dt_utc Required. The date and time that this User Profile was verified.
firm_ids Required. A list of firm ids associated with this UserProfile.
role_name Required. The role name for this User Profile.
username Required. The username for this User Profile.
first_name Required. The first name for this User Profile.
last_name Required. The last name for this User Profile.
full_name Required. The full name associated with this User Profile.
email Required. The email associated with this User Profile.

Status: 201 Created

[
  {
    "accessible_household_ids": [],
    "account_access_level": "all",
    "assigned_permissions": [],
    "email": "user-3@example.org",
    "end_client_household_id": null,
    "firm_id": 28,
    "firm_ids": [
        28
    ],
    "first_name": "pNubz",
    "full_name": "pNubz VodfKUlTmX",
    "id": 1,
    "invite_status": "",
    "is_client_user": false,
    "is_demo_user": false,
    "is_firm_user": true,
    "is_owner": false,
    "is_verified": true,
    "last_name": "VodfKUlTmX",
    "role_name": "firm_user",
    "user_id": 4,
    "user_permissions": [],
    "user_role_id": null,
    "username": "user-3",
    "verified_dt_utc": "2018-11-09T22:21:04.776937"
  }
]

Update a user profile

PUT https://app.bridgeft.com/api/v2/users/profiles/{id}

Returns the list of user profiles that were updated.

Arguments
id The unique resource id for this User Profile.
firm_id Required. The firm id for this User Profile.
invite_status Required. The invite status for the User Profile.
user_id Required. The user id associated with the User Profile.
account_access_level Required. The account access level given to this User Profile.
accessible_household_ids Required. A list of household ids that are accessible by this User Profile.
assigned_permissions Required. A list of permissions assigned to this User Profile.
user_permissions Required. A list of permissions assigned to the User Profiles' User.
is_owner Required. Determines whether this User Profile is the owner.
end_client_household_id Required. The end client household's id.
user_role_id Required. The id of the User Role associated with the User Profile.
is_firm_user Required. Whether this User Profile is a firm user.
is_client_user Required. Whether this User Profile is a client user.
is_demo_user Required. Whether this User Profile is a demo user.
is_verified Required. Whether this User Profile has been verified.
verified_dt_utc Required. The date and time that this User Profile was verified.
firm_ids Required. A list of firm ids associated with this UserProfile.
role_name Required. The role name for this User Profile.
username Required. The username for this User Profile.
first_name Required. The first name for this User Profile.
last_name Required. The last name for this User Profile.
full_name Required. The full name associated with this User Profile.
email Required. The email associated with this User Profile.

Status: 200 OK

{
  "accessible_household_ids": [],
  "account_access_level": "all",
  "assigned_permissions": [],
  "email": "user-3@example.org",
  "end_client_household_id": null,
  "firm_id": 28,
  "firm_ids": [
      28
  ],
  "first_name": "pNubz",
  "full_name": "pNubz VodfKUlTmX",
  "id": 1,
  "invite_status": "",
  "is_client_user": false,
  "is_demo_user": false,
  "is_firm_user": true,
  "is_owner": false,
  "is_verified": true,
  "last_name": "VodfKUlTmX",
  "role_name": "firm_user",
  "user_id": 4,
  "user_permissions": [],
  "user_role_id": null,
  "username": "user-3",
  "verified_dt_utc": "2018-11-09T22:21:04.776937"
}

Bulk Update user profiles

PUT https://app.bridgeft.com/api/v2/users/profiles

Returns the list of user profiles that were updated.

Arguments
id The unique resource id for this User Profile.
firm_id Required. The firm id for this User Profile.
invite_status Required. The invite status for the User Profile.
user_id Required. The user id associated with the User Profile.
account_access_level Required. The account access level given to this User Profile.
accessible_household_ids Required. A list of household ids that are accessible by this User Profile.
assigned_permissions Required. A list of permissions assigned to this User Profile.
user_permissions Required. A list of permissions assigned to the User Profiles' User.
is_owner Required. Determines whether this User Profile is the owner.
end_client_household_id Required. The end client household's id.
user_role_id Required. The id of the User Role associated with the User Profile.
is_firm_user Required. Whether this User Profile is a firm user.
is_client_user Required. Whether this User Profile is a client user.
is_demo_user Required. Whether this User Profile is a demo user.
is_verified Required. Whether this User Profile has been verified.
verified_dt_utc Required. The date and time that this User Profile was verified.
firm_ids Required. A list of firm ids associated with this UserProfile.
role_name Required. The role name for this User Profile.
username Required. The username for this User Profile.
first_name Required. The first name for this User Profile.
last_name Required. The last name for this User Profile.
full_name Required. The full name associated with this User Profile.
email Required. The email associated with this User Profile.

Status: 200 OK

[
  {
    "accessible_household_ids": [],
    "account_access_level": "all",
    "assigned_permissions": [],
    "email": "user-3@example.org",
    "end_client_household_id": null,
    "firm_id": 28,
    "firm_ids": [
        28
    ],
    "first_name": "pNubz",
    "full_name": "pNubz VodfKUlTmX",
    "id": 1,
    "invite_status": "",
    "is_client_user": false,
    "is_demo_user": false,
    "is_firm_user": true,
    "is_owner": false,
    "is_verified": true,
    "last_name": "VodfKUlTmX",
    "role_name": "firm_user",
    "user_id": 4,
    "user_permissions": [],
    "user_role_id": null,
    "username": "user-3",
    "verified_dt_utc": "2018-11-09T22:21:04.776937"
  }
]

Delete a user profile

DELETE https://app.bridgeft.com/api/v2/users/profiles/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the User Profile.

Status: 202 Accepted

{}

Bulk Delete user profiles

POST https://app.bridgeft.com/api/v2/users/profiles/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. The unique resource ids for the User Profiles that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

User Roles

A User Role resource represents the users' role within a firm or group.

user role

Attributes
id Integer The unique resource id for this User Role.
firm_id Integer The id of the representing firm.
created_by_id Integer The id of the User entity that created this object.
name String The name given to this User Role.
slug String The sluggified name given to this User Role.
description String The string description of this User Role.
permissions [String] Validation for this User Role which is a list of a permission code in the permissions config manager.

List all user roles

GET https://app.bridgeft.com/api/v2/users/roles

Returns a list of user roles

Arguments: None

Status: 200 OK

[
  {
    "created_by_user_id": 5,
    "description": "tQWCKhdftoaK",
    "firm_id": 29,
    "id": 1,
    "name": "zwsULcilDx",
    "permissions": [],
    "slug": "zwsulcildx"
  }
]

Retrieve a user role

GET https://app.bridgeft.com/api/v2/users/roles/{id}

Returns a user role based on a single ID

Arguments
id Required. The unique resource id for the User Role.

Status: 200 OK

{
  "created_by_user_id": 5,
  "description": "tQWCKhdftoaK",
  "firm_id": 29,
  "id": 1,
  "name": "zwsULcilDx",
  "permissions": [],
  "slug": "zwsulcildx"
}

Create a user role

POST https://app.bridgeft.com/api/v2/users/roles

Returns the list of user roles that were created.

Arguments
id The unique resource id for this User Role.
firm_id Required. The id of the representing firm.
created_by_id Required. The id of the User entity that created this object.
name Required. The name given to this User Role.
slug Required. The sluggified name given to this User Role.
description Required. The string description of this User Role.
permissions Required. Validation for this User Role which is a list of a permission code in the permissions config manager.

Status: 201 Created

[
  {
    "created_by_user_id": 5,
    "description": "tQWCKhdftoaK",
    "firm_id": 29,
    "id": 1,
    "name": "zwsULcilDx",
    "permissions": [],
    "slug": "zwsulcildx"
  }
]

Update a user role

PUT https://app.bridgeft.com/api/v2/users/roles/{id}

Returns the list of user roles that were updated.

Arguments
id The unique resource id for this User Role.
firm_id Required. The id of the representing firm.
created_by_id Required. The id of the User entity that created this object.
name Required. The name given to this User Role.
slug Required. The sluggified name given to this User Role.
description Required. The string description of this User Role.
permissions Required. Validation for this User Role which is a list of a permission code in the permissions config manager.

Status: 200 OK

{
  "created_by_user_id": 5,
  "description": "tQWCKhdftoaK",
  "firm_id": 29,
  "id": 1,
  "name": "zwsULcilDx",
  "permissions": [],
  "slug": "zwsulcildx"
}

Bulk Update user roles

PUT https://app.bridgeft.com/api/v2/users/roles

Returns the list of user roles that were updated.

Arguments
id The unique resource id for this User Role.
firm_id Required. The id of the representing firm.
created_by_id Required. The id of the User entity that created this object.
name Required. The name given to this User Role.
slug Required. The slugged name given to this User Role.
description Required. The string description of this User Role.
permissions Required. Validation for this User Role which is a list of a permission code in the permissions config manager.

Status: 200 OK

[
  {
    "created_by_user_id": 5,
    "description": "tQWCKhdftoaK",
    "firm_id": 29,
    "id": 1,
    "name": "zwsULcilDx",
    "permissions": [],
    "slug": "zwsulcildx"
  }
]

Delete a user role

DELETE https://app.bridgeft.com/api/v2/users/roles/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the User Role.

Status: 202 Accepted

{}

Bulk Delete user roles

POST https://app.bridgeft.com/api/v2/users/roles/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the User Roles that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Class Tags

Class Tags are tags given to a custom asset classification in order to order tags into groups for easier parsing.

class tag

Attributes
id Integer The unique resource id for this Class Tag.
firm_id Integer The id of the firm that has assigned the Class Tag.
created_dt_utc DateTime The date and time that this Class Tag was created.
name String The name given to this Class Tag.

List all class tags

GET https://app.bridgeft.com/api/v2/cac/class-tags

Returns a list of aums

Arguments: None

Status: 200 OK

[
  {
    "created_dt_utc": "2018-11-12T15:24:52.384543",
    "firm_id": 30,
    "id": 1,
    "name": "yrzzIndOZrdObRfvJFlyCzENiUKRAx"
  }
]

Retrieve a class tag

GET https://app.bridgeft.com/api/v2/cac/class-tags/{id}

Returns a class tag based on a single ID

Arguments
id Required. The unique resource id for the Class Tag.

Status: 200 OK

{
  "created_dt_utc": "2018-11-12T15:24:52.384543",
  "firm_id": 30,
  "id": 1,
  "name": "yrzzIndOZrdObRfvJFlyCzENiUKRAx"
}

Create a class tag

POST https://app.bridgeft.com/api/v2/cac/class-tags

Returns the list of class tags that were created.

Arguments
id The unique resource id for this Class Tag.
firm_id Required. The id of the firm that has assigned the Class Tag.
created_dt_utc Required. The date and time that this Class Tag was created.
name Required. The name given to this Class Tag.

Status: 201 Created

[
  {
    "created_dt_utc": "2018-11-12T15:24:52.384543",
    "firm_id": 30,
    "id": 1,
    "name": "yrzzIndOZrdObRfvJFlyCzENiUKRAx"
  }
]

Update a class tag

PUT https://app.bridgeft.com/api/v2/cac/class-tags/{id}

Returns the list of class tags that were updated.

Arguments
id The unique resource id for this Class Tag.
firm_id Required. The id of the firm that has assigned the Class Tag.
created_dt_utc Required. The date and time that this Class Tag was created.
name Required. The name given to this Class Tag.

Status: 200 OK

{
  "created_dt_utc": "2018-11-12T15:24:52.384543",
  "firm_id": 30,
  "id": 1,
  "name": "yrzzIndOZrdObRfvJFlyCzENiUKRAx"
}

Bulk Update class tags

PUT https://app.bridgeft.com/api/v2/cac/class-tags

Returns the list of class tags that were updated.

Arguments
id The unique resource id for this Class Tag.
firm_id Required. The id of the firm that has assigned the Class Tag.
created_dt_utc Required. The date and time that this Class Tag was created.
name Required. The name given to this Class Tag.

Status: 200 OK

[
  {
    "created_dt_utc": "2018-11-12T15:24:52.384543",
    "firm_id": 30,
    "id": 1,
    "name": "yrzzIndOZrdObRfvJFlyCzENiUKRAx"
  }
]

Delete a class tag

DELETE https://app.bridgeft.com/api/v2/cac/class-tags/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Class Tag.

Status: 202 Accepted

{}

Bulk Delete class tags

POST https://app.bridgeft.com/api/v2/cac/class-tags/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Class Tags that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Asset Classifications

Asset Classifications are classifications given to securities by firms to group certain indexes based on various metrics.

asset classification

Attributes
id Integer The unique resource id for this Asset Classification.
firm_id Integer The id of the firm that has assigned the Asset Classification.
security_id Integer The id of the security that this Asset Classification is representing.
created_by_user_id Integer The id of the user that created this Asset Classification.
created_by_profile_id Integer The id of the user profile that created this Asset Classification.
tag_id Integer The id of the Class Tag that is associated with this Asset Classification.

List all asset classifications

GET https://app.bridgeft.com/api/v2/cac/asset-classifications

Returns a list of asset classifications

Arguments: None

Status: 200 OK

[
  {
    "created_by_profile_id": 2,
    "created_by_user_id": 6,
    "firm_id": 31,
    "id": 1,
    "security_id": 5,
    "tag_id": 2
  }
]

Retrieve an asset classification

GET https://app.bridgeft.com/api/v2/cac/asset-classifications/{id}

Returns an asset classification based on a single ID

Arguments
id Required. The unique resource id for the Asset Classification.

Status: 200 OK

{
  "created_by_profile_id": 2,
  "created_by_user_id": 6,
  "firm_id": 31,
  "id": 1,
  "security_id": 5,
  "tag_id": 2
}

Create an asset classification

POST https://app.bridgeft.com/api/v2/cac/asset-classifications

Returns the list of asset classifications that were created.

Arguments
id The unique resource id for this Asset Classification.
firm_id Required. The id of the firm that has assigned the Asset Classification.
security_id Required. The id of the security that this Asset Classification is representing.
created_by_user_id Required. The id of the user that created this Asset Classification.
created_by_profile_id Required. The id of the user profile that created this Asset Classification.
tag_id Required. The id of the Class Tag that is associated with this Asset Classification.

Status: 201 Created

[
  {
    "created_by_profile_id": 2,
    "created_by_user_id": 6,
    "firm_id": 31,
    "id": 1,
    "security_id": 5,
    "tag_id": 2
  }
]

Update an asset classification

PUT https://app.bridgeft.com/api/v2/cac/asset-classifications/{id}

Returns the list of asset classifications that were updated.

Arguments
id The unique resource id for this Asset Classification.
firm_id Required. The id of the firm that has assigned the Asset Classification.
security_id Required. The id of the security that this Asset Classification is representing.
created_by_user_id Required. The id of the user that created this Asset Classification.
created_by_profile_id Required. The id of the user profile that created this Asset Classification.
tag_id Required. The id of the Class Tag that is associated with this Asset Classification.

Status: 200 OK

{
  "created_by_profile_id": 2,
  "created_by_user_id": 6,
  "firm_id": 31,
  "id": 1,
  "security_id": 5,
  "tag_id": 2
}

Bulk Update asset classifications

PUT https://app.bridgeft.com/api/v2/cac/asset-classifications

Returns the list of asset classifications that were updated.

Arguments
id The unique resource id for this Asset Classification.
firm_id Required. The id of the firm that has assigned the Asset Classification.
security_id Required. The id of the security that this Asset Classification is representing.
created_by_user_id Required. The id of the user that created this Asset Classification.
created_by_profile_id Required. The id of the user profile that created this Asset Classification.
tag_id Required. The id of the Class Tag that is associated with this Asset Classification.

Status: 200 OK

[
  {
    "created_by_profile_id": 2,
    "created_by_user_id": 6,
    "firm_id": 31,
    "id": 1,
    "security_id": 5,
    "tag_id": 2
  }
]

Delete an asset classification

DELETE https://app.bridgeft.com/api/v2/cac/asset-classifications/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Asset Classification.

Status: 202 Accepted

{}

Bulk Delete asset classification

POST https://app.bridgeft.com/api/v2/cac/asset-classifications/delete-many

Returns an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Asset Classifications that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Invites

An Invite resource represents an invite created by a client to bring on another new user.

invite

Attributes
id Integer The unique resource id for this Invite.
inviting_user_id Integer The user id of the inviting User.
user_id Integer The user id associated with this Invite.
profile_id Integer The user profile id of the associated user with this Invite.
firm_id Integer The id of the firm that created this Invite.
key String The key used for this Invite.
is_sent Boolean Indicates whether this Invite was sent or not.
is_active Boolean Indicates whether this Invite is active or not.
is_used Boolean Indicates whether this Invite is used or not.
sent_dt_utc DateTime The date and time that this Invite was sent.
used_dt_utc DateTime The date and time that this Invite was used.
rendered_html String The rendered html of this Invite displayed to the client.
rendered_text String The rendered text of this Invite displayed to the client.

List all invites

GET https://app.bridgeft.com/api/v2/invites/invites

Returns a list of invites

Arguments: None

Status: 200 OK

[
  {
    "firm_id": 35,
    "id": 1,
    "inviting_user_id": 8,
    "is_active": true,
    "is_sent": false,
    "is_used": false,
    "key": "123",
    "profile_id": 3,
    "rendered_html": "",
    "rendered_text": "",
    "sent_dt_utc": null,
    "used_dt_utc": null,
    "user_id": 9
  }
]

Retrieve an invite

GET https://app.bridgeft.com/api/v2/invites/invites/{id}

Returns an invite based on a single ID

Arguments
id Required. The unique resource id for the Invite.

Status: 200 OK

{
  "firm_id": 35,
  "id": 1,
  "inviting_user_id": 8,
  "is_active": true,
  "is_sent": false,
  "is_used": false,
  "key": "123",
  "profile_id": 3,
  "rendered_html": "",
  "rendered_text": "",
  "sent_dt_utc": null,
  "used_dt_utc": null,
  "user_id": 9
}

Create an invite

POST https://app.bridgeft.com/api/v2/invites/invites

Returns the list of invites that were created.

Arguments
id The unique resource id for this Invite.
inviting_user_id Required. The user id of the inviting User.
user_id Required. The user id associated with this Invite.
profile_id Required. The user profile id of the associated user with this Invite.
firm_id Required. The id of the firm that created this Invite.
key Required. The key used for this Invite.
is_sent Required. Indicates whether this Invite was sent or not.
is_active Required. Indicates whether this Invite is active or not.
is_used Required. Indicates whether this Invite is used or not.
sent_dt_utc Required. The date and time that this Invite was sent.
used_dt_utc Required. The date and time that this Invite was used.
rendered_html Required. The rendered html of this Invite displayed to the client.
rendered_text Required. The rendered text of this Invite displayed to the client.

Status: 201 Created

[
  {
    "firm_id": 35,
    "id": 1,
    "inviting_user_id": 8,
    "is_active": true,
    "is_sent": false,
    "is_used": false,
    "key": "123",
    "profile_id": 3,
    "rendered_html": "",
    "rendered_text": "",
    "sent_dt_utc": null,
    "used_dt_utc": null,
    "user_id": 9
  }
]

Delete an invite

DELETE https://app.bridgeft.com/api/v2/invites/invites/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Invite.

Status: 202 Accepted

{}

Bulk Delete

POST https://app.bridgeft.com/api/v2/invites/invites/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Invites that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Heldaway Positions

Represents a position within a sub account discovered through Quovo. NOTE: this table always holds CURRENT positions; not historical data.

heldaway postion

Attributes
id Integer The unique resource id for this Heldaway Position
firm_id Integer The id of the firm managing this heldaway position.
quovo_user_id Integer The id of the Quovo user associated with this position.
quovo_holding_id Integer The id of the position on Quovo's system.
account_id Integer The account id associated with this heldaway position.
currency String Unit of currency that is displayed where null is defaulted to USD.
value Decimal The total value of the position.
holding_type String An alias of the security type.
security_type String The type of this security (position) which maps to 'type' on the quovo api.
quantity Decimal The amount of shares of this position.
cost_basis_type String The status of the cost basis value and whether that links to a financial institution.
unit_price Decimal The unit price of this position which maps to 'price' on the quovo api.
security_type_confidence String The confidence in the security type which maps to 'type_confidence' on the quovo api.
symbol_name String The name used to represent this position which maps to 'ticker_name' on the quovo api.
last_purchase_date DateTime The last date of purchase of this security in the sub-account.
symbol String The symbol of the held asset.
connection_id Integer The id of the heldaway user login that owns this position.
basic_asset_class String The asset class associated with this position.
cusip String A unique identifier for each position.
forex_rate Decimal The current Forex rate representing this position.
sector String The asset sector that this position belongs to, used for categorization.
household_id Integer The id of the household to which this position belongs.
holding_type_confidence String The confidence of the holding type for this position.

List all heldaway positions

GET https://app.bridgeft.com/api/v2/data/heldaway/positions

Returns a list of all heldaway positions

Arguments: None

Status: 200 OK

{
    "currency": null,
    "account_id": 16328527,
    "value": 100,
    "holding_type": "Cash",
    "security_type": "Cash",
    "quovo_holding_id": 2580586138,
    "quantity": 100,
    "cost_basis_type": "",
    "unit_price": 1,
    "security_type_confidence": "",
    "symbol_name": "U S Dollar",
    "last_purchase_date": null,
    "symbol": "CUR:USD",
    "connection_id": 8304537,
    "basic_asset_class": "Cash & Cash Equivalent",
    "cusip": "",
    "firm_id": 39,
    "forex_rate": 1,
    "quovo_user_id": 5551060,
    "sector": "",
    "id": 39388,
    "household_id": 2969,
    "holding_type_confidence": ""
}

Retrieve a heldaway position

GET https://app.bridgeft.com/api/v2/data/heldaway/positions/{id}

Returns a heldaway position based on a single ID.

Arguments
id Required. The unique resource id for the Heldaway Postion.

Status: 200 OK

{
    "currency": null,
    "account_id": 16328527,
    "value": 100,
    "holding_type": "Cash",
    "security_type": "Cash",
    "quovo_holding_id": 2580586138,
    "quantity": 100,
    "cost_basis_type": "",
    "unit_price": 1,
    "security_type_confidence": "",
    "symbol_name": "U S Dollar",
    "last_purchase_date": null,
    "symbol": "CUR:USD",
    "connection_id": 8304537,
    "basic_asset_class": "Cash & Cash Equivalent",
    "cusip": "",
    "firm_id": 39,
    "forex_rate": 1,
    "quovo_user_id": 5551060,
    "sector": "",
    "id": 39388,
    "household_id": 2969,
    "holding_type_confidence": ""
}

Delete a heldaway position

DELETE https://app.bridgeft.com/api/v2/data/heldaway/positions/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the heldaway position.

Status: 202 Accepted

{}

Bulk Delete heldaway positions

POST https://app.bridgeft.com/api/v2/data/heldaway/positions/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the heldaway positions that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Heldaway Transactions

Represents a transaction within a sub-account discovered through Quovo.

heldaway transaction

Attributes
id Integer The unique resource id for this Heldaway Transaction
firm_id Integer The id of the firm managing this heldaway transaction.
quovo_user_id Integer The id of the Quovo user associated with this transaction.
quovo_transaction_id Integer The ID of the transaction on ID; note that it's refreshed every time.
account_id Integer The account id associated with this heldaway transaction.
currency String Unit of currency that is displayed.
value Decimal The total value of the transaction.
quantity Decimal The quantity is zero for cash deposits / withdrawals.
unit_price Decimal The price per unit; maps to "price" on the quovo api.
symbol String The symbol of the held asset.
connection_id Integer The id of the heldaway connection (user login) associated with this transaction.
cusip String A unique identifier used to distinguish between different transactions and avoid duplicates.
forex_rate Decimal The forex rate associated with this transaction.
household_id Integer The id of the household to which this transaction belongs.
is_cancel Boolean Whether the transaction is in a canceled state.
is_pending Boolean Whether the transaction is in a pending state.
tran_type String A granular classification; maps to "subtype" in the quovo api.
memo String A short text field used to associate information with a certain transaction.
trade_date DateTime Corresponds to the date on the quovo api.
security_name String The name of the security being transacted; maps to "symbol_name" on the quovo api.
tran_category String The broad classification; maps to "type" on the quovo api.
cashflow_category String The cashflow category used to distinguish between different transactions.
cashflow_subcategory String The cashflow sub-category used to provide further clarification.
fees Decimal The fees associated with this transactions, either credits or debits.

List all heldaway transactions

GET https://app.bridgeft.com/api/v2/data/heldaway/transactions

Returns a list of all heldaway transactions

Arguments: None

Status: 200 OK

{
    "currency": null,
    "account_id": 16328527,
    "value": 1.5,
    "is_cancel": false,
    "is_pending": false,
    "tran_type": "DV2C",
    "quantity": 0,
    "memo": "Dividend AAPL",
    "unit_price": 0,
    "trade_date": "2014-05-15",
    "security_name": "Apple Inc.",
    "symbol": "AAPL",
    "connection_id": 8304537,
    "cusip": "",
    "fees": 0,
    "tran_category": "I",
    "cashflow_category": "",
    "firm_id": 39,
    "cashflow_subcategory": "",
    "forex_rate": 1,
    "quovo_user_id": 5551060,
    "quovo_transaction_id": 4102310295,
    "id": 872294,
    "household_id": 2969
}

Retrieve a heldaway transaction

GET https://app.bridgeft.com/api/v2/data/heldaway/transactions/{id}

Returns a heldaway transaction based on a single ID.

Arguments
id Required. The unique resource id for the Heldaway Transaction.

Status: 200 OK

{
    "currency": null,
    "account_id": 16328527,
    "value": 1.5,
    "is_cancel": false,
    "is_pending": false,
    "tran_type": "DV2C",
    "quantity": 0,
    "memo": "Dividend AAPL",
    "unit_price": 0,
    "trade_date": "2014-05-15",
    "security_name": "Apple Inc.",
    "symbol": "AAPL",
    "connection_id": 8304537,
    "cusip": "",
    "fees": 0,
    "tran_category": "I",
    "cashflow_category": "",
    "firm_id": 39,
    "cashflow_subcategory": "",
    "forex_rate": 1,
    "quovo_user_id": 5551060,
    "quovo_transaction_id": 4102310295,
    "id": 872294,
    "household_id": 2969
}

Delete a heldaway transaction

DELETE https://app.bridgeft.com/api/v2/data/heldaway/transactions/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Heldaway Transaction.

Status: 202 Accepted

{}

Bulk Delete heldaway transactions

POST https://app.bridgeft.com/api/v2/data/heldaway/transactions/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the heldaway transactions that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Heldaway Accounts

This resource represents a heldaway account aggregated by Quovo.

heldaway account

Attributes
id Integer The unique resource id for this Heldaway Account.
firm_id Integer The ID of the firm managing this Heldaway Account.
quovo_user_id Integer The ID of the Quovo user for this sub-account.
household_id Integer The id of the household to which this account belongs.
value Decimal The total value of the account - quovo sums all the holdings in the account to get this value.
connection_id Integer The id of the quovo connection where the account came from.
relationship_type String Defined and governed by Atlas Dashboard.
institution_name String The name of the brokerage where the account resides.
updated_dt_utc DateTime The date and time that this account was last updated.
cash_value Decimal The total cash value that is owned by this Heldaway Account.
fixed_income_value Decimal The total value of the fixed income associated with this Account.
description String The description used when trying to identify a Heldaway Account.
category String The financial category this Account belongs to.
name String The main name given to this Heldaway account.
equity_value Decimal The value of all the equity owned by this account.
account_type String The alphanumerical type associated with this account that maps to the 'type' field on the quovo api.
is_taxable Boolean Whether this account is taxable or not, based on the type.
last_payload JSON ? The JSON representation of the last payload or serialized Heldaway Account.
username String The household's username.
other_value Decimal Extra information that should be stored with this Heldaway Account.
is_disabled Boolean Whether this Account is disabled or not.
institution_id String The id of brokerage where the account resides.
owner_type String The type of Account the owner associates with. Can be Individual, Joint or Trust.
nickname String The alternate name associated with this account to further separate each Heldaway Account.
account_type_confidence String The confidence level associated with the accuracy of the Heldaway Account type.

List all heldaway accounts

GET https://app.bridgeft.com/api/v2/data/heldaway/accounts

Returns a list of all heldaway accounts

Arguments: None

Status: 200 OK

{
    "relationship_type": "1",
    "institution_name": "Test Workflow (Good)",
    "value": 3682.89,
    "updated_dt_utc": "2018-10-09T17:33:53.018900",
    "cash_value": 0,
    "fixed_income_value": 0,
    "description": "",
    "category": "Investment",
    "name": "***ount",
    "equity_value": 3682.89,
    "account_type": "Brokerage Account",
    "connection_id": 8304537,
    "is_taxable": true,
    "last_payload": "{}",
    "firm_id": 39,
    "username": "demo__household-2969",
    "quovo_user_id": 5551060,
    "other_value": 0,
    "is_disabled": false,
    "institution_id": 19815,
    "owner_type": "Individual Account",
    "id": 16328526,
    "household_id": 2969,
    "nickname": "test acct",
    "account_type_confidence": "Very High"
}

Retrieve a heldaway account

GET https://app.bridgeft.com/api/v2/data/heldaway/accounts/{id}

Returns a heldaway account based on a single ID.

Arguments
id Required. The unique resource id for the Heldaway Account.

Status: 200 OK

{
    "relationship_type": "1",
    "institution_name": "Test Workflow (Good)",
    "value": 3682.89,
    "updated_dt_utc": "2018-10-09T17:33:53.018900",
    "cash_value": 0,
    "fixed_income_value": 0,
    "description": "",
    "category": "Investment",
    "name": "***ount",
    "equity_value": 3682.89,
    "account_type": "Brokerage Account",
    "connection_id": 8304537,
    "is_taxable": true,
    "last_payload": "{}",
    "firm_id": 39,
    "username": "demo__household-2969",
    "quovo_user_id": 5551060,
    "other_value": 0,
    "is_disabled": false,
    "institution_id": 19815,
    "owner_type": "Individual Account",
    "id": 16328526,
    "household_id": 2969,
    "nickname": "test acct",
    "account_type_confidence": "Very High"
}

Delete a heldaway account

DELETE https://app.bridgeft.com/api/v2/data/heldaway/accounts/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the heldaway account.

Status: 202 Accepted

{}

Bulk Delete heldaway accounts

POST https://app.bridgeft.com/api/v2/data/heldaway/accounts/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the heldaway accounts that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Heldaway User Login

This resource represents a login at a financial institution.

heldaway user login

Attributes
id Integer The ID of the connection (user login) on Quovo.
firm_id Integer The ID of the advisory firm managing this user login.
institution_id Integer The id of brokerage where the account resides.
institution_name String The name of the brokerage where the account resides.
quovo_user_id Integer The ID of the Quovo user associated with this connection (user login).
username String The username of the connection (user login) on Quovo.
status String The status of the connection (user login) on Quovo.
created_dt_utc DateTime The date the connection (user login) was created.
last_sync DateTime The date the connection (user login) was last synced.
is_disabled Boolean Disabled connections cannot be synced.
config_instructions String This field is nullable to match quovo's api.
last_good_sync DateTime The last UTC time this connection (user login was synced.
update_count Integer The tracking of how many times this connection (user login) has been updated.
value Decimal The total value of all accounts held with this financial institution.
last_status_update_utc DateTime The UTC time this connection (user login) was updated.
household_id Integer The Household owning this connection (user login).
last_webook_sync_payload JSON ? The last payload received from a sync webhook handler that applies to this user login.
auto_updates Boolean Whether the connection (user login) is automatically synced by quovo nightly.

List all heldaway user logins

GET https://app.bridgeft.com/api/v2/data/heldaway/user-logins

Returns a list of all heldaway user logins

Arguments: None

Status: 200 OK

{
    "status": "good",
    "created_dt_utc": "2018-10-09T17:33:25",
    "last_sync": "2018-10-09T17:33:42",
    "is_disabled": false,
    "institution_id": 19815,
    "institution_name": "Test Workflow (Good)",
    "config_instructions": "",
    "last_good_sync": "2018-10-09T17:33:42",
    "update_count": 0,
    "value": 3782.89,
    "firm_id": 39,
    "last_status_update_utc": "2018-10-09T17:33:48.325684",
    "household_id": 2969,
    "id": 8304537,
    "last_webhook_sync_payload": "{}",
    "username": "demo__household-2969",
    "quovo_user_id": 5551060,
    "auto_updates": false
}

Retrieve a heldaway user login

GET https://app.bridgeft.com/api/v2/data/heldaway/user-logins/{id}

Returns a heldaway user login based on a single ID.

Arguments
id Required. The unique resource id for the Heldaway User Login.

Status: 200 OK

{
    "status": "good",
    "created_dt_utc": "2018-10-09T17:33:25",
    "last_sync": "2018-10-09T17:33:42",
    "is_disabled": false,
    "institution_id": 19815,
    "institution_name": "Test Workflow (Good)",
    "config_instructions": "",
    "last_good_sync": "2018-10-09T17:33:42",
    "update_count": 0,
    "value": 3782.89,
    "firm_id": 39,
    "last_status_update_utc": "2018-10-09T17:33:48.325684",
    "household_id": 2969,
    "id": 8304537,
    "last_webhook_sync_payload": "{}",
    "username": "demo__household-2969",
    "quovo_user_id": 5551060,
    "auto_updates": false
}

Delete a heldaway user login

DELETE https://app.bridgeft.com/api/v2/data/heldaway/user-logins/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Heldaway User Login.

Status: 202 Accepted

{}

Bulk Delete heldaway user logins

POST https://app.bridgeft.com/api/v2/data/heldaway/user-logins/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the heldaway user login that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Shared Files

A file uploaded by either a firm user or end client. File contents are stored on s3; this model instance represents the file's metadata.

shared file

Attributes
id Integer The unique resource id for this Shared File object.
firm_id Integer The id of the managing firm.
uploaded_by_profile_id Integer The id of the user profile that upload this object.
sharing_scope String The type of sharing allowed either account or household.
shared_household_id Integer The id of the household when this object is set to household scope.
keypath String The full path to the key; this is empty until the file has been uploaded to S3.
key_hashvalue String A random piece of text (the first 8 characters of a uuid4) inserted into the filename to keep uniform lexical distribution.
bucket String The S3 bucket that this shared file is stored.
size_bytes Integer The size in bytes of this file.
filename String The name of the file pointed to by this Shared File object.
file_type String The type content of this Shared File.
content_type String The content type of the Shared File object.

List all shared files

GET https://app.bridgeft.com/api/v2/filesharing/shared-files

Returns a list of shared files

Arguments: None

Status: 200 Response

[
  {
    "size_bytes": 638240,
    "shared_household_id": 2974,
    "id": 680,
    "uploaded_by_profile_id": 1747,
    "content_type": "application/pdf",
    "filename": "gips-standards-2010 (1).pdf",
    "bucket": "prod.filesharing.bridgeft.com",
    "sharing_scope": "h",
    "keypath": "9278a399/gips-standards-2010 (1).pdf",
    "file_type": "3",
    "key_hashvalue": "9278a399",
    "firm_id": 39
  }
]

Retrieve a shared file

GET https://app.bridgeft.com/api/v2/filesharing/shared-files/{id}

Returns a shared file based on a single ID

Arguments
id Required. The unique resource id for the Shared File.

Status: 200 OK

  {
    "size_bytes": 638240,
    "shared_household_id": 2974,
    "id": 680,
    "uploaded_by_profile_id": 1747,
    "content_type": "application/pdf",
    "filename": "gips-standards-2010 (1).pdf",
    "bucket": "prod.filesharing.bridgeft.com",
    "sharing_scope": "h",
    "keypath": "9278a399/gips-standards-2010 (1).pdf",
    "file_type": "3",
    "key_hashvalue": "9278a399",
    "firm_id": 39
  }

Delete a shared file

DELETE https://app.bridgeft.com/api/v2/filesharing/shared-files/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Shared File.

Status: 202 Accepted

{}

Bulk Delete shared files

POST https://app.bridgeft.com/api/v2/filesharing/shared-files/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Shared Files that you want to delete.

Status: 202 Accepted

{
  "n": 0
}

Shared Links

The following resource is an expirable link that allows a user to share files without being logged in.

Attributes
id Integer The unique resource id for this Shared Link object.
firm_id Integer The id of the managing firm.
household_id Integer The id of the household that this link was created under.
created_by_profile_id Integer The id of the user profile that created this Shared Link.
expiration_dt_utc DateTime The date time that this shared link expires.
duration_seconds Integer The length of time that this shared link remains active.
opened_dt_utc DateTime The last time this shared link was opened.
link_uuid UUID The unique uuid of this shared link.
sharing_permissions [String] Specify what permissions to place on this shared link.

GET https://app.bridgeft.com/api/v2/filesharing/shared-links

Returns a list of shared links

Arguments: None

Status: 200 OK

[
  {
    "link_uuid": "27eba95e-91de-4134-92ee-008908a9683e",
    "household_id": 2974,
    "id": 29,
    "expiration_dt_utc": null,
    "duration_seconds": 3600,
    "firm_id": 39,
    "created_by_profile_id": 257,
    "opened_dt_utc": null,
    "sharing_permissions": [
        "file_sharing.link.view",
        "file_sharing.link.upload"
    ]
  }
]

GET https://app.bridgeft.com/api/v2/filesharing/shared-links/{id}

Returns an aum based on a single ID

Arguments
id Required. The unique resource id for the Shared Link.

Status: 200 OK

  {
    "link_uuid": "27eba95e-91de-4134-92ee-008908a9683e",
    "household_id": 2974,
    "id": 29,
    "expiration_dt_utc": null,
    "duration_seconds": 3600,
    "firm_id": 39,
    "created_by_profile_id": 257,
    "opened_dt_utc": null,
    "sharing_permissions": [
        "file_sharing.link.view",
        "file_sharing.link.upload"
    ]
  }

POST https://app.bridgeft.com/api/v2/filesharing/shared-links

Returns the list of shared links that were created.

Arguments
id The unique resource id for this Shared Link object.
firm_id Required. The id of the managing firm.
household_id Required. The id of the household that this link was created under.
created_by_profile_id Required. The id of the user profile that created this Shared Link.
expiration_dt_utc Required. The date time that this shared link expires.
duration_seconds Required. The length of time that this shared link remains active.
opened_dt_utc Required. The last time this shared link was opened.
link_uuid Required. The unique uuid of this shared link.
sharing_permissions Required. Specify what permissions to place on this shared link.

Status: 201 Created

[
  {
    "link_uuid": "27eba95e-91de-4134-92ee-008908a9683e",
    "household_id": 2974,
    "id": 29,
    "expiration_dt_utc": null,
    "duration_seconds": 3600,
    "firm_id": 39,
    "created_by_profile_id": 257,
    "opened_dt_utc": null,
    "sharing_permissions": [
        "file_sharing.link.view",
        "file_sharing.link.upload"
    ]
  }
]

DELETE https://app.bridgeft.com/api/v2/filesharing/shared-links/{id}

Returns the an "Accepted" message if deletion was successful.

Arguments
id Required. The unique resource id for the Shared Link.

Status: 202 Accepted

{}

POST https://app.bridgeft.com/api/v2/filesharing/shared-links/delete-many

Returns the an "Accepted" message and a json object with the number of items deleted, if deletion was successful.

Arguments
ids Required. A list of the unique resource ids for the Shared Links that you want to delete.

Status: 202 Accepted

{
  "n": 0
}