Get a Tenant Classification Rule - Asset API Documentation

GET

tenant

rules

classifications

{rule_id}

Get a Tenant Classification Rule

curl --request GET \
  --url https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "clr_GA6EG2qFxA97NZHtxeLPUy",
  "classifications": [
    {
      "conditions": {
        "amount": {
          "operator": "equals",
          "value": 100,
          "max_value": 250
        },
        "direction": "money_in",
        "date": {
          "operator": "equals",
          "value": "2023-12-25",
          "max_value": "2023-12-25"
        }
      },
      "target_ledger_name": "<string>",
      "splits": [
        {
          "ledger_name": "<string>",
          "percentage": 123
        }
      ],
      "tags": {}
    }
  ],
  "auto_confirm": true,
  "is_active": true,
  "match_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "merchant": "Starbucks",
  "description_match_type": "contains",
  "description_value": "MONTHLY SOFTWARE SUBSCRIPTION",
  "last_matched_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

Authorizations

Authorization

string

header

required

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

FlowClient Credentials

Token URL: /v0/auth/token

Scopes1

tenant:read

Path Parameters

rule_id

string<clr_string>

required

The id of the classification rule

Example:

"clr_GA6EG2qFxA97NZHtxeLPUy"

Response

Successful Response

string<clr_string>

required

The id of the classification rule

Example:

"clr_GA6EG2qFxA97NZHtxeLPUy"

classifications

TenantTxnClassificationPublic · object[]

required

Classifications evaluated in order. Categorization applies the first one whose conditions match and whose ledger name the business has; tagging applies, per tag field, the first one whose conditions match and that sets the field.

Show child attributes

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.

⌘I

Get a Tenant Classification Rule

curl --request GET \
  --url https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.getasset.com/v0/tenant/rules/classifications/{rule_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "clr_GA6EG2qFxA97NZHtxeLPUy",
  "classifications": [
    {
      "conditions": {
        "amount": {
          "operator": "equals",
          "value": 100,
          "max_value": 250
        },
        "direction": "money_in",
        "date": {
          "operator": "equals",
          "value": "2023-12-25",
          "max_value": "2023-12-25"
        }
      },
      "target_ledger_name": "<string>",
      "splits": [
        {
          "ledger_name": "<string>",
          "percentage": 123
        }
      ],
      "tags": {}
    }
  ],
  "auto_confirm": true,
  "is_active": true,
  "match_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "merchant": "Starbucks",
  "description_match_type": "contains",
  "description_value": "MONTHLY SOFTWARE SUBSCRIPTION",
  "last_matched_at": "2023-11-07T05:31:56Z"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}

{
  "error": "<string>",
  "data": "<unknown>"
}