Skip to main content
POST
/
v6
/
banks
/
transactions
/
rules
/
query
Query transaction rules
curl --request POST \
  --url https://sandbox.tight.com/v6/banks/transactions/rules/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cursor": "<string>",
  "limit": 123,
  "sort": {},
  "filter": {
    "status": {
      "in": [],
      "notIn": []
    },
    "filter": {
      "description": {
        "equal": "<string>",
        "notEqual": "<string>",
        "greaterThan": "<string>",
        "greaterThanEqual": "<string>",
        "lessThan": "<string>",
        "lessThanEqual": "<string>",
        "contain": "<string>"
      },
      "amount": {
        "equal": 123,
        "notEqual": 123,
        "greaterThan": 123,
        "greaterThanEqual": 123,
        "lessThan": 123,
        "lessThanEqual": 123
      },
      "vendorId": {
        "id": {
          "in": [
            "<string>"
          ]
        }
      },
      "bankAccountId": {
        "id": {
          "in": [
            "<string>"
          ],
          "notIn": [
            "<string>"
          ]
        }
      }
    },
    "update": {
      "glAccountId": {
        "id": {
          "in": [
            "<string>"
          ]
        }
      },
      "vendorId": {
        "id": {
          "in": [
            "<string>"
          ]
        }
      },
      "customerId": {
        "id": {
          "in": [
            "<string>"
          ]
        }
      },
      "reviewStatus": {
        "in": [],
        "notIn": []
      },
      "dimensionValueId": {
        "id": {
          "in": [
            "<string>"
          ]
        }
      }
    },
    "lastAppliedDate": {
      "equal": "2023-11-07T05:31:56Z",
      "notEqual": "2023-11-07T05:31:56Z",
      "greaterThan": "2023-11-07T05:31:56Z",
      "greaterThanEqual": "2023-11-07T05:31:56Z",
      "lessThan": "2023-11-07T05:31:56Z",
      "lessThanEqual": "2023-11-07T05:31:56Z"
    },
    "matchCount": {
      "equal": 123,
      "notEqual": 123,
      "greaterThan": 123,
      "greaterThanEqual": 123,
      "lessThan": 123,
      "lessThanEqual": 123
    }
  }
}
'
{
  "data": [
    {
      "id": "trl_5445116",
      "status": "ACTIVE",
      "filter": {
        "description": {
          "equal": "Office Supplies",
          "contain": "Supplies"
        },
        "amount": {
          "equal": 123,
          "greaterThan": 123,
          "greaterThanEqual": 123,
          "lessThan": 123,
          "lessThanEqual": 123
        },
        "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",
              "child": "<unknown>"
            }
          }
        ]
      },
      "matchCount": 4,
      "lastAppliedDateTime": "2023-11-07T05:31:56Z",
      "filterDisplayName": "Vendor is \"Starbucks\"",
      "updateDisplayName": "Set glAccount as \"Taxi\"",
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ],
  "cursor": {
    "after": "<string>",
    "before": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, see Authentication for more detail.

Body

application/json
cursor
string | null

Cursor from the previous paginated response

limit
integer<int32>

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

Required range: x <= 250
sort
object

Sort order for the items in the response.

filter
object

Filter for items in the response.

Response

Success

result
enum<string>

The result of the action performed.

Available options:
SUCCESS,
FAILURE
data
object[]

The data generated by the action performed.

cursor
object

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.