Funds

A Fund is a representation of an investment vehicle. It contains the details of the legal entity, as well as information regarding the Fund offering.

This is a description of the Fund object:

Field	Data Type	Description
id	UUID	This is the Fund's Flow ID.
bank.account_name	String	The Fund's bank account name.
bank.account_number	String	The Fund's bank account number.
bank.additional_instructions	String	Any additional instructions related to wiring into the Fund.
bank.name	String	The name of the Fund's bank.
bank.routing_number	String	The routing number/ABA for the Fund's bank account.
bank.swift_code	String	The SWIFT code for the Fund's bank account.
calculation_method	String	The capital call method used by the Fund. Contribution = the Fund will only call investors’ commitment amounts. Gross = the Fund will call investors’ commitment amounts plus their management fees. Investment = the Fund will call investors’ commitment amounts, management fees, and pro rata portion of the Fund’s expense reserve.
capital_due_date	String	The date that capital is due from investors.
carry_percent	String	The percent of carry charged by the Fund.
created_at	String	When this Fund was created.
deal_description	String	Any additional information regarding the Fund that will be shared with investors.
expense_reserve	String	The amount reserved by the Fund to cover Fund expenses.
investor_count	Integer	Total amount of investors invited to this Fund.
legal_entity.display_name	String	Display name for the fund.
legal_entity.legal_name	String	Legal entity name for this Fund.
legal_entity.formation_date	String	The date on which the Fund was legally formed.
legal_entity.formation_state	String	The state in which the Fund was formed.
legal_entity.tax_id	String	The Fund's tax ID.
legal_entity.tax_id_type	String	The tax ID type (e.g. EIN).
legal_entity.type	String	The legal structure of the entity (e.g. LLC, partnership, corporation).
management_fee_percent	Integer	The percentage of management fee charged by the Fund.
minimum_investment	String	Minimum investment amount per investor for the Fund.
organization_name	String	This name of the organization under which the Fund is stored in Flow.
portfolio_company_legal_name	String	The full legal name of the company that the Fund is investing in (for single asset Funds).
round_type	String	The portfolio company round being invested in (e.g. Seed, Series A, etc.).
security_type	String	The security type being purchased by the Fund (e.g. Stock, Convertible Note, etc.).
sign_by_date	String	The date by which investors are asked to complete signing of their subscription documents.
target_size	String	The target size for the Fund.
total_contributed	String	How much money has been contributed by investors to the Fund.
total_commitments	String	Total investor commitments in the Fund.
total_received	String	The total amount of investor money received by the Fund.

Get All Funds

Get All Funds associated to your token.

GET https://api.flowinc.app/customerapi/funds

This endpoint retrieves all Funds you have access to.

200

[
    {
        "id": "843703d4-ff7b-4f52-816e-e79ceee1c1c8",
        "bank": {
            "account_name": "Jack Hill",
            "account_number": "08604847",
            "additional_instructions": "Instructions.",
            "name": "Bank Name",
            "routing_number": "147299826",
            "swift_code": "AAAABB11222"
        },
        "calculation_method": "contribution",
        "capital_due_date": "2021-09-24T21:46:45.271Z",
        "carry_percent": "2.0",
        "created_at": "2022-07-12T23:51:44.777Z",
        "deal_description": "Description.",
        "expense_reserve": "0.0",
        "legal_entity": {
            "display_name": "Partnership, LP",
            "formation_date": "2022-07-12T23:51:44.777Z",
            "formation_state": "2022-07-12T23:51:44.777Z",
            "legal_name": "Partnership, LP",
            "tax_id": "555-55-5555",
            "tax_id_type": "ssn",
            "type": "Limited partnership"
        },
        "investor_count": 0,
        "management_fee_percent": "2.0",
        "minimum_investment": "0.0",
        "organization_name": "Organization Name",
        "portfolio_company_legal_name": "Company Name, LLC",
        "round_type": "Seed",
        "security_type": "preferred",
        "sign_by_date": "2022-07-12T23:51:44.777Z",
        "target_size": "0.0",
        "total_commitments": "0.0",
        "total_contributed": "0.0",
        "total_received": "0.0"
    },
    [...]
]

401: Unauthorized

{
    "error": "Bad token"
}

curl

curl "https://api.flowinc.app/customerapi/funds" \
  -H "Authorization: bearer YOUR_JWT"

Ruby

require 'json'
require 'net/http'

uri = URI('https://api.flowinc.app/customerapi/funds')
params = Net::HTTP::Get.new(uri)
jwt = 'YOUR_JWT'
params['Authorization'] = "Bearer #{jwt}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(params) }
puts JSON.parse(response.body)

Js

const url = 'https://api.flowinc.app/customerapi/funds'

fetch(url, {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${YOUR_JWT}`,
      "Content-Type": "application/json"
    }
})
.then(response => {
    return response.json();
})

Good to know: Remember your Fund numbers will change along with investor data.

Get Single Fund

Get a single Fund from your token.

GET https://api.flowinc.app/customerapi/funds/FUND_ID

This endpoint retrieves a single Fund you have access to.

200: OK

{
    "id": "843703d4-ff7b-4f52-816e-e79ceee1c1c8",
    "bank": {
        "account_name": "Jack Hill",
        "account_number": "08604847",
        "additional_instructions": "Instructions.",
        "name": "Bank Name",
        "routing_number": "147299826",
        "swift_code": "AAAABB11222"
    },
    "calculation_method": "contribution",
    "capital_due_date": "2021-09-24T21:46:45.271Z",
    "carry_percent": "2.0",
    "created_at": "2022-07-12T23:51:44.777Z",
    "deal_description": "Description.",
    "expense_reserve": "0.0",
    "legal_entity": {
        "display_name": "Partnership, LP",
        "formation_date": "2022-07-12T23:51:44.777Z",
        "formation_state": "2022-07-12T23:51:44.777Z",
        "legal_name": "Partnership, LP",
        "tax_id": "555-55-5555",
        "tax_id_type": "ssn",
        "type": "Limited partnership"
    },
    "investor_count": 0,
    "management_fee_percent": "2.0",
    "minimum_investment": "0.0",
    "organization_name": "Organization Name",
    "portfolio_company_legal_name": "Company Name, LLC",
    "round_type": "Seed",
    "security_type": "preferred",
    "sign_by_date": "2022-07-12T23:51:44.777Z",
    "target_size": "0.0",
    "total_commitments": "0.0",
    "total_contributed": "0.0",
    "total_received": "0.0"
}

401: Unauthorized

{
    "error": "Bad token"
}

404: Not Found

{
    "error": "Fund not available"
}

You must replace FUND_ID with the Fund's ID you're trying to access.

curl

curl "https://api.flowinc.app/customerapi/funds/FUND_ID" \
  -H "Authorization: bearer YOUR_JWT"

Ruby

require 'json'
require 'net/http'

uri = URI('https://api.flowinc.app/customerapi/funds/FUND_ID')
params = Net::HTTP::Get.new(uri)
jwt = 'YOUR_JWT'
params['Authorization'] = "Bearer #{jwt}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(params) }
puts JSON.parse(response.body)

Js

const url = 'https://api.flowinc.app/customerapi/funds/FUND_ID'

fetch(url, {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${YOUR_JWT}`,
      "Content-Type": "application/json"
    }
})
.then(response => {
    return response.json();
})