--- title: "Query transaction rules" method: POST path: "/v6/banks/transactions/rules/query" tags: ["Transaction Rules"] --- # Query transaction rules `POST /v6/banks/transactions/rules/query` Query transaction rules for the authenticated user ## Request body - TransactionRulesGetParam - `cursor` string, nullable — Cursor from the previous paginated response - `limit` integer — Page size, i.e. number of items to return per page - `sort` TransactionRulesSort — Sort order for the items in the response. - `orderBy` 'LAST_APPLIED_DATE' | 'MATCH_COUNT' — Sort column - `direction` 'ASC' | 'DESC' — Sort direction. Defaults to DESC - `filter` TransactionRulesFilterParam — Filter for items in the response. - `status` EnumStatusListFilter — Status filter - `in` string[] - `notIn` string[] - `equal` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `notEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `greaterThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `greaterThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `lessThan` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `lessThanEqual` 'ACTIVE' | 'INACTIVE' | 'REMOVED' - `filter` TransactionRuleConditionFilterParam — Rule filter's filter - `description` StringFilter — Name filter - `equal` string — Value - returns all records with specified field equal to this value. - `notEqual` string — Value - returns all records with specified field not equal to this value. - `greaterThan` string — Value - returns all records with specified field greater than to this value. - `greaterThanEqual` string — Value - returns all records with specified field greater than or equal to this value. - `lessThan` string — Value - returns all records with specified field less than to this value. - `lessThanEqual` string — Value - returns all records with specified field less than or equal to this value. - `contain` string — Value - returns all records with specified field containing this value. - `amount` AmountFilter — Match count filter - `equal` integer — Value - returns all records with specified field equal to this value. - `notEqual` integer — Value - returns all records with specified field not equal to this value. - `greaterThan` integer — Value - returns all records with specified field greater than to this value. - `greaterThanEqual` integer — Value - returns all records with specified field greater than or equal to this value. - `lessThan` integer — Value - returns all records with specified field less than to this value. - `lessThanEqual` integer — Value - returns all records with specified field less than or equal to this value. - `vendorId` VendorFilter — Filter on the rule's action vendor id - `id` VendorIds — Id filter - returns all entities with the following vendors. - `in` string[] — List of values to include. - `bankAccountId` BankAccountFilter — Bank filter - `id` BankAccountIds — Id filter - returns all entities with the following bank accounts. - `in` string[] — List of values to include. - `notIn` string[] — List of values to exclude. - `update` TransactionRuleActionFilterParam — Rule update's filter - `glAccountId` GlAccountFilter — Filter on the rule's action GL account id - `id` GlAccountIds — Id filter - returns all entities with the following General Ledger accounts. - `in` string[] — List of values to include. - `vendorId` VendorFilter — Filter on the rule's action vendor id - `id` VendorIds — Id filter - returns all entities with the following vendors. - `in` string[] — List of values to include. - `customerId` CustomerFilter — Filter on the rule's action customer id - `id` CustomerIds — Id filter - returns all entities with the following customers. - `in` string[] — List of values to include. - `reviewStatus` ReviewStatusListFilter — Review status filter - `in` string[] — List of values to include. - `notIn` string[] — List of values to exclude. - `equal` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `notEqual` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `greaterThan` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `greaterThanEqual` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `lessThan` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `lessThanEqual` 'RECONCILIATION_DISCREPANCY' | 'USER_REVIEW_REQUIRED' | 'ACCOUNTANT_REVIEW_REQUIRED' | 'PARTNER_REVIEW_REQUIRED' | 'AWAITING_MATCH' | 'STAGED' | 'RECONCILED' - `dimensionValueId` DimensionValueFilter — Filter on the rule's action dimension value id (any slot) - `id` DimensionValueIds — Id filter - returns all entities with the following dimension values. - `in` string[] — List of values to include. - `lastAppliedDate` DateTimeFilter — Date filter - `equal` string, date-time — Equal to - `notEqual` string, date-time — Not equal to - `greaterThan` string, date-time — Greater than - `greaterThanEqual` string, date-time — Greater than or equal to - `lessThan` string, date-time — Less than - `lessThanEqual` string, date-time — Less than or equal to - `matchCount` AmountFilter — Match count filter - `equal` integer — Value - returns all records with specified field equal to this value. - `notEqual` integer — Value - returns all records with specified field not equal to this value. - `greaterThan` integer — Value - returns all records with specified field greater than to this value. - `greaterThanEqual` integer — Value - returns all records with specified field greater than or equal to this value. - `lessThan` integer — Value - returns all records with specified field less than to this value. - `lessThanEqual` integer — Value - returns all records with specified field less than or equal to this value. ## Response `200` Success - PaginatedResponseTransactionRuleGetDto - `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 - `cursor` ResponseCursor — Cursor to be used in your subsequent paginated request. Only populated if there are more pages available. - `after` string — After cursor - Fetches entities after this cursor. Useful for paging forwards. - `before` string — Before cursor - Fetches entities before this cursor. Useful for paging backwards. ## 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)