URL Expired

The URL for this request expired after 30 days.

firmId

string

required

The firm ID for which to retrieve cash balances.

fundId

string

required

The fund ID for which to retrieve cash balances. Use a - (dash) to retrieve metrics for all funds.

asOfDateTime

date-time

The date and time as of which the data should be retrieved. Uses UTC and is specified in ISO 8601 format, i.e. 'YYYY-MM-DDThh:mm:ssZ'. If unspecified, defaults to the current date and time.

pageSize

int32

The maximum number of results to return. The service may return fewer than this value.

If unspecified, at most 25 items will be returned.

The maximum value is 50; values above 50 will be coerced to 50.

pageToken

string

A page token received as nextPageToken in a previous response. Provide this to retrieve the subsequent page.

When paginating, all other parameters must be kept consistent with those used in the request where the page token was obtained.

``200 A successful response.

object

Response message for listing cash balances.

cashBalances

array of objects

List of cash balances.

cashBalances

object

A single cash balance.

firmId

string

The firm ID to which this cash balance belongs.

fundId

string

The ID of the fund to which this cash balance belongs.

fundName

string

length ≤ 1000

The name of the fund.

accountId

string

The ID of the account to which this cash balance belongs.

institutionName

string

length ≤ 1000

The name of the institution the account belongs to.

accountType

string

enum

The account type.

accountNumber

string

length ≤ 1000

The account number.

settledBalance

object

The settled cash balance.

settledBalance object

pendingBalance

object

The pending cash balance.

pendingBalance object

outstandingLineOfCreditBalance

object

The outstanding line of credit balance.

outstandingLineOfCreditBalance object

nextPageToken

string

Token to retrieve the next page of results.

``400 Returned if required fields are omitted or if provided fields fail validation.

``401 Returned if a valid Authorization header has not been included with the request.

``403 Returned when the user does not have permission to access the resource.

``500 Returned if an unexpected internal server error is encountered.

``default An unexpected error response.

Updatedabout 2 months ago

API Usage Example

curl --request GET \

--url https://mock-api.carta.com/v1alpha1/investors/firms/firmId/funds/fundId/cashBalances \

--header 'accept: application/json'

{

"cashBalances": [

{

"firmId": "186fb573-a22d-4c82-8ad3-3186f9095a41",

"fundId": "4b6a4f7b-e79d-42d2-9dc9-d35fb0df6a07",

"fundName": "Krakatoa Ventures Fund IV, L.P.",

"accountId": "32ee2824-c93d-4d22-a5b9-5d0d5666b340",

"institutionName": "Silicon Valley Bank",

"accountType": "ACCOUNT_TYPE_BANK",

"accountNumber": "182745361099",

"settledBalance": {

"currency_code": "USD",

"amount": {

"value": "8000.00"

}

},

"pendingBalance": {

"currency_code": "USD",

"amount": {

"value": "1000.00"

}

},

"outstandingLineOfCreditBalance": {

"currency_code": "USD",

"amount": {

"value": "5000.00"

}

}

}

],

"nextPageToken": "ODMxMw=="

}

Updatedabout 2 months ago