Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
invoices
/
payments
/
{paymentId}
/
allocations
/
{allocationId}
/
tags
Fetch payment allocation tags
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/invoices/payments/{paymentId}/allocations/{allocationId}/tags \
  --header 'Authorization: Bearer <token>'
[
  {
    "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"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs-beta.layerfi.com/llms.txt

Use this file to discover all available pages before exploring further.

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 the payment allocation belongs to

ā€‹
paymentId
string
required

The UUID of the invoice payment to fetch tags for

ā€‹
allocationId
string
required

The UUID of the invoice payment allocation to fetch tags for

Response

ā€‹
id
string<uuid>
required

ID for the tag

ā€‹
key
string
required

Key for the tag

Example:

"ExampleTagKey"

ā€‹
value
string
required

Value for the tag

Example:

"ExampleTagValue"

ā€‹
dimension_id
string<uuid>
required

ID of the tag dimension this tag belongs to

ā€‹
definition_id
string<uuid>
required

ID of the tag value definition

ā€‹
dimension_display_name
string | null

Display name for the tag dimension

ā€‹
value_display_name
string | null

Display name for the tag value definition

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

When the tag was archived