Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
tags
/
dimensions
/
key
/
{dimensionKey}
Get tag dimension by key
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/tags/dimensions/key/{dimensionKey} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "key": "<string>",
  "strictness": "BALANCING",
  "defined_values": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "<string>",
      "value": "<string>",
      "display_name": "<string>",
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "display_name": "<string>",
  "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.

Path Parameters

ā€‹
businessId
string<uuid>
required

The UUID of the business

ā€‹
dimensionKey
string
required

The key string of the tag dimension to fetch

Response

Tag dimension retrieved successfully

ā€‹
id
string<uuid>
required

Unique identifier for the tag dimension

ā€‹
key
string
required

The tag dimension key

ā€‹
strictness
enum<string>
required

Tag strictness level - BALANCING requires tags to be applied to whole journal entries that balance, NON_BALANCING has no such restriction and can therefore be applied to individual line items of entries, invoices, etc.

Available options:
BALANCING,
NON_BALANCING
ā€‹
defined_values
object[]
required

Predefined values for this tag dimension

ā€‹
created_at
string<date-time>
required
ā€‹
updated_at
string<date-time>
required
ā€‹
display_name
string | null

Display name for the tag dimension

ā€‹
deleted_at
string<date-time> | null