List custom journal entries

curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-journal-entries/ \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "<string>",
    "memo": "<string>",
    "entry_id": "<string>",
    "entry": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent": "SMS",
      "entry_type": "BANK",
      "date": "2023-11-07T05:31:56Z",
      "entry_at": "2023-11-07T05:31:56Z",
      "reversal_of_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reversal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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_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"
      }
    ],
    "external_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"
        }
      ]
    },
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "line_item_id": "<string>",
        "external_id": "<string>",
        "memo": "<string>",
        "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>"
  }
]

GET

businesses

{businessId}

custom-journal-entries

List custom journal entries

curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-journal-entries/ \
  --header 'Authorization: Bearer <token>'

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "<string>",
    "memo": "<string>",
    "entry_id": "<string>",
    "entry": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledger_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "agent": "SMS",
      "entry_type": "BANK",
      "date": "2023-11-07T05:31:56Z",
      "entry_at": "2023-11-07T05:31:56Z",
      "reversal_of_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reversal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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_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"
      }
    ],
    "external_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"
        }
      ]
    },
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "line_item_id": "<string>",
        "external_id": "<string>",
        "memo": "<string>",
        "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>"
  }
]

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<uuid>

required

The UUID of the business to fetch custom journal entries for

Query Parameters

created_at_start_date

string<date-time>

Filter entries by creation date. Entries created on or after this date will be included.

created_at_end_date

string<date-time>

Filter entries by creation date. Entries created on or before this date will be included.

entry_at_start_date

string<date-time>

Filter entries by entry date. Entries with an entry date on or after this date will be included.

entry_at_end_date

string<date-time>

Filter entries by entry date. Entries with an entry date on or before this date will be included.

include_reversed

boolean

default:false

Whether to include reversed entries in the results.

external_ids

string

Comma-separated list of external IDs to filter by.

reference_numbers

string

Comma-separated list of reference numbers to filter custom journal entries by. Only custom journal entries with reference numbers matching any value in this list will be returned.

memo

string

The exact memo text of the entries to fetch.

memo_contains

string

A case-insensitive substring used to filter entries whose memo contains the specified value.

is_matched

boolean

Filter custom journal entries by match status. If true, only matched entries will be returned. If false, only unmatched entries will be returned.

Response

200 - application/json

List of custom journal entries

string<uuid>

required

Unique identifier for the journal entry.

created_by

string

required

Identifier of the user or system that created the journal entry.

memo

string

required

Description or memo of the journal entry.

entry_id

string

required

ID of the ledger entry.

entry

object

required

The ledger entry associated with this journal entry.

Show child attributes

entry.id

string<uuid>

Unique identifier of the journal entry.

entry.business_id

string<uuid>

ID of the business associated with this journal entry

entry.ledger_id

string<uuid>

ID of the general ledger containing this journal entry.

entry.agent

enum<string>

Entity that created the journal entry.

Available options:

SMS,

API,

LAYER_AUTO,

LAYER_MANUAL

entry.entry_type

enum<string>

Type of entry.

Available options:

BANK,

MANUAL,

OPENING_BALANCE

entry.date

string<date-time>

Date the ledger entry was recorded at.

entry.entry_at

string<date-time>

Timestamp of the financial transaction associated with the line item.

entry.reversal_of_id

string<uuid> | null

ID of the ledger entry this is a reversal of

entry.reversal_id

string<uuid> | null

ID of the reversal object associated with this entry

entry.line_items

object[]

List of child line items associated with this entry

Show child attributes

entry.line_items.id

string<uuid>

Unique identifier of the ledger account line item.

entry.line_items.entry_id

string<uuid>

ID of the Journal entry the ledger account line item was part of.

entry.line_items.account

object

Simplified Ledger Account object containing this line item.

Show child attributes

entry.line_items.account.id

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

entry.line_items.account.id.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

entry.line_items.account.id.id

string<uuid>

ID of the account

entry.line_items.account.name

string

Name of the account

Example:

"Current Assets"

entry.line_items.account.account_number

string | null

Account number if configured

Example:

"4000"

entry.line_items.account.stable_name

object

Show child attributes

entry.line_items.account.stable_name.type

string

Resource type. Value will be StableName.

Example:

"StableName"

entry.line_items.account.stable_name.stable_name

string

Stable name of the account

Example:

"CURRENT_ASSETS"

entry.line_items.account.normality

enum<string>

Available options:

CREDIT,

DEBIT

entry.line_items.account.account_type

object

Show child attributes

entry.line_items.account.account_type.value

enum<string>

Type of the account

Available options:

ASSET,

LIABILITY,

EQUITY,

REVENUE,

COGS,

EXPENSE

entry.line_items.account.account_type.display_name

string

Display name of the account type

Example:

"Asset"

entry.line_items.account.account_subtype

object

Show child attributes

entry.line_items.account.account_subtype.value

enum<string>

Available options:

BANK_ACCOUNTS,

ACCOUNTS_RECEIVABLE,

INVENTORY,

PAYMENT_PROCESSOR_CLEARING_ACCOUNT,

FIXED_ASSET,

ACCUMULATED_DEPRECIATION,

CASH,

UNDEPOSITED_FUNDS,

CURRENT_ASSET,

NON_CURRENT_ASSET,

PREPAID_EXPENSES,

DEVELOPMENT_COSTS,

LOANS_RECEIVABLE,

INTANGIBLE_ASSET,

ACCOUNTS_PAYABLE,

CREDIT_CARD,

TAXES_PAYABLE,

INCOME_TAXES_PAYABLE,

SALES_TAXES_PAYABLE,

OTHER_TAXES_PAYABLE,

PAYROLL_TAXES_PAYABLE,

