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

​
created_at
string<date-time>
required

When the tag was created

​
updated_at
string<date-time>
required

When the tag was last updated

​
deleted_at
string<date-time> | null

When the tag was deleted