Transaction Tags V1 — Developer Guide

Reference: Transaction Tags (V1) Endpoint Documentation

Transaction tags are short text labels that can be attached to payment and adjustment transactions for categorization and reporting purposes. Tags are referenced by their ID when linking them to a transaction via the transactionTags field on Patient Payments and Adjustment Transactions.

Two types of tags exist:

Returns a paginated list of transaction tags filtered by the provided criteria.

⚠️ Rate Limited: This endpoint is rate limited. See the rate limiting guide for details.

Fetch all payment tags:

GET /api/v1/transactiontags?filter=tagType==PAYMENT_TAG

Search for tags starting with "Insurance":

GET /api/v1/transactiontags?filter=tagText~=Insurance

Fetch specific tags by ID:

GET /api/v1/transactiontags?filter=id->[1000000020702,1000000020703]

Returns a single transaction tag by its ID.

GET /api/v1/transactiontags/1000000020702

Creates a new transaction tag. All three fields are required.

Use this scenario to create a tag that can be attached to patient payment transactions.

{
  "tagText": "Online Payment",
  "isPredefined": false,
  "tagType": "PAYMENT_TAG"
}

Use this scenario to create a tag that can be attached to charge or credit adjustment transactions.

{
  "tagText": "Write-Off",
  "isPredefined": true,
  "tagType": "ADJUSTMENT_TAG"
}

Deletes a specific transaction tag by ID.

Note: Deleting a tag that is currently referenced by transaction records may affect reporting and filtering by that tag.

DELETE /api/v1/transactiontags/1000000020702

Transaction tags are streamable via the Streaming API. Unlike transaction records (which use TransactionV1), transaction tags have their own dedicated domain type: TransactionTagV1.

organizationId.locationId.TransactionTagV1.operationType

Listen for all transaction tag events across all locations:

66d22762060811049b50d085.*.TransactionTagV1.*

Listen for creates only:

66d22762060811049b50d085.*.TransactionTagV1.CREATE

Listen for deletes only at a specific location:

66d22762060811049b50d085.1000000000123.TransactionTagV1.DELETE

A successful 200/201 response returns:

For bulk GET, data is an array and includes meta.pagination.