Create a Classification Rule - Asset API Documentation

POST

business

{business_id}

rules

classifications

Create a Classification Rule

curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/rules/classifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "classifications": [
    {
      "conditions": {
        "amount": {
          "value": 100,
          "max_value": 250
        },
        "date": {
          "value": "2023-12-25",
          "max_value": "2023-12-25"
        },
        "external_account_id": "eac_GA6EG2qFxA97NZHtxeLPUy"
      },
      "target_ledger_id": "ldg_GA6EG2qFxA97NZHtxeLPUy",
      "tags": {
        "Job": [
          "Maple Street Remodel"
        ],
        "Location": "NYC"
      }
    }
  ],
  "merchant": "Starbucks",
  "description_value": "MONTHLY SOFTWARE SUBSCRIPTION",
  "auto_confirm": false
}
'

import requests

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

payload = {
    "classifications": [
        {
            "conditions": {
                "amount": {
                    "value": 100,
                    "max_value": 250
                },
                "date": {
                    "value": "2023-12-25",
                    "max_value": "2023-12-25"
                },
                "external_account_id": "eac_GA6EG2qFxA97NZHtxeLPUy"
            },
            "target_ledger_id": "ldg_GA6EG2qFxA97NZHtxeLPUy",
            "tags": {
                "Job": ["Maple Street Remodel"],
                "Location": "NYC"
            }
        }
    ],
    "merchant": "Starbucks",
    "description_value": "MONTHLY SOFTWARE SUBSCRIPTION",
    "auto_confirm": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    classifications: [
      {
        conditions: {
          amount: {value: 100, max_value: 250},
          date: {value: '2023-12-25', max_value: '2023-12-25'},
          external_account_id: 'eac_GA6EG2qFxA97NZHtxeLPUy'
        },
        target_ledger_id: 'ldg_GA6EG2qFxA97NZHtxeLPUy',
        tags: {Job: ['Maple Street Remodel'], Location: 'NYC'}
      }
    ],
    merchant: 'Starbucks',
    description_value: 'MONTHLY SOFTWARE SUBSCRIPTION',
    auto_confirm: false
  })
};

fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/rules/classifications', 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/business/{business_id}/rules/classifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'classifications' => [
        [
                'conditions' => [
                                'amount' => [
                                                                'value' => 100,
                                                                'max_value' => 250
                                ],
                                'date' => [
                                                                'value' => '2023-12-25',
                                                                'max_value' => '2023-12-25'
                                ],
                                'external_account_id' => 'eac_GA6EG2qFxA97NZHtxeLPUy'
                ],
                'target_ledger_id' => 'ldg_GA6EG2qFxA97NZHtxeLPUy',
                'tags' => [
                                'Job' => [
                                                                'Maple Street Remodel'
                                ],
                                'Location' => 'NYC'
                ]
        ]
    ],
    'merchant' => 'Starbucks',
    'description_value' => 'MONTHLY SOFTWARE SUBSCRIPTION',
    'auto_confirm' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"classifications\": [\n    {\n      \"conditions\": {\n        \"amount\": {\n          \"value\": 100,\n          \"max_value\": 250\n        },\n        \"date\": {\n          \"value\": \"2023-12-25\",\n          \"max_value\": \"2023-12-25\"\n        },\n        \"external_account_id\": \"eac_GA6EG2qFxA97NZHtxeLPUy\"\n      },\n      \"target_ledger_id\": \"ldg_GA6EG2qFxA97NZHtxeLPUy\",\n      \"tags\": {\n        \"Job\": [\n          \"Maple Street Remodel\"\n        ],\n        \"Location\": \"NYC\"\n      }\n    }\n  ],\n  \"merchant\": \"Starbucks\",\n  \"description_value\": \"MONTHLY SOFTWARE SUBSCRIPTION\",\n  \"auto_confirm\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.getasset.com/v0/business/{business_id}/rules/classifications")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"classifications\": [\n    {\n      \"conditions\": {\n        \"amount\": {\n          \"value\": 100,\n          \"max_value\": 250\n        },\n        \"date\": {\n          \"value\": \"2023-12-25\",\n          \"max_value\": \"2023-12-25\"\n        },\n        \"external_account_id\": \"eac_GA6EG2qFxA97NZHtxeLPUy\"\n      },\n      \"target_ledger_id\": \"ldg_GA6EG2qFxA97NZHtxeLPUy\",\n      \"tags\": {\n        \"Job\": [\n          \"Maple Street Remodel\"\n        ],\n        \"Location\": \"NYC\"\n      }\n    }\n  ],\n  \"merchant\": \"Starbucks\",\n  \"description_value\": \"MONTHLY SOFTWARE SUBSCRIPTION\",\n  \"auto_confirm\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"classifications\": [\n    {\n      \"conditions\": {\n        \"amount\": {\n          \"value\": 100,\n          \"max_value\": 250\n        },\n        \"date\": {\n          \"value\": \"2023-12-25\",\n          \"max_value\": \"2023-12-25\"\n        },\n        \"external_account_id\": \"eac_GA6EG2qFxA97NZHtxeLPUy\"\n      },\n      \"target_ledger_id\": \"ldg_GA6EG2qFxA97NZHtxeLPUy\",\n      \"tags\": {\n        \"Job\": [\n          \"Maple Street Remodel\"\n        ],\n        \"Location\": \"NYC\"\n      }\n    }\n  ],\n  \"merchant\": \"Starbucks\",\n  \"description_value\": \"MONTHLY SOFTWARE SUBSCRIPTION\",\n  \"auto_confirm\": false\n}"

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"
        },
        "external_account_id": "eac_GA6EG2qFxA97NZHtxeLPUy"
      },
      "tags": {},
      "target_ledger_id": "<string>",
      "target_ledger_name": "<string>"
    }
  ],
  "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.

