Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
ledger
/
entries
List ledger entries
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/ledger/entries \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ledger_id": "<string>",
    "agent": "SMS",
    "entry_type": "BANK",
    "date": "2023-11-07T05:31:56Z",
    "entry_at": "2023-11-07T05:31:56Z",
    "reversal_of_id": "<string>",
    "reversal_id": "<string>",
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "account": {
          "id": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "name": "Current Assets",
          "account_number": "4000",
          "stable_name": {
            "type": "StableName",
            "stable_name": "CURRENT_ASSETS"
          },
          "normality": "CREDIT",
          "account_type": {
            "value": "ASSET",
            "display_name": "Asset"
          },
          "account_subtype": {
            "value": "BANK_ACCOUNTS",
            "display_name": "Current Assets"
          }
        },
        "amount": 123,
        "direction": "CREDIT",
        "entry_at": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "transaction": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source": "UNIT",
      "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
      "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
      "imported_at": "2023-11-07T05:31:56Z",
      "date": "2023-11-07T05:31:56Z",
      "direction": "CREDIT",
      "amount": 123,
      "counterparty_name": "WeWork",
      "description": "WeWork monthly rent payment",
      "account_name": "Plaid Checking",
      "categorizationStatus": "PENDING",
      "category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "category": "RENT",
        "display_name": "Rent",
        "stable_name": "RENT"
      },
      "categorization_method": "SMS",
      "projected_income_category": "REVENUE",
      "suggested_matches": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "matchType": "TRANSFER",
          "details": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "amount": 123,
            "date": "2023-11-07T05:31:56Z",
            "description": "Transfer from SavingsAccount to CheckingAccount"
          }
        }
      ],
      "match": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "match_type": "TRANSFER",
        "bank_transaction": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "date": "2023-11-07T05:31:56Z",
          "amount": 123,
          "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "source": "UNIT",
          "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
          "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
          "imported_at": "2023-11-07T05:31:56Z",
          "direction": "CREDIT",
          "counterparty_name": "WeWork",
          "description": "WeWork monthly rent payment",
          "account_name": "Plaid Checking",
          "categorizationStatus": "PENDING",
          "memo": "<string>",
          "metadata": {
            "custom_field": "value",
            "any valid json": "below 1kb",
            "nested": {
              "meaning of life": 42,
              "array": []
            }
          },
          "reference_number": "<string>"
        },
        "details": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "amount": 123,
          "date": "2023-11-07T05:31:56Z",
          "description": "Transfer from SavingsAccount to CheckingAccount"
        }
      },
      "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>"
    },
    "invoice": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "Invoice",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "1",
      "status": "SENT",
      "sent_at": "2023-11-07T05:31:56Z",
      "due_at": "2023-11-07T05:31:56Z",
      "paid_at": "2023-11-07T05:31:56Z",
      "voided_at": "2023-11-07T05:31:56Z",
      "line_items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "external_id": "<string>",
          "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "account_identifier": {
            "type": "AccountId",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "ledger_account": {
            "id": {
              "type": "AccountId",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "name": "Current Assets",
            "account_number": "4000",
            "stable_name": {
              "type": "StableName",
              "stable_name": "CURRENT_ASSETS"
            },
            "normality": "CREDIT",
            "account_type": {
              "value": "ASSET",
              "display_name": "Asset"
            },
            "account_subtype": {
              "value": "BANK_ACCOUNTS",
              "display_name": "Current Assets"
            }
          },
          "prepayment_account": {
            "id": {
              "type": "AccountId",
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
            },
            "name": "Current Assets",
            "account_number": "4000",
            "stable_name": {
              "type": "StableName",
              "stable_name": "CURRENT_ASSETS"
            },
            "normality": "CREDIT",
            "account_type": {
              "value": "ASSET",
              "display_name": "Asset"
            },
            "account_subtype": {
              "value": "BANK_ACCOUNTS",
              "display_name": "Current Assets"
            }
          },
          "description": "Widget sale",
          "product": "Widget",
          "unit_price": 123,
          "quantity": 123,
          "subtotal": 123,
          "discount_amount": 123,
          "sales_taxes_total": 123,
          "sales_taxes": [
            {
              "tax_account": {
                "name": "CALIFORNIA_VAT",
                "type": "Tax_Name"
              },
              "tax_ledger_account": {
                "id": "c4007474-f604-4d57-9690-b7f40f7a1cee",
                "name": "Sales tax: CALIFORNIA",
                "stable_name": "SALES_TAXES_PAYABLE:CALIFORNIA",
                "normality": "CREDIT",
                "account_type": {
                  "value": "LIABILITY",
                  "display_name": "Liabilities"
                },
                "account_subtype": {
                  "value": "SALES_TAXES_PAYABLE",
                  "display_name": "Sales Taxes Payable"
                }
              },
              "amount": 123
            }
          ],
          "total_amount": 123,
          "refund_allocations": [],
          "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"
            }
          ]
        }
      ],
      "subtotal": 123,
      "additional_discount": 123,
      "additional_sales_taxes_total": 123,
      "additional_sales_taxes": [
        {
          "tax_account": {
            "name": "CALIFORNIA_VAT",
            "type": "Tax_Name"
          },
          "tax_ledger_account": {
            "id": "c4007474-f604-4d57-9690-b7f40f7a1cee",
            "name": "Sales tax: CALIFORNIA",
            "stable_name": "SALES_TAXES_PAYABLE:CALIFORNIA",
            "normality": "CREDIT",
            "account_type": {
              "value": "LIABILITY",
              "display_name": "Liabilities"
            },
            "account_subtype": {
              "value": "SALES_TAXES_PAYABLE",
              "display_name": "Sales Taxes Payable"
            }
          },
          "amount": 123
        }
      ],
      "tips": 123,
      "total_amount": 123,
      "outstanding_balance": 123,
      "memo": "<string>",
      "payment_allocations": [],
      "refund_allocations": [],
      "imported_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"
        }
      ],
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    },
    "manual_entry": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_by": "<string>",
      "memo": "<string>",
      "entry_id": "<string>",
      "customer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "31415926535",
        "individual_name": "<string>",
        "company_name": "<string>",
        "email": "<string>",
        "mobile_phone": "<string>",
        "office_phone": "<string>",
        "address_string": "<string>",
        "memo": "<string>",
        "status": "ACTIVE",
        "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"
          }
        ]
      },
      "vendor": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "individual_name": "<string>",
        "company_name": "<string>",
        "email": "<string>",
        "mobile_phone": "<string>",
        "office_phone": "<string>",
        "address_string": "<string>",
        "memo": "<string>",
        "status": "ACTIVE",
        "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"
          }
        ]
      },
      "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"
        }
      ]
    },
    "source": {
      "transaction_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "external_id": "<string>",
      "account_name": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "amount": 123,
      "direction": "CREDIT",
      "counterparty": "<string>",
      "entity_name": "Bank Transaction",
      "display_description": "Generated display description based on account name and date"
    }
  }
]

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.

Query Parameters

​
start_date
string<date-time>

Start date for entries (inclusive).

​
end_date
string<date-time>

End date for entries (exclusive).

​
reporting_basis
enum<string>
default:ACCRUAL

Reporting basis for the entries (ACCRUAL or CASH).

Available options:
ACCRUAL,
CASH
​
customer_id
string<uuid>

Filter entries by customer UUID.

​
customer_external_id
string

Filter entries by customer external ID.

​
vendor_id
string<uuid>

Filter entries by vendor UUID.

​
vendor_external_id
string

Filter entries by vendor external ID.

​
include_entries_before_activation
boolean
default:false

Include entries before business activation date.

Response

List of ledger entries.

​
id
string

Unique identifier of the ledger entry.

​
business_id
string<uuid>
​
ledger_id
string
​
agent
enum<string>
Available options:
SMS,
API,
LAYER_AUTO,
LAYER_MANUAL
​
entry_type
enum<string>
Available options:
BANK,
MANUAL,
OPENING_BALANCE
​
date
string<date-time>
​
entry_at
string<date-time>
​
reversal_of_id
string | null
​
reversal_id
string | null
​
line_items
object[]
​
transaction
object
​
invoice
object
​
manual_entry
object
​
source
object