---
title: "Get transaction rule"
method: GET
path: "/v6/banks/transactions/rules/{id}"
tags: ["Transaction Rules"]
---

# Get transaction rule

`GET /v6/banks/transactions/rules/{id}`

Get a transaction rule for the given id

## Path parameters

- `id` string, required

## Response `200`

Success

- SuccessResponseTransactionRuleGetDto
  - `result` 'SUCCESS' | 'FAILURE' — The result of the action performed.
  - `data` TransactionRuleGetDto — The data generated by the action performed.
    - `id` string, required — Id of the transaction rule
    - `status` 'ACTIVE' | 'INACTIVE' | 'REMOVED', required — Status of the transaction rule
    - `filter` TransactionRuleFilterDto, nullable, required — Filter criteria defining which transactions this rule matches
      - `description` DescriptionCondition — Filter by transaction description
        - `equal` string — Exact match on transaction description
        - `contain` string — Contains match on transaction description
      - `amount` AmountCondition — Filter by transaction amount
        - `equal` integer — Exact amount match
        - `greaterThan` integer — Amount greater than
        - `greaterThanEqual` integer — Amount greater than or equal
        - `lessThan` integer — Amount less than
        - `lessThanEqual` integer — Amount less than or equal
      - `vendor` VendorCondition — Filter by vendor
        - `id` IdCondition — Filter by template GL account id
          - `equal` string — Exact match on template GL account id
      - `glAccount` GlAccountCondition — Filter by GL account
        - `id` IdCondition — Filter by template GL account id
          - `equal` string — Exact match on template GL account id
      - `bankAccount` BankAccountCondition — Filter by bank account
        - `id` IdCondition — Filter by template GL account id
          - `equal` string — Exact match on template GL account id
    - `update` TransactionRuleUpdateGetDto, nullable, required — Updates to apply to matched transactions
      - `glAccount` GlAccountExpanded, required — GL account details
        - `id` string, required — Id of the GL account
        - `name` string — Name of the GL account
        - `accountNo` string — Number of the GL account
        - `type` 'ASSET' | 'LIABILITY' | 'EQUITY' | 'INCOME' | 'COGS' | 'EXPENSE' | 'OTHER_INCOME' | 'OTHER_EXPENSE' | 'SUSPENSE' — Type the GL account
        - `iconUrl` string — Icon URL of the GL account
        - `displayName` string — Display name of the GL account
      - `vendor` VendorExpanded, nullable, required — Vendor associated with this child payment
        - `id` string, required — Id of the vendor
        - `name` string — Name of the vendor
      - `customer` CustomerExpanded, nullable, required — Customer associated with this time entry
        - `id` string, required — Id of the customer
        - `name` string — Name of the customer
        - `email` string — Email of the customer
      - `reviewStatus` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED', nullable, required — Review status assigned to matched transactions
      - `dimensionValues` DimensionValueExpanded[], required
        - `id` string, required — Id of the dimension value
        - `dimension` DimensionExpanded — Dimension for this dimension value
          - `id` string, required — Id of the dimension
          - `name` string — Name of the dimension
          - `requiredness` 'REQUIRED' | 'NOT_REQUIRED' — Requiredness of the dimension
        - `name` string — Name of the dimension value
        - `child` ChildDimensionValue — Child dimension value, if applicable
          - `id` string, required — Id of the dimension value
          - `dimension` DimensionExpanded — Dimension for this dimension value
            - `id` string, required — Id of the dimension
            - `name` string — Name of the dimension
            - `requiredness` 'REQUIRED' | 'NOT_REQUIRED' — Requiredness of the dimension
          - `name` string — Name of the dimension value
          - `child` ChildDimensionValue — recursive
    - `matchCount` integer, required — Number of matched transactions for the transaction rule
    - `lastAppliedDateTime` string, date-time, required — Date on which the most recent match occurred of the transaction rule
    - `filterDisplayName` string, required — Description of the filter conditions of the transaction rule
    - `updateDisplayName` string, required — Description of the updates applied by the transaction rule
    - `customData` JsonNode, nullable — Custom JSON in which you can store any data with max length of 2000 characters
      - `empty` boolean
      - `array` boolean
      - `null` boolean
      - `object` boolean
      - `float` boolean
      - `string` boolean
      - `number` boolean
      - `missingNode` boolean
      - `valueNode` boolean
      - `nodeType` 'ARRAY' | 'BINARY' | 'BOOLEAN' | 'MISSING' | 'NULL' | 'NUMBER' | 'OBJECT' | 'POJO' | 'STRING'
      - `pojo` boolean
      - `integralNumber` boolean
      - `floatingPointNumber` boolean
      - `short` boolean
      - `int` boolean
      - `long` boolean
      - `double` boolean
      - `bigDecimal` boolean
      - `bigInteger` boolean
      - `textual` boolean
      - `boolean` boolean
      - `binary` boolean
      - `container` boolean
      - `embeddedValue` boolean

## Other responses

- `400` — Bad request
- `401` — Not authenticated
- `403` — Not authorized
- `404` — Endpoint not found
- `500` — Internal server error

---

[API](https://skmtc.net/tight/apis/tight-api.md) · [All operations](https://skmtc.net/tight/apis/tight-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tight/tight-api/revisions/e9f0790a89af/schema)