Path Parameters

business_id

string<biz_string>

required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

Body

application/json

classifications

CreateBusinessTxnClassificationRequest · object[]

required

Classifications evaluated in order against matching transactions. Categorization applies the first one whose conditions match and that has a target ledger; tagging applies the tags of every one whose conditions match. A classification with no conditions matches every transaction.

Minimum array length: 1

Show child attributes

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"

auto_confirm

boolean

default:false

Whether journal entries created from matching transactions are confirmed without manual review.

Response

Successful Response

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.

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

Create a Classification Rule

curl --request POST \
  --url https://api.sandbox.getasset.com/v0/business/{business_id}/rules/classifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "classifications": [
    {
      "conditions": {
        "amount": {
          "value": 100,
          "max_value": 250
        },
        "date": {
          "value": "2023-12-25",
          "max_value": "2023-12-25"
        },
        "external_account_id": "eac_GA6EG2qFxA97NZHtxeLPUy"
      },
      "target_ledger_id": "ldg_GA6EG2qFxA97NZHtxeLPUy",
      "tags": {
        "Job": [
          "Maple Street Remodel"
        ],
        "Location": "NYC"
      }
    }
  ],
  "merchant": "Starbucks",
  "description_value": "MONTHLY SOFTWARE SUBSCRIPTION",
  "auto_confirm": false
}
'

import requests

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

payload = {
    "classifications": [
        {
            "conditions": {
                "amount": {
                    "value": 100,
                    "max_value": 250
                },
                "date": {
                    "value": "2023-12-25",
                    "max_value": "2023-12-25"
                },
                "external_account_id": "eac_GA6EG2qFxA97NZHtxeLPUy"
            },
            "target_ledger_id": "ldg_GA6EG2qFxA97NZHtxeLPUy",
            "tags": {
                "Job": ["Maple Street Remodel"],
                "Location": "NYC"
            }
        }
    ],
    "merchant": "Starbucks",
    "description_value": "MONTHLY SOFTWARE SUBSCRIPTION",
    "auto_confirm": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    classifications: [
      {
        conditions: {
          amount: {value: 100, max_value: 250},
          date: {value: '2023-12-25', max_value: '2023-12-25'},
          external_account_id: 'eac_GA6EG2qFxA97NZHtxeLPUy'
        },
        target_ledger_id: 'ldg_GA6EG2qFxA97NZHtxeLPUy',
        tags: {Job: ['Maple Street Remodel'], Location: 'NYC'}
      }
    ],
    merchant: 'Starbucks',
    description_value: 'MONTHLY SOFTWARE SUBSCRIPTION',
    auto_confirm: false
  })
};

