Create journal entry

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/ledger/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "example-external-id",
  "entry_at": "2023-11-07T05:31:56Z",
  "created_by": "jsmith",
  "memo": "Example debit/credit entry",
  "line_items": [
    {
      "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "amount": 123,
      "direction": "CREDIT",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_external_id": null,
      "tags": [
        {
          "key": "Location",
          "value": "MainStreet"
        }
      ]
    },
    {
      "account_identifier": {
        "type": "AccountId",
        "id": "db7fb036-5691-4354-a057-cba1836c042a"
      },
      "amount": 123,
      "direction": "DEBIT",
      "customer_id": null,
      "customer_external_id": null,
      "tags": []
    }
  ],
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_external_id": "customer-1",
  "tags": [
    {
      "key": "Location",
      "value": "MainStreet"
    }
  ]
}
'

{
  "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"
    }
  ]
}

POST

businesses

{businessId}

ledger

journal-entries

Create journal entry

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/ledger/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "example-external-id",
  "entry_at": "2023-11-07T05:31:56Z",
  "created_by": "jsmith",
  "memo": "Example debit/credit entry",
  "line_items": [
    {
      "account_identifier": {
        "type": "AccountId",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "amount": 123,
      "direction": "CREDIT",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_external_id": null,
      "tags": [
        {
          "key": "Location",
          "value": "MainStreet"
        }
      ]
    },
    {
      "account_identifier": {
        "type": "AccountId",
        "id": "db7fb036-5691-4354-a057-cba1836c042a"
      },
      "amount": 123,
      "direction": "DEBIT",
      "customer_id": null,
      "customer_external_id": null,
      "tags": []
    }
  ],
  "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer_external_id": "customer-1",
  "tags": [
    {
      "key": "Location",
      "value": "MainStreet"
    }
  ]
}
'

{
  "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"
    }
  ]
}

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 create the journal entry for

Body

application/json

entry_at

string<date-time>

required

The date and time when the entry should be recorded effective in the ledger, in ISO 8601 format.

created_by

string

required

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

memo

string

required

Description or memo of the manual entry.

line_items

object[]

required

Show child attributes

line_items.account_identifier

Account ID · object

ID of the account

Account ID
Account Stable Name

Show child attributes

line_items.account_identifier.type

string

Resource type. Value will be AccountId.

Example:

"AccountId"

line_items.account_identifier.id

string<uuid>

ID of the account

line_items.amount

integer<int64>

line_items.direction

enum<string>

Available options:

CREDIT,

DEBIT

line_items.customer_id

string<uuid>

Layer customer ID to associate with the ledger entry. Customer IDs can be specified on the entry or on individual line items, but not both.

line_items.customer_external_id

string

External ID of the Layer customer to associate with the ledger entry. Can be specified in place of the Layer customer ID. Customer IDs can be specified on the entry or on individual line items, but not both.

line_items.tags

object[]

Show child attributes

line_items.tags.key

string

required

The tag dimension key (e.g., "department", "project", "location")

Example:

"department"

line_items.tags.value

string

required

The tag value (e.g., "sales", "marketing", "engineering")

Example:

"sales"

line_items.tags.dimension_display_name

string | null

If the TagDimension doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagDimension.

Example:

"Department"

line_items.tags.value_display_name

string | null

If the TagValueDefinition doesn't exist, providing this value specifies the display name upon database insertion. Otherwise, it is left as null on the TagValueDefinition.

Example:

"Sales Department"

external_id

string

Unique ID of the ledger entry in your system. Idempotency key.

customer_id

string<uuid>

Layer customer ID to associate with the ledger entry. Customer IDs can be specified on the entry or on individual line items, but not both.

customer_external_id

string

Example:

"customer-1"

vendor_id

string<uuid>

Layer vendor ID to associate with the ledger entry. Vendor IDs can be specified on the entry or on individual line items, but not both.

vendor_external_id

string

External ID of the Layer vendor to associate with the ledger entry. Can be specified in place of the Layer vendor ID. Vendor IDs can be specified on the entry or on individual line items, but not both.

Example:

"vendor-1"

Response

string<uuid>

Universally unique identifier of the manual ledger entry

created_by

string

Name of the user who created the manual ledger entry

memo

string

Memo or description for the manual ledger entry

entry_id

string

ID of the associated ledger entry

customer

object

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

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

transaction_tags

object[]

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

⌘I

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Create journal entry

Authorizations

Headers

Path Parameters

Body

Response