Tag manual entries

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/ledger/manual-entries/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key_values": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "transaction_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

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

manual-entries

tags

Tag manual entries

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/ledger/manual-entries/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key_values": [
    {
      "key": "department",
      "value": "sales",
      "dimension_display_name": "Department",
      "value_display_name": "Sales Department"
    }
  ],
  "transaction_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

{
  "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 tag entries for

Body

application/json

key_values

object[]

List of key-value pairs used to create new tags

Show child attributes

key_values.key

string

required

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

Example:

"department"

key_values.value

string

required

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

Example:

"sales"

key_values.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"

key_values.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"

transaction_ids

string<uuid>[]

The transaction IDs to create each new tag for.

Response

Contains a collection of tags as defined by the ApiTag schema. This structure is used to encapsulate multiple tags in API responses or requests.

Businesses

Financial Activity

Accounting Reports

Platform Configuration

Activity Metrics

Quickbooks

Tag manual entries

Authorizations

Headers

Path Parameters

Body

Response