NAV Navbar

Start Here:

Introduction

Scroll down for example requests and responses.

Bridge Financial Technology provides a powerful REST API to integrate billing, index information, firm information, etc into your business or application. The current version of the API is V2.

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

The base API Endpoint is: https://staging.bridgeft.com/api/v2/

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.

Authentication

To obtain an Access Token for your User, refer to the /access-tokens endpoint below. We use Auth0's password grant flow for our API authentication. Auth0 will verify every User and upon success, return a JSON Web Token or JWT. BridgeFT will encapsulate this JWT from Auth0 inside an Access Token object, which is returned to the User.

The JWT within the Access Token should be used as a Bearer credential and transmitted in an HTTP Authorization header to the API endpoint.

The form of the HTTP Authorization header should be: Authorization: Bearer <JSON Web Token>

Access Tokens

An Access Token holds the Auth0 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.

The access token resource

Attributes
id
Integer
The unique resource id for this Access Token.
token
String
The JSON Web Token issued by Auth0.
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

Example responses

200 Response

[
  {
    "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
  }
]

GET http://staging.bridgeft.com/api/v2/access-tokens

Returns a list of access-tokens

Arguments
No arguments...

Retrieve an access token by id

Example responses

200 Response

{
  "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
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://staging.bridgeft.com/api/v2/access-tokens/{id}

Returns an access token based on a single ID

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

Create an access token

Example responses

201 Created Response

{
  "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
}

POST http://staging.bridgeft.com/api/v2/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.

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.

The position resource

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

Example responses

200 Response

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

GET http://atlas.bridgeft.com/positions/

Returns a list of positions.

Arguments
None

Retrieve a position by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/positions/{id}

Returns a single position based on an ID.

Arguments
id
REQUIRED
The unique resource id for the Position.

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.

The balance resource

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

Example responses

200 Response

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

GET http://atlas.bridgeft.com/balances/

Returns a list of balances.

Arguments
None

Retrieve a balance by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/balances/{id}

Returns a single balance based on an ID.

Arguments
id
REQUIRED
The unique resource id for the Balance.

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.

The security resource

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

Example responses

200 Response

[
  {
    "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"
  }
]

GET http://atlas.bridgeft.com/securities/

Returns a list of securities.

Arguments
None

Retrieve a security by id

Example responses

200 Response

{
  "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"
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/securities/{id}

Returns a single security based on an ID.

Arguments
id
REQUIRED
The unique resource id for the Security.

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.

The transaction resource

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

Example responses

200 Response

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

GET http://atlas.bridgeft.com/transactions/

Returns a list of transactions.

Arguments
None

Retrieve a transaction by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/transactions/{id}

Returns a single transaction based on an ID.

Arguments
id
REQUIRED
The unique resource id for the Transaction.

Households

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

The household resource

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

Example responses

200 Response

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

GET http://dev.bridgeft.com/households/

Returns a list of households.

Arguments
None

Retrieve a household by id

Example responses

200 Response

{
  "name": "Household: EBEUxxFcgeuK", 
  "close_date": None, 
  "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"
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://dev.bridgeft.com/households/{id}

Returns a single household based on an ID.

Arguments
id
REQUIRED
The unique resource id for the Household.

Accounts

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

The account resource

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

Example responses

200 Response

[
  {
    "name": "Account: uAQIRvhWMpeM", 
    "is_direct_billed": True, 
    "is_active": True, 
    "has_custodian_name": True, 
    "charge_unit_id": None, 
    "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": None, 
    "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": None, 
    "entity_id": "A-SN0000", 
    "is_closed": False, 
    "benchmark_ids": []
  }
]

GET http://dev.bridgeft.com/accounts/

Returns a list of accounts.

Arguments
None

Retrieve an account by id

Example responses

200 Response

{
  "entity_id": "A-SN0003", 
  "address_2": "", 
  "name": "Account: XqdVpqLTKXpg", 
  "is_direct_billed": True, 
  "is_tax_deferred": False, 
  "payment_source": "D", 
  "is_composite": None, 
  "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": None, 
  "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": None, 
  "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"
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://dev.bridgeft.com/accounts/{id}

Returns a single account based on an ID.

Arguments
id
REQUIRED
The unique resource id for the Account.

Update an account by id

Example responses

200 Response

{
  "billing_split_ids": [], 
  "country": "USA", 
  "close_date": None, 
  "managing_firm_id": 7, 
  "is_taxable": True, 
  "is_composite": None, 
  "status": "22", 
  "name": "Account: QLwuTaaPwGAu", 
  "opening_date": "2017-01-01", 
  "acct_type": "IRA", 
  "charge_unit_id": None, 
  "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"
}

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://dev.bridgeft.com/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
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
Optional
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
REQUIRED
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?

Bulk Update accounts

Example responses

200 Response

[
  {
    "billing_split_ids": [], 
    "country": "USA", 
    "close_date": None, 
    "managing_firm_id": 7, 
    "is_taxable": True, 
    "is_composite": None, 
    "status": "22", 
    "name": "Account: QLwuTaaPwGAu", 
    "opening_date": "2017-01-01", 
    "acct_type": "IRA", 
    "charge_unit_id": None, 
    "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"
  }
]

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://dev.bridgeft.com/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
Optional
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
REQUIRED
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?

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.

The billing minimum resource

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

Example responses

200 Response

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

GET http://atlas.bridgeft.com/billing-minimums/

Returns a list of billing minimums

Arguments
No arguments...

Retrieve a minimum by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/billing-minimums/{id}

Returns a billing minimum based on a single ID

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

Create a billing minimum

Example responses

201 Created Response

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

POST http://atlas.bridgeft.com/billing-minimums/

Returns the list of billings minimums that were created.

Arguments
id
Optional
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 valuetype of this Billing Minimum's value.
firm
Optional
The managing firm of this Billing Minimum.

Update a billing minimum

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/billing-minimums/{id}

Returns the list of billings minimums that were updated.

Arguments
id
Optional
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 valuetype of this Billing Minimum's value.
firm
Optional
The managing firm of this Billing Minimum.

Bulk Update billing minimums

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/billing-minimums/

Returns the list of billings minimums that were updated.

Arguments
id
Optional
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 valuetype of this Billing Minimum's value.
firm
Optional
The managing firm of this Billing Minimum.

Delete a billing minimum

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/billing-minimums/{id}

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

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

Bulk Delete billing minimums

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the Billing Minimums that you want to delete.

Billing Splits

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

The billing split resource

Attributes
id
Integer
The unique resource id for the Billing Split.
name
String
The name of the Billing Split, auto-genrated 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

Example responses

200 Response

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

GET http://atlas.bridgeft.com/billing-splits/

Returns a list of billing splits

Arguments
No arguments...

Retrieve a billing split by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/billing-splits/{id}

Returns a billing split based on a single ID

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

Create a billing split

Example responses

201 Created Response

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

POST http://atlas.bridgeft.com/billing-splits/

Returns the list of billings splits that were created.

Arguments
id
Optional
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 sluggified name of this Billing Split.
splitter_slug
REQUIRED
The sluggified name of this Billing Split.
percentage
REQUIRED
The percentage for this Billing Split.

Update a billing split

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/billing-splits/{id}

Returns the list of billings splits that were updated.

Arguments
id
Optional
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 sluggified name of this Billing Split.
splitter_slug
REQUIRED
The sluggified name of this Billing Split.
percentage
REQUIRED
The percentage for this Billing Split.

Bulk Update billing splits

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/billing-splits/

Returns the list of billings splits that were updated.

Arguments
id
Optional
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 sluggified name of this Billing Split.
splitter_slug
REQUIRED
The sluggified name of this Billing Split.
percentage
REQUIRED
The percentage for this Billing Split.

Delete a billing split

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/billing-splits/{id}

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

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

Bulk Delete billing splits

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the Billing Splits that you want to delete.

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.

The charge unit resource

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

Example responses

200 Response

[
  {
    "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": []
  }
]

GET http://atlas.bridgeft.com/charge-units

Returns a list of charge units

Arguments
No arguments...

Retrieve a charge unit by id

Example responses

200 Response

{
  "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": []
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/charge-units/{id}

Returns a charge unit based on a single ID

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

Create a charge unit

Example responses

201 Created Response

[
  {
    "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": []
  }
]

POST http://atlas.bridgeft.com/charge-units

Returns the list of charge units that were created.

Arguments
id
Optional
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.

Update a charge unit

Example responses

200 Response

{
  "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": []
}

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/charge-unit/{id}

Returns the charge unit that was updated.

Arguments
id
Optional
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.

Bulk Update charge units

Example responses

200 Response

[
  {
    "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": []
  }
]

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/charge-units

Returns the list of charge units that were updated.

Arguments (Note: A List of Charge Units must be passed in)
id
Optional
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.

Delete a charge unit

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/charge-units/{id}

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

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

Bulk Delete charge units

Example responses

202 Accepted Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the Charge Units that you want to delete.

Fee Upload Files

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

The fee upload file resource

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

Example responses

200 Response

[
  {
    "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
  }
]

GET http://atlas.bridgeft.com/fee-upload-files/

Returns a list of fee upload files

Arguments
No arguments...

Retrieve a fee upload file by id

Example responses

200 Response

{
  "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
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/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.

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.

The invoice resource

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

Example responses

200 Response

[
  {
    "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
  }
]

GET http://atlas.bridgeft.com/invoices/

Returns a list of invoices

Arguments
No arguments...

Retrieve an invoice by id

Example responses

200 Response

{
  "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
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/invoices/{id}

Returns an invoice based on a single ID

Arguments
id
REQUIRED
The unique resource id for the Invoice.

Account Groups

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

The account group resource

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

Example responses

200 Response

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

GET http://atlas.bridgeft.com/account-groups/

Returns a list of account groups

Arguments
No arguments...

Retrieve a group by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/account-groups/{id}

Returns an account group based on a single ID

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

Create an account group

Example responses

201 Created Response

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

POST http://atlas.bridgeft.com/account-groups/

Returns the list of account groups that were created.

Arguments
id
Optional
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
Optional
A list of AccountGroupAssignment objects associated with this Account Group.
minimums_list
REQUIRED
A list of billing minimum ids associated with this Account Group.

Update an account group

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/account-groups/{id}

Returns the list of account groups that were updated.

Arguments
id
Optional
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
Optional
A list of AccountGroupAssignment objects associated with this Account Group.
minimums_list
REQUIRED
A list of billing minimum ids associated with this Account Group.

Bulk Update account groups

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/account-groups/

Returns the list of account groups that were updated.

Arguments
id
Optional
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
Optional
A list of AccountGroupAssignment objects associated with this Account Group.
minimums_list
REQUIRED
A list of billing minimum ids associated with this Account Group.

Delete an account group

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/account-groups/{id}

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

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

Bulk Delete account groups

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the Account Groups that you want to delete.

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.

The asset adjustment resource

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

Example responses

200 Response

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

GET http://atlas.bridgeft.com/asset-adjustments/

Returns a list of asset-adjustments

Arguments
No arguments...

Retrieve an adjustment by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/asset-adjustments/{id}

Returns a asset adjustments based on a single ID

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

Create an asset adjustment

Example responses

201 Created Response

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

POST http://atlas.bridgeft.com/asset-adjustments/

Returns the list of asset adjustments that were created.

Arguments
id
Optional
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.

Update an asset adjustment

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/asset-adjustments/{id}

Returns the list of asset adjustments that were updated.

Arguments
id
Optional
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.

Bulk Update adjustments

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/asset-adjustments/

Returns the list of asset adjustments that were updated.

Arguments
id
Optional
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.

Delete an asset adjustment

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/asset-adjustments/{id}

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

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

Bulk Delete asset adjustments

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/asset-adjustments/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 Asset Adjustments that you want to delete.

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.

The billing report resource

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

Example responses

200 Response

[
  {
    "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
  } 
]

GET http://atlas.bridgeft.com/billing-reports/

Returns a list of billing reports

Arguments
No arguments...

Retrieve a report by id

Example responses

200 Response

{
  "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
} 

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/billing-reports/{id}

Returns a billing report based on a single ID

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

Delete a billing report

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/billing-reports/{id}

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

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

Bulk Delete billing reports

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the Billing Reports that you want to delete.

Aum

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

The aum resource

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

Example responses

200 Response

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

GET http://dev.bridgeft.com/aum/

Returns a list of aums

Arguments
No arguments...

Retrieve an aum by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://dev.bridgeft.com/aum/{id}

Returns an aum based on a single ID

Arguments
id
REQUIRED
The unique resource id for the AUM.

Sub Report Display Settings

Sub Report Display Settings resources describe how a Pdf Report should be presented.

The sub report display setting resource

Attributes
id
Integer
The unique resource id for this Sub Report Display Setting.
firm_id
Integer
The firm id of the managing firm.
component
String
The component for the Sub Report Display Setting.
user_id
Integer
The id of the associated user.
account_summary
Boolean
Whether to add the account summary or not.
performance_summary
Boolean
Whether to add the performance summary or not.
performance_chart
Boolean
Whether to add the performance chart or not.
appraisals
Boolean
Whether to add the appraisals section or not.
asset_allocation_top_holdings
Boolean
Whether to add the asset allocation top holdings or not.
buy_sells
Boolean
Whether to add the buy sells section or not.
deposits_withdrawals
Boolean
Whether to add the deposits withdrawals section or not.
income
Boolean
Whether to add the income section or not.
realized_gain_loss
Boolean
Whether to add the realized_gain_loss section or not.
management_fees
Boolean
Whether to add the management fees section or not.

List all display settings

Example responses

200 Response

[
  {
    "account_summary": false,
    "appraisals": false,
    "asset_allocation_top_holdings": false,
    "buy_sells": false,
    "component": "user",
    "deposits_withdrawals": false,
    "firm_id": 24,
    "id": 1,
    "income": false,
    "management_fees": false,
    "performance_chart": false,
    "performance_summary": false,
    "realized_gain_loss": false,
    "user_id": null
  }
]

GET http://atlas.bridgeft.com/sub-report-display-settings/

Returns a list of sub report display settings

Arguments
No arguments...

Retrieve a display setting by id

Example responses

200 Response

  {
    "account_summary": false,
    "appraisals": false,
    "asset_allocation_top_holdings": false,
    "buy_sells": false,
    "component": "user",
    "deposits_withdrawals": false,
    "firm_id": 24,
    "id": 1,
    "income": false,
    "management_fees": false,
    "performance_chart": false,
    "performance_summary": false,
    "realized_gain_loss": false,
    "user_id": null
  }

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/sub-report-display-settings/{id}

Returns a sub report display setting based on a single ID

Arguments
id
REQUIRED
The unique resource id for the Sub Report Display Setting.

Create a display setting

Example responses

201 Created Response

[
  {
    "account_summary": false,
    "appraisals": false,
    "asset_allocation_top_holdings": false,
    "buy_sells": false,
    "component": "user",
    "deposits_withdrawals": false,
    "firm_id": 24,
    "id": 1,
    "income": false,
    "management_fees": false,
    "performance_chart": false,
    "performance_summary": false,
    "realized_gain_loss": false,
    "user_id": null
  }
]

POST http://atlas.bridgeft.com/sub-report-display-settings/

Returns the list of sub report display settings that were created.

Arguments
id
Optional
The unique resource id for this Sub Report Display Setting.
firm_id
REQUIRED
The firm id of the managing firm.
component
REQUIRED
The component for the Sub Report Display Setting.
user_id
REQUIRED
The id of the associated user.
account_summary
REQUIRED
Whether to add the account summary or not.
performance_summary
REQUIRED
Whether to add the performance summary or not.
performance_chart
REQUIRED
Whether to add the performance chart or not.
appraisals
REQUIRED
Whether to add the appraisals section or not.
asset_allocation_top_holdings
REQUIRED
Whether to add the asset allocation top holdings or not.
buy_sells
REQUIRED
Whether to add the buy sells section or not.
deposits_withdrawals
REQUIRED
Whether to add the deposits withdrawals section or not.
income
REQUIRED
Whether to add the income section or not.
realized_gain_loss
REQUIRED
Whether to add the realized_gain_loss section or not.
management_fees
REQUIRED
Whether to add the management fees section or not.

Update a display setting

Example responses

200 Response

{
  "account_summary": false,
  "appraisals": false,
  "asset_allocation_top_holdings": false,
  "buy_sells": false,
  "component": "user",
  "deposits_withdrawals": false,
  "firm_id": 24,
  "id": 1,
  "income": false,
  "management_fees": false,
  "performance_chart": false,
  "performance_summary": false,
  "realized_gain_loss": false,
  "user_id": null
}

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/sub-report-display-settings/{id}

Returns the list of sub report display settings that were updated.

Arguments
id
Optional
The unique resource id for this Sub Report Display Setting.
firm_id
REQUIRED
The firm id of the managing firm.
component
REQUIRED
The component for the Sub Report Display Setting.
user_id
REQUIRED
The id of the associated user.
account_summary
REQUIRED
Whether to add the account summary or not.
performance_summary
REQUIRED
Whether to add the performance summary or not.
performance_chart
REQUIRED
Whether to add the performance chart or not.
appraisals
REQUIRED
Whether to add the appraisals section or not.
asset_allocation_top_holdings
REQUIRED
Whether to add the asset allocation top holdings or not.
buy_sells
REQUIRED
Whether to add the buy sells section or not.
deposits_withdrawals
REQUIRED
Whether to add the deposits withdrawals section or not.
income
REQUIRED
Whether to add the income section or not.
realized_gain_loss
REQUIRED
Whether to add the realized_gain_loss section or not.
management_fees
REQUIRED
Whether to add the management fees section or not.

Bulk Update display settings

Example responses

200 Response

[
  {
    "account_summary": false,
    "appraisals": false,
    "asset_allocation_top_holdings": false,
    "buy_sells": false,
    "component": "user",
    "deposits_withdrawals": false,
    "firm_id": 24,
    "id": 1,
    "income": false,
    "management_fees": false,
    "performance_chart": false,
    "performance_summary": false,
    "realized_gain_loss": false,
    "user_id": null
  }
]

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/sub-report-display-settings/

Returns the list of sub report display settings that were updated.

Arguments
id
Optional
The unique resource id for this Sub Report Display Setting.
firm_id
REQUIRED
The firm id of the managing firm.
component
REQUIRED
The component for the Sub Report Display Setting.
user_id
REQUIRED
The id of the associated user.
account_summary
REQUIRED
Whether to add the account summary or not.
performance_summary
REQUIRED
Whether to add the performance summary or not.
performance_chart
REQUIRED
Whether to add the performance chart or not.
appraisals
REQUIRED
Whether to add the appraisals section or not.
asset_allocation_top_holdings
REQUIRED
Whether to add the asset allocation top holdings or not.
buy_sells
REQUIRED
Whether to add the buy sells section or not.
deposits_withdrawals
REQUIRED
Whether to add the deposits withdrawals section or not.
income
REQUIRED
Whether to add the income section or not.
realized_gain_loss
REQUIRED
Whether to add the realized_gain_loss section or not.
management_fees
REQUIRED
Whether to add the management fees section or not.

Pdf Reports

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

The pdf report resource

Attributes
id
Integer
The unique resource id for this Sub Report Display Setting.
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

Example responses

200 Response

[
  {
    "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
  }
]

GET http://atlas.bridgeft.com/pdf-reports/

Returns a list of pdf reports

Arguments
No arguments...

Retrieve a pdf report by id

Example responses

200 Response

{
  "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
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/pdf-reports/{id}

Returns a pdf report based on a single ID

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

Create a pdf report

Example responses

201 Created Response

[
  {
    "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
  }
]

POST http://atlas.bridgeft.com/pdf-reports/

Returns the list of pdf reports that were created.

Arguments
id
Optional
The unique resource id for this Sub Report Display Setting.
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.

Delete a pdf report

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/pdf-reports/{id}

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

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

Bulk Delete pdf reports

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the PDF Reports that you want to delete.

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.

The background job resource

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 aums

Example responses

200 Response

[
  {
    "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"
  }
]

GET http://atlas.bridgeft.com/jobs/

Returns a list of background jobs

Arguments
No arguments...

Retrieve a job by id

Example responses

200 Response

{
  "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"
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/jobs/{id}

Returns a background job based on a single ID

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

Create a background job

Example responses

201 Created Response

[
  {
    "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"
  }
]

POST http://atlas.bridgeft.com/jobs/

Returns the list of background jobs that were created.

Arguments
id
Optional
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.

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.

The benchmark resource

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

Example responses

200 Response

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

GET http://atlas.bridgeft.com/benchmarks/

Returns a list of benchmarks

Arguments
No arguments...

Retrieve a benchmark by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/benchmarks/{id}

Returns a benchmark based on a single ID

Arguments
id
Optional
The unique resource id for this Benchmark.

Create a benchmark

Example responses

201 Created Response

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

POST http://atlas.bridgeft.com/benchmarks/

Returns the list of benchmarks that were created.

Arguments
id
Optional
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

Update a benchmark

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/benchmarks/{id}

Returns the list of benchmarks that were updated.

Arguments
id
Optional
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

Bulk Update benchmarks

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/benchmarks/

Returns the list of benchmarks that were updated.

Arguments
id
Optional
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

Delete a benchmark

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/benchmarks/{id}

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

Arguments
id
REQUIRED
The unique resource id for this Benchmark.

Bulk Delete benchmarks

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the Benchmarks that you want to delete.

Indexes

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

The index resource

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

Example responses

200 Response

[
  {
    "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)"
  }
]

GET http://dev.bridgeft.com/indexes/

Returns a list of indexes

Arguments
No arguments...

Retrieve an index by id

Example responses

200 Response

{
  "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)"
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://dev.bridgeft.com/indexes/{id}

Returns an index based on a single ID

Arguments
id
REQUIRED
The unique resource id for the Index.

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.

The user profile resource

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

Example responses

200 Response

[
  {
    "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"
  }
]

GET http://dev.bridgeft.com/user-profiles/

Returns a list of user-profiles

Arguments
No arguments...

Retrieve an user profile by id

Example responses

200 Response

{
  "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"
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://dev.bridgeft.com/user-profile/{id}

Returns an user profile based on a single ID

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

Create a user profile

Example responses

201 Created Response

[
  {
    "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"
  }
]

POST http://atlas.bridgeft.com/user-profiles/

Returns the list of user profiles that were created.

Arguments
id
Optional
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.

Update a user profile

Example responses

200 Response

{
  "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"
}

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/user-profiles/{id}

Returns the list of user profiles that were updated.

Arguments
id
Optional
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.

Bulk Update user profiles

Example responses

200 Response

[
  {
    "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"
  }
]

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/user-profiles/

Returns the list of user profiles that were updated.

Arguments
id
Optional
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.

Delete a user profile

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/user-profiles/{id}

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

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

Bulk Delete user profiles

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/user-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.

User Roles

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

The user role resource

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

Example responses

200 Response

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

GET http://dev.bridgeft.com/roles/

Returns a list of user roles

Arguments
No arguments...

Retrieve a user role by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://dev.bridgeft.com/roles/{id}

Returns a user role based on a single ID

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

Create a user role

Example responses

201 Created Response

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

POST http://atlas.bridgeft.com/roles/

Returns the list of user roles that were created.

Arguments
id
Optional
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.

Update a user role

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/roles/{id}

Returns the list of user roles that were updated.

Arguments
id
Optional
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.

Bulk Update user roles

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/roles/

Returns the list of user roles that were updated.

Arguments
id
Optional
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.

Delete a user role

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/roles/{id}

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

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

Bulk Delete user roles

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the User Roles that you want to delete.

Class Tags

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

The class tag resource

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

Example responses

200 Response

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

GET http://dev.bridgeft.com/class-tags/

Returns a list of aums

Arguments
No arguments...

Retrieve a class tag by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://dev.bridgeft.com/class-tags/{id}

Returns a class tag based on a single ID

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

Create a class tag

Example responses

201 Created Response

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

POST http://atlas.bridgeft.com/class-tags/

Returns the list of class tags that were created.

Arguments
id
Optional
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.

Update a class tag

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/class-tags/{id}

Returns the list of class tags that were updated.

Arguments
id
Optional
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.

Bulk Update class tags

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/class-tags/

Returns the list of class tags that were updated.

Arguments
id
Optional
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.

Delete a class tag

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/class-tags/{id}

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

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

Bulk Delete class tags

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the Class Tags that you want to delete.

Asset Classifications

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

The asset classification resource

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

Example responses

200 Response

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

GET http://dev.bridgeft.com/asset-classifications/

Returns a list of asset classifications

Arguments
No arguments...

Retrieve a asset classification by id

Example responses

200 Response

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

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://dev.bridgeft.com/asset-classifications/{id}

Returns an asset classification based on a single ID

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

Create an asset classification

Example responses

201 Created Response

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

POST http://atlas.bridgeft.com/asset-classifications/

Returns the list of asset classifications that were created.

Arguments
id
Optional
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.

Update an asset classification

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/asset-classifications/{id}

Returns the list of asset classifications that were updated.

Arguments
id
Optional
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.

Bulk Update asset classifications

Example responses

200 Response

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

400 Response

{
  "detail": ErrorDetail(string="Unknown data structure", code="parse_error")
}

PUT http://atlas.bridgeft.com/asset-classifications/

Returns the list of asset classifications that were updated.

Arguments
id
Optional
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.

Delete an asset classification

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/asset-classifications/{id}

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

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

Bulk Delete asset classifications

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/asset-classifications/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 Asset Classifications that you want to delete.

Invites

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

The invite resource

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

Example responses

200 Response

[
  {
    "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
  }
]

GET http://atlas.bridgeft.com/invites/

Returns a list of invites

Arguments
No arguments...

Retrieve an invite by id

Example responses

200 Response

{
  "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
}

404 Response

{
  "detail": ErrorDetail(string="Not found.", code="not_found")
}

GET http://atlas.bridgeft.com/invites/{id}

Returns an invite based on a single ID

Arguments
id
REQUIRED
The unique resource id for the Invite.

Create an invite.

Example responses

201 Created Response

[
  {
    "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
  }
]

POST http://atlas.bridgeft.com/invites/

Returns the list of invites that were created.

Arguments
id
Optional
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.

Delete an invite

Example responses

202 Accepted Response


DELETE http://atlas.bridgeft.com/invites/{id}

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

Arguments
id
REQUIRED
The unique resource id for the Invite.

Bulk Delete invites

Example responses

202 Response

[
  {
    "n": 0
  }
]

PUT http://atlas.bridgeft.com/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
The unique resource ids for the Invites that you want to delete.