GET
/
v1
/
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",
    "external_id": "<string>",
    "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",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_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",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "deleted_at": "2023-11-07T05:31:56Z"
        }
      ]
    },
    "line_items": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "external_id": "<string>",
        "memo": "<string>",
        "line_item_id": "<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",
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z",
            "deleted_at": "2023-11-07T05:31:56Z"
          }
        ]
      }
    ],
    "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",
            "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",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "metadata": {
      "custom_field": "value",
      "any valid json": "below 10kb",
      "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

​
id
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.

​
transaction_tags
object[]
required

Tags associated with the journal entry.

​
external_id
string | null

External ID of the journal entry in your system.

​
customer
object

The customer associated with this journal entry, if any.

​
vendor
object

The vendor associated with this journal entry, if any.

​
line_items
object[]

Line items for the journal entry.

​
metadata
object

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

Example:
{
  "custom_field": "value",
  "any valid json": "below 10kb",
  "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.