fetch('https://api.sandbox.getasset.com/v0/business/{business_id}/rules/classifications', 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/business/{business_id}/rules/classifications",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'classifications' => [
        [
                'conditions' => [
                                'amount' => [
                                                                'value' => 100,
                                                                'max_value' => 250
                                ],
                                'date' => [
                                                                'value' => '2023-12-25',
                                                                'max_value' => '2023-12-25'
                                ],
                                'external_account_id' => 'eac_GA6EG2qFxA97NZHtxeLPUy'
                ],
                'target_ledger_id' => 'ldg_GA6EG2qFxA97NZHtxeLPUy',
                'tags' => [
                                'Job' => [
                                                                'Maple Street Remodel'
                                ],
                                'Location' => 'NYC'
                ]
        ]
    ],
    'merchant' => 'Starbucks',
    'description_value' => 'MONTHLY SOFTWARE SUBSCRIPTION',
    'auto_confirm' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"classifications\": [\n    {\n      \"conditions\": {\n        \"amount\": {\n          \"value\": 100,\n          \"max_value\": 250\n        },\n        \"date\": {\n          \"value\": \"2023-12-25\",\n          \"max_value\": \"2023-12-25\"\n        },\n        \"external_account_id\": \"eac_GA6EG2qFxA97NZHtxeLPUy\"\n      },\n      \"target_ledger_id\": \"ldg_GA6EG2qFxA97NZHtxeLPUy\",\n      \"tags\": {\n        \"Job\": [\n          \"Maple Street Remodel\"\n        ],\n        \"Location\": \"NYC\"\n      }\n    }\n  ],\n  \"merchant\": \"Starbucks\",\n  \"description_value\": \"MONTHLY SOFTWARE SUBSCRIPTION\",\n  \"auto_confirm\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.getasset.com/v0/business/{business_id}/rules/classifications")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"classifications\": [\n    {\n      \"conditions\": {\n        \"amount\": {\n          \"value\": 100,\n          \"max_value\": 250\n        },\n        \"date\": {\n          \"value\": \"2023-12-25\",\n          \"max_value\": \"2023-12-25\"\n        },\n        \"external_account_id\": \"eac_GA6EG2qFxA97NZHtxeLPUy\"\n      },\n      \"target_ledger_id\": \"ldg_GA6EG2qFxA97NZHtxeLPUy\",\n      \"tags\": {\n        \"Job\": [\n          \"Maple Street Remodel\"\n        ],\n        \"Location\": \"NYC\"\n      }\n    }\n  ],\n  \"merchant\": \"Starbucks\",\n  \"description_value\": \"MONTHLY SOFTWARE SUBSCRIPTION\",\n  \"auto_confirm\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"classifications\": [\n    {\n      \"conditions\": {\n        \"amount\": {\n          \"value\": 100,\n          \"max_value\": 250\n        },\n        \"date\": {\n          \"value\": \"2023-12-25\",\n          \"max_value\": \"2023-12-25\"\n        },\n        \"external_account_id\": \"eac_GA6EG2qFxA97NZHtxeLPUy\"\n      },\n      \"target_ledger_id\": \"ldg_GA6EG2qFxA97NZHtxeLPUy\",\n      \"tags\": {\n        \"Job\": [\n          \"Maple Street Remodel\"\n        ],\n        \"Location\": \"NYC\"\n      }\n    }\n  ],\n  \"merchant\": \"Starbucks\",\n  \"description_value\": \"MONTHLY SOFTWARE SUBSCRIPTION\",\n  \"auto_confirm\": false\n}"

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"
        },
        "external_account_id": "eac_GA6EG2qFxA97NZHtxeLPUy"
      },
      "tags": {},
      "target_ledger_id": "<string>",
      "target_ledger_name": "<string>"
    }
  ],
  "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>"
}