GET
/
v1
/
businesses
/
{businessId}
/
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>",
      "notes": "<string>",
      "status": "ACTIVE",
      "transaction_tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "ExampleTagKey",
          "value": "ExampleTagValue",
          "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>",
      "notes": "<string>",
      "status": "ACTIVE",
      "transaction_tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "key": "ExampleTagKey",
          "value": "ExampleTagValue",
          "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>"
      }
    ],
    "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": "CURRENT",
              "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",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
]

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 custom journal entries for

Query Parameters

created_at_start_date
string

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

created_at_end_date
string

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

entry_at_start_date
string

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

entry_at_end_date
string

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.

Response

200 - application/json
List of custom journal entries
id
string
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.