{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-PublicAPI/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Transaction Tags V1 — Developer Guide","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"transaction-tags-v1--developer-guide","__idx":0},"children":["Transaction Tags V1 — Developer Guide"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://papidocs.hs1api.com/publicapi/api-financial-management/transactiontags-(v1)"},"children":["Transaction Tags (V1) Endpoint Documentation"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionTags"]}," field on ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/transactions-patientpayments-v1"},"children":["Patient Payments"]}," and ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/publicapi/endpoints/transactions-adjustments-v1"},"children":["Adjustment Transactions"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Two types of tags exist:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"tagType"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagType"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Used On"},"children":["Used On"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYMENT_TAG"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Patient payment transactions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADJUSTMENT_TAG"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Adjustment transactions (charge and credit)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--bulk-list-transaction-tags","__idx":1},"children":["GET — Bulk List Transaction Tags"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a paginated list of transaction tags filtered by the provided criteria."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["⚠️ Rate Limited:"]}," This endpoint is rate limited. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://papidocs.hs1api.com/publicapi/api-consumer-guide#rate-limiting"},"children":["rate limiting guide"]}," for details."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters","__idx":2},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Organization-ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The organization ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Filter criteria (see filter keys below). If omitted, a default date-limiting filter is applied automatically."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Comma-delimited list of fields to include, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Page number for pagination"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageSize"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Number of records per page"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lastId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Largest tag ID from the previous page, used for efficient pagination"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filter-keys","__idx":3},"children":["Filter Keys"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Filter Key"},"children":["Filter Key"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Operators"},"children":["Operators"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Example"},"children":["Example"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["->"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=id->[1000000020702,1000000020703]"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagText"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["~="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<>="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=tagText==Insurance"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?filter=tagType==PAYMENT_TAG"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"tagtext-operator-details","__idx":4},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagText"]}," Operator Details"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Operator"},"children":["Operator"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Behavior"},"children":["Behavior"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["=="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Exact match"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["!="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Not equal"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["~="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Starts with (prefix search)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<>="]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Contains (substring search)"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-requests","__idx":5},"children":["Example Requests"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch all payment tags:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/transactiontags?filter=tagType==PAYMENT_TAG\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Search for tags starting with \"Insurance\":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/transactiontags?filter=tagText~=Insurance\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetch specific tags by ID:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/transactiontags?filter=id->[1000000020702,1000000020703]\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get--transaction-tag-by-id","__idx":6},"children":["GET — Transaction Tag by ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a single transaction tag by its ID."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-1","__idx":7},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionTagId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["path"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The ID of the transaction tag"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Organization-ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The organization ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["query"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Comma-delimited list of fields to include, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ALL"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":8},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v1/transactiontags/1000000020702\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"post--create-transaction-tag","__idx":9},"children":["POST — Create Transaction Tag"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a new transaction tag. All three fields are required."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-1--post-create-a-payment-tag","__idx":10},"children":["Scenario 1 — POST: Create a Payment Tag"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this scenario to create a tag that can be attached to patient payment transactions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"required-fields","__idx":11},"children":["Required Fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagText"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The tag label. Min 1, max 30 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isPredefined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Whether this tag is a predefined system tag (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},") or a custom tag (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"PAYMENT_TAG\""]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-body","__idx":12},"children":["Example Request Body"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"tagText\": \"Online Payment\",\n  \"isPredefined\": false,\n  \"tagType\": \"PAYMENT_TAG\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"scenario-2--post-create-an-adjustment-tag","__idx":13},"children":["Scenario 2 — POST: Create an Adjustment Tag"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use this scenario to create a tag that can be attached to charge or credit adjustment transactions."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"required-fields-1","__idx":14},"children":["Required Fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagText"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The tag label. Min 1, max 30 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isPredefined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Whether this is a predefined tag."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Must be ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"ADJUSTMENT_TAG\""]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"example-request-body-1","__idx":15},"children":["Example Request Body"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"tagText\": \"Write-Off\",\n  \"isPredefined\": true,\n  \"tagType\": \"ADJUSTMENT_TAG\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delete--delete-transaction-tag","__idx":16},"children":["DELETE — Delete Transaction Tag"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deletes a specific transaction tag by ID."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," Deleting a tag that is currently referenced by transaction records may affect reporting and filtering by that tag."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"parameters-2","__idx":17},"children":["Parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"In"},"children":["In"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionTagId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["path"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The ID of the transaction tag to delete"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Organization-ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["header"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The organization ID"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request-1","__idx":18},"children":["Example Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /api/v1/transactiontags/1000000020702\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"streaming","__idx":19},"children":["Streaming"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Transaction tags are streamable via the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://papidocs.hs1api.com/publicapi/api-consumer-guide#streaming"},"children":["Streaming API"]},". Unlike transaction records (which use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransactionV1"]},"), transaction tags have their own dedicated domain type: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransactionTagV1"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"routing-key-format","__idx":20},"children":["Routing Key Format"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"organizationId.locationId.TransactionTagV1.operationType\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-routing-keys","__idx":21},"children":["Example Routing Keys"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Listen for all transaction tag events across all locations:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"66d22762060811049b50d085.*.TransactionTagV1.*\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Listen for creates only:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"66d22762060811049b50d085.*.TransactionTagV1.CREATE\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Listen for deletes only at a specific location:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"66d22762060811049b50d085.1000000000123.TransactionTagV1.DELETE\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"operations-emitted","__idx":22},"children":["Operations Emitted"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"When"},"children":["When"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CREATE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["When a new transaction tag is created (POST)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["UPDATE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["When a transaction tag is modified"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["When a transaction tag is deleted (DELETE)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-structure","__idx":23},"children":["Response Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A successful ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["201"]}," response returns:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The created, retrieved, or deleted tag"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warnings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Non-fatal warnings"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["array"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Field-level errors"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For bulk GET, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," is an array and includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["meta.pagination"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"data-object--transaction-tag-fields","__idx":24},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," Object — Transaction Tag Fields"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Read-Only"},"children":["Read-Only"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Unique tag ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagText"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Tag label (1–30 characters)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isPredefined"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Predefined system tag flag"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PAYMENT_TAG"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ADJUSTMENT_TAG"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"errors--warnings-reference","__idx":25},"children":["Errors & Warnings Reference"]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Status Code Errors"]}," — click to expand"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"400--bad-request","__idx":26},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," — Bad Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The request body or parameters are invalid. See field-level errors below."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"401--unauthorized","__idx":27},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}," — Unauthorized"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Authentication is required and has failed or has not been provided."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Provide a valid Bearer token in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"403--forbidden","__idx":28},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," — Forbidden"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The request is understood, but it has been refused or access is not allowed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Token lacks ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model:read"]}," (GET) or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["model:write"]}," (POST/DELETE) scope."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Request the appropriate scope for the operation."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"404--not-found","__idx":29},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]}," — Not Found"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The requested resource is either missing or does not exist."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["No transaction tag exists for the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionTagId"]}," within your organization."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Confirm the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["transactionTagId"]}," is correct and belongs to your organization."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"408--request-timeout","__idx":30},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["408"]}," — Request Timeout"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The server timed out while processing the request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retry the request."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"429--too-many-requests","__idx":31},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]}," — Too Many Requests"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Rate limit exceeded."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Implement exponential backoff. See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://papidocs.hs1api.com/publicapi/api-consumer-guide#rate-limiting"},"children":["rate limiting guide"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"500--internal-server-error","__idx":32},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["500"]}," — Internal Server Error"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["An unexpected error occurred."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Retry. If the issue persists, contact support."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"details","attributes":{"open":""},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Field-Level Validation Errors"]}," — click to collapse"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"tagtext","__idx":33},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagText"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error:"]}," Missing or invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagText"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagText"]}," was not provided, is empty, or exceeds 30 characters."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Provide a string between 1 and 30 characters."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"tagtype","__idx":34},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagType"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error:"]}," Invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagType"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tagType"]}," value is not one of the recognized enum values."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"PAYMENT_TAG\""]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"ADJUSTMENT_TAG\""]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"ispredefined","__idx":35},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isPredefined"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error:"]}," Missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isPredefined"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Why"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isPredefined"]}," field was not included in the request body."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fix"]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["isPredefined"]}," as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]}]}]}]}]}]},"headings":[{"value":"Transaction Tags V1 — Developer Guide","id":"transaction-tags-v1--developer-guide","depth":1},{"value":"GET — Bulk List Transaction Tags","id":"get--bulk-list-transaction-tags","depth":2},{"value":"Parameters","id":"parameters","depth":3},{"value":"Filter Keys","id":"filter-keys","depth":3},{"value":"tagText Operator Details","id":"tagtext-operator-details","depth":4},{"value":"Example Requests","id":"example-requests","depth":3},{"value":"GET — Transaction Tag by ID","id":"get--transaction-tag-by-id","depth":2},{"value":"Parameters","id":"parameters-1","depth":3},{"value":"Example Request","id":"example-request","depth":3},{"value":"POST — Create Transaction Tag","id":"post--create-transaction-tag","depth":2},{"value":"Scenario 1 — POST: Create a Payment Tag","id":"scenario-1--post-create-a-payment-tag","depth":3},{"value":"Required Fields","id":"required-fields","depth":4},{"value":"Example Request Body","id":"example-request-body","depth":4},{"value":"Scenario 2 — POST: Create an Adjustment Tag","id":"scenario-2--post-create-an-adjustment-tag","depth":3},{"value":"Required Fields","id":"required-fields-1","depth":4},{"value":"Example Request Body","id":"example-request-body-1","depth":4},{"value":"DELETE — Delete Transaction Tag","id":"delete--delete-transaction-tag","depth":2},{"value":"Parameters","id":"parameters-2","depth":3},{"value":"Example Request","id":"example-request-1","depth":3},{"value":"Streaming","id":"streaming","depth":2},{"value":"Routing Key Format","id":"routing-key-format","depth":3},{"value":"Example Routing Keys","id":"example-routing-keys","depth":3},{"value":"Operations Emitted","id":"operations-emitted","depth":3},{"value":"Response Structure","id":"response-structure","depth":2},{"value":"data Object — Transaction Tag Fields","id":"data-object--transaction-tag-fields","depth":3},{"value":"Errors & Warnings Reference","id":"errors--warnings-reference","depth":2},{"value":"400 — Bad Request","id":"400--bad-request","depth":4},{"value":"401 — Unauthorized","id":"401--unauthorized","depth":4},{"value":"403 — Forbidden","id":"403--forbidden","depth":4},{"value":"404 — Not Found","id":"404--not-found","depth":4},{"value":"408 — Request Timeout","id":"408--request-timeout","depth":4},{"value":"429 — Too Many Requests","id":"429--too-many-requests","depth":4},{"value":"500 — Internal Server Error","id":"500--internal-server-error","depth":4},{"value":"tagText","id":"tagtext","depth":3},{"value":"tagType","id":"tagtype","depth":3},{"value":"isPredefined","id":"ispredefined","depth":3}],"frontmatter":{"title":"TransactionTagsV1","toc":true,"description":"Guide to the Transaction Tags V1 endpoint — listing, creating, and deleting payment and adjustment tags used on transaction records","seo":{"title":"Transaction Tags V1 — Developer Guide"}},"lastModified":"2026-05-13T15:05:21.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/publicapi/endpoints/transactiontags-v1","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}