UNEARNED_REVENUE,

PAYROLL_LIABILITY,

PAYROLL_CLEARING,

LINE_OF_CREDIT,

TIPS,

REFUND_LIABILITIES,

UNDEPOSITED_OUTFLOWS,

OUTGOING_PAYMENT_CLEARING_ACCOUNT,

OTHER_CURRENT_LIABILITY,

LOANS_PAYABLE,

NOTES_PAYABLE,

SHAREHOLDER_LOAN,

NON_CURRENT_LIABILITY,

CONTRIBUTIONS,

DISTRIBUTIONS,

COMMON_STOCK,

PREFERRED_STOCK,

ADDITIONAL_PAID_IN_CAPITAL,

RETAINED_EARNINGS,

ACCUMULATED_ADJUSTMENTS,

OPENING_BALANCE_EQUITY,

OTHER_EQUITY,

SALES,

UNCATEGORIZED_REVENUE,

RETURNS_ALLOWANCES,

DIVIDEND_INCOME,

INTEREST_INCOME,

OTHER_INCOME,

COGS,

OPERATING_EXPENSES,

PAYROLL,

TAXES_LICENSES,

UNCATEGORIZED_EXPENSE,

CHARITABLE_CONTRIBUTIONS,

LOAN_EXPENSES,

FINANCE_COSTS,

INTEREST_EXPENSES,

DEPRECIATION,

AMORTIZATION,

BAD_DEBT,

OTHER_EXPENSES

entry.line_items.account.account_subtype.display_name

string

Display name of the account subtype

Example:

"Current Assets"

entry.line_items.amount

integer<int64>

Amount of the financial transaction associated with the line item

entry.line_items.direction

enum<string>

Direction of line item.

Available options:

CREDIT,

DEBIT

entry.line_items.entry_at

string<date-time>

Timestamp of the financial transaction associated with the line item.

entry.line_items.createdAt

string<date-time>

Timestamp when ledger entry was added to the ledger account.

transaction_tags

object[]

required

Tags associated with the journal entry.

Show child attributes

transaction_tags.id

string<uuid>

required

ID for the tag

transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

transaction_tags.value_display_name

string | null

Display name for the tag value definition

transaction_tags.archived_at

string<date-time> | null

When the tag was archived

external_id

string | null

External ID of the journal entry in your system.

customer

object

The customer associated with this journal entry, if any.

Show child attributes

customer.id

string<uuid>

Unique identifier for the customer.

customer.external_id

string

Unique ID of the customer in your system for linking purposes. Idempotency key.

Example:

"31415926535"

customer.individual_name

string | null

Full name of the individual customer or contact at a corporate customer.

customer.company_name

string | null

Name of the company customer.

customer.email

string | null

Email address of the customer.

customer.mobile_phone

string | null

Mobile phone number of the customer.

customer.office_phone

string | null

Office phone number of the customer.

customer.address_string

string | null

Address of the customer.

customer.memo

string | null

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

customer.status

string

Status of the customer. Possible values: ACTIVE, ARCHIVED.

Example:

"ACTIVE"

customer.transaction_tags

object[]

Show child attributes

customer.transaction_tags.id

string<uuid>

required

ID for the tag

customer.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

customer.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

customer.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

customer.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

customer.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

customer.transaction_tags.value_display_name

string | null

Display name for the tag value definition

customer.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

vendor

object

The vendor associated with this journal entry, if any.

Show child attributes

vendor.id

string<uuid>

Unique identifier for the vendor.

vendor.external_id

string

Unique ID of the vendor in your system for linking purposes. Idempotency key.

vendor.individual_name

string | null

Full name of the individual vendor or contact at a corporate vendor.

vendor.company_name

string | null

Name of the company vendor.

vendor.email

string | null

Email address of the vendor.

vendor.mobile_phone

string | null

Mobile phone number of the vendor.

vendor.office_phone

string | null

Office phone number of the vendor.

vendor.address_string

string | null

Address of the vendor.

vendor.memo

string | null

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

vendor.status

enum<string>

Status of the vendor.

Available options:

ACTIVE,

ARCHIVED

vendor.transaction_tags

object[]

Show child attributes

vendor.transaction_tags.id

string<uuid>

required

ID for the tag

vendor.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

vendor.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

vendor.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

vendor.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

vendor.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

vendor.transaction_tags.value_display_name

string | null

Display name for the tag value definition

vendor.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

line_items

object[]

Line items for the journal entry.

Show child attributes

line_items.id

string<uuid>

required

Unique identifier for the line item.

line_items.line_item_id

string

required

ID of the line item in the ledger.

line_items.external_id

string | null

External ID of the line item in your system.

line_items.memo

string | null

Optional memo for the line item.

line_items.transaction_tags

object[]

Tags associated with the line item.

Show child attributes

line_items.transaction_tags.id

string<uuid>

required

ID for the tag

line_items.transaction_tags.key

string

required

Key for the tag

Example:

"ExampleTagKey"

line_items.transaction_tags.value

string

required

Value for the tag

Example:

"ExampleTagValue"

line_items.transaction_tags.dimension_id

string<uuid>

required

ID of the tag dimension this tag belongs to

line_items.transaction_tags.definition_id

string<uuid>

required

ID of the tag value definition

line_items.transaction_tags.dimension_display_name

string | null

Display name for the tag dimension

line_items.transaction_tags.value_display_name

string | null

Display name for the tag value definition

line_items.transaction_tags.archived_at

string<date-time> | null

When the tag was archived

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 custom journal entry. Can be used to filter when listing custom journal entries.

Custom journal entry object Create custom journal entry

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

List custom journal entries

Authorizations

Headers

Path Parameters

Query Parameters

Response