Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
external-accounts
/
{externalAccountId}
/
opening-balance
Fetch opening balance
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/external-accounts/{externalAccountId}/opening-balance \
  --header 'Authorization: Bearer <token>'
{
  "external_account_external_id": "0Br385JmgbTryJn8nEBnUb4A5ydv06U9Vbqqq",
  "external_account_source": "UNIT",
  "balance": 432100,
  "effective_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "ExampleTagKey",
      "value": "ExampleTagValue",
      "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dimension_display_name": "<string>",
      "value_display_name": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "memo": "<string>",
  "metadata": {
    "custom_field": "value",
    "any valid json": "below 1kb",
    "nested": {
      "meaning of life": 42,
      "array": []
    }
  },
  "reference_number": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.layerfi.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Content-Type
string

Content-Type must be set to application/json.

Path Parameters

​
businessId
string
required

The UUID of the business to fetch opening balance for.

​
externalAccountId
string
required

The UUID of the external account to fetch opening balance for.

Response

​
external_account_external_id
string

Unique ID of the external account in an external system for linking and idempotency.

Example:

"0Br385JmgbTryJn8nEBnUb4A5ydv06U9Vbqqq"

​
external_account_source
enum<string>

Source of the external account.

Available options:
UNIT,
PLAID,
API,
STRIPE,
CUSTOM
​
balance
integer

Opening balance of the account, in cents.

Example:

432100

​
effective_at
string<date-time>

Timestamp for when the account had this balance.

​
created_at
string<date-time>

When the opening balance timestamp was created.

​
updated_at
string<date-time>

When the opening balance timestamp was updated.

​
transaction_tags
object[]

Tags associated with the opening balance.

​
memo
string | null

Memo for any text you would like to associate with the opening balance (for example, to display to end users).

​
metadata
object

Arbitrary custom metadata in JSON format with a size limit of 1KB.

Example:
{
  "custom_field": "value",
  "any valid json": "below 1kb",
  "nested": { "meaning of life": 42, "array": [] }
}
​
reference_number
string | null

Any (typically user-visible) identifier you would like to associate with the opening balance.