Skip to main content
GET
Get a Classification Rule

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

rule_id
string<clr_string>
required

The id of the classification rule

Example:

"clr_GA6EG2qFxA97NZHtxeLPUy"

Response

Successful Response

id
string<clr_string>
required

The id of the classification rule

Example:

"clr_GA6EG2qFxA97NZHtxeLPUy"

classifications
BusinessTxnClassificationPublic · object[]
required

Classifications evaluated in order. Categorization applies the first one whose conditions match and that has a target ledger; tagging applies the tags of every one whose conditions match.

auto_confirm
boolean
required
is_active
boolean
required

Whether the rule takes part in categorization and tagging.

match_count
integer
required

Number of transactions the rule has matched.

created_at
string<date-time>
required
merchant
string | null

Case-insensitive exact merchant name to match. Mutually exclusive with the description criterion; exactly one of the two is required.

Maximum string length: 255
Example:

"Starbucks"

description_match_type
enum<string> | null

How to match the transaction description.

Available options:
contains,
not_contains,
equals
description_value
string | null

Description text to match, case-insensitive.

Maximum string length: 512
Example:

"MONTHLY SOFTWARE SUBSCRIPTION"

last_matched_at
string<date-time> | null

When the rule last matched a transaction.