latestOpenAPI 3.0.12026-07-26222700728.0 KB

e9f0790a89af

Transaction Rules

Query transaction rules

Query transaction rules for the authenticated user

post/v6/banks/transactions/rules/query

Request body

cursorstring nullable

Cursor from the previous paginated response

limitinteger

Page size, i.e. number of items to return per page

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": [
    {
      "id": "trl_5445116",
      "status": "ACTIVE",
      "filter": {
        "description": {
          "equal": "Office Supplies",
          "contain": "Supplies"
        },
        "vendor": {
          "id": {
            "equal": "tgla_324231"
          }
        },
        "glAccount": {
          "id": {
            "equal": "tgla_324231"
          }
        },
        "bankAccount": {
          "id": {
            "equal": "tgla_324231"
          }
        }
      },
      "update": {
        "glAccount": {
          "id": "gla_38560327",
          "name": "Officer(s) Salaries and Wages",
          "accountNo": "60210",
          "type": "EXPENSE",
          "iconUrl": "https://cdn.sandbox.tight.com/icons/glAccountTypes/expense.png",
          "displayName": "#60210 Officer(s) Salaries and Wages"
        },
        "vendor": {
          "id": "vnd_28868401",
          "name": "Gusto"
        },
        "customer": {
          "id": "cus_4852707",
          "name": "Abigail Adams",
          "email": "abigail@tight.com"
        },
        "reviewStatus": "RECONCILED",
        "dimensionValues": [
          {
            "id": "dv_593051",
            "dimension": {
              "id": "dim_4521",
              "name": "Region",
              "requiredness": "NOT_REQUIRED"
            },
            "name": "Mid-Atlantic",
            "child": {
              "id": "dv_593052",
              "dimension": {
                "id": "dim_4521",
                "name": "Region",
                "requiredness": "NOT_REQUIRED"
              },
              "name": "Washington DC"
            }
          }
        ]
      },
      "matchCount": 4,
      "filterDisplayName": "Vendor is \"Starbucks\"",
      "updateDisplayName": "Set glAccount as \"Taxi\"",
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ]
}