GET
/
v1
/
businesses
/
{business_id}
/
ledger
/
balances
curl https://sandbox.layerfi.com/v1/businesses/863ed926-e30d-40f4-8e7e-b0d5387ce4fb/ledger/balances \
  -H "Authorization: Bearer <access_token>"
{
    "data": {
        "type": "Ledger_Balances",
        "accounts": [
            {
                "id": "6ac7e685-4859-43a0-9f26-61e57c31f4ea",
                "name": "Expenses",
                "stable_name": "EXPENSES",
                "normality": "DEBIT",
                "account_type": {
                    "value": "EXPENSE",
                    "display_name": "Expenses"
                },
                "account_subtype": null,
                "balance": 11790985,
                "entries": [],
                "sub_accounts": [
                    {
                        "id": "ab16f453-6b0f-416d-bcc9-92edba3b6e0a",
                        "name": "Cost of Goods Sold",
                        "stable_name": "COGS",
                        "normality": "DEBIT",
                        "account_type": {
                            "value": "EXPENSE",
                            "display_name": "Expenses"
                        },
                        "account_subtype": {
                            "value": "COGS",
                            "display_name": "COGS"
                        },
                        "balance": 5156220,
                        "entries": [],
                        "sub_accounts": [
                        // Additional sub-accounts omitted for brevity
                        ]
                    },
                ]
            },
            {
                "id": "700a1b71-0b38-4d36-b46c-c0610f7849b5",
                "name": "Revenue",
                "stable_name": "REVENUE",
                "normality": "CREDIT",
                "account_type": {
                    "value": "REVENUE",
                    "display_name": "Revenue"
                },
                "account_subtype": null,
                "balance": 25570000,
                "entries": [],
                "sub_accounts": []
            },
            // Additional accounts omitted for brevity
        ]
    }
}

Path Parameters

business_id
string
required
ID of the Business the Ledger is associated with.

Query String Parameters

start_date
ISO8601 timestamp
Filter balances to include entries applied on or after the specified time. This filters the entry_at field of the ledger entries for each account.
end_date
ISO8601 timestamp
Filter balances to include entries on or before the specified time. This filters the entry_at field of the ledger entries for each account.
tag_key
string
Filter for entries with a specific tag key. Both tag_key and tag_values must be specified to filter by tags.
tag_values
string
Filter balances to include entries with specific tag values. Multiple values for a specific key can be specified, separated by commas. Both tag_key and tag_values must be specified to filter by tags.
customer_id
string
Filter balance to include entries associated with the customer specified by the given ID.
customer_external_id
string
Filter balances to include entries associated with the customer specified by the given external ID.
vendor_id
string
Filter balances to include entries associated with the vendor specified by the given ID.
vendor_external_id
string
Filter balances to include entries associated with the vendor specified by the given external ID.

Response

Returns an array of Ledger Account objects with their entries omitted.
curl https://sandbox.layerfi.com/v1/businesses/863ed926-e30d-40f4-8e7e-b0d5387ce4fb/ledger/balances \
  -H "Authorization: Bearer <access_token>"
{
    "data": {
        "type": "Ledger_Balances",
        "accounts": [
            {
                "id": "6ac7e685-4859-43a0-9f26-61e57c31f4ea",
                "name": "Expenses",
                "stable_name": "EXPENSES",
                "normality": "DEBIT",
                "account_type": {
                    "value": "EXPENSE",
                    "display_name": "Expenses"
                },
                "account_subtype": null,
                "balance": 11790985,
                "entries": [],
                "sub_accounts": [
                    {
                        "id": "ab16f453-6b0f-416d-bcc9-92edba3b6e0a",
                        "name": "Cost of Goods Sold",
                        "stable_name": "COGS",
                        "normality": "DEBIT",
                        "account_type": {
                            "value": "EXPENSE",
                            "display_name": "Expenses"
                        },
                        "account_subtype": {
                            "value": "COGS",
                            "display_name": "COGS"
                        },
                        "balance": 5156220,
                        "entries": [],
                        "sub_accounts": [
                        // Additional sub-accounts omitted for brevity
                        ]
                    },
                ]
            },
            {
                "id": "700a1b71-0b38-4d36-b46c-c0610f7849b5",
                "name": "Revenue",
                "stable_name": "REVENUE",
                "normality": "CREDIT",
                "account_type": {
                    "value": "REVENUE",
                    "display_name": "Revenue"
                },
                "account_subtype": null,
                "balance": 25570000,
                "entries": [],
                "sub_accounts": []
            },
            // Additional accounts omitted for brevity
        ]
    }
}