Update categorization rule
curl --request PUT \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"category": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_1": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_2": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_3": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"apply_retroactively": false,
"external_id": "<string>",
"created_by_suggestion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchant_type_filter": "<string>",
"transaction_description_filter": "<string>",
"counterparty_filter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_transaction_type_filter": "PURCHASE",
"bank_direction_filter": "MONEY_OUT",
"amount_min_filter": 123,
"amount_max_filter": 123
}
'import requests
url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}"
payload = {
"name": "<string>",
"category": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_1": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_2": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_3": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"apply_retroactively": False,
"external_id": "<string>",
"created_by_suggestion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchant_type_filter": "<string>",
"transaction_description_filter": "<string>",
"counterparty_filter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_transaction_type_filter": "PURCHASE",
"bank_direction_filter": "MONEY_OUT",
"amount_min_filter": 123,
"amount_max_filter": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
category: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
suggestion_1: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
suggestion_2: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
suggestion_3: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
apply_retroactively: false,
external_id: '<string>',
created_by_suggestion_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
merchant_type_filter: '<string>',
transaction_description_filter: '<string>',
counterparty_filter: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
bank_transaction_type_filter: 'PURCHASE',
bank_direction_filter: 'MONEY_OUT',
amount_min_filter: 123,
amount_max_filter: 123
})
};
fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}', 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://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'category' => [
'type' => 'AccountId',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'suggestion_1' => [
'type' => 'AccountId',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'suggestion_2' => [
'type' => 'AccountId',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'suggestion_3' => [
'type' => 'AccountId',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'apply_retroactively' => false,
'external_id' => '<string>',
'created_by_suggestion_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'merchant_type_filter' => '<string>',
'transaction_description_filter' => '<string>',
'counterparty_filter' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'bank_transaction_type_filter' => 'PURCHASE',
'bank_direction_filter' => 'MONEY_OUT',
'amount_min_filter' => 123,
'amount_max_filter' => 123
]),
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://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_1\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_2\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_3\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"apply_retroactively\": false,\n \"external_id\": \"<string>\",\n \"created_by_suggestion_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"merchant_type_filter\": \"<string>\",\n \"transaction_description_filter\": \"<string>\",\n \"counterparty_filter\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_transaction_type_filter\": \"PURCHASE\",\n \"bank_direction_filter\": \"MONEY_OUT\",\n \"amount_min_filter\": 123,\n \"amount_max_filter\": 123\n}")
req, _ := http.NewRequest("PUT", 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.put("https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_1\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_2\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_3\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"apply_retroactively\": false,\n \"external_id\": \"<string>\",\n \"created_by_suggestion_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"merchant_type_filter\": \"<string>\",\n \"transaction_description_filter\": \"<string>\",\n \"counterparty_filter\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_transaction_type_filter\": \"PURCHASE\",\n \"bank_direction_filter\": \"MONEY_OUT\",\n \"amount_min_filter\": 123,\n \"amount_max_filter\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"category\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_1\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_2\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_3\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"apply_retroactively\": false,\n \"external_id\": \"<string>\",\n \"created_by_suggestion_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"merchant_type_filter\": \"<string>\",\n \"transaction_description_filter\": \"<string>\",\n \"counterparty_filter\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_transaction_type_filter\": \"PURCHASE\",\n \"bank_direction_filter\": \"MONEY_OUT\",\n \"amount_min_filter\": 123,\n \"amount_max_filter\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "Categorization_Rule",
"name": "<string>",
"category": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_1": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_2": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_3": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"merchant_type_filter": "<string>",
"transaction_description_filter": "<string>",
"counterparty_filter": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"logo_url": "<string>",
"website": "<string>"
},
"bank_transaction_type_filter": "PURCHASE",
"bank_direction_filter": "MONEY_OUT",
"amount_min_filter": 123,
"amount_max_filter": 123
}
}Categorization Rules
Update categorization rule
Updates an existing categorization rule. This replaces the entire rule content. The rule can optionally be applied retroactively to existing uncategorized transactions.
PUT
/
v1
/
businesses
/
{businessId}
/
categorization-rules
/
{categorizationRuleId}
Update categorization rule
curl --request PUT \
--url https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"category": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_1": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_2": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_3": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"apply_retroactively": false,
"external_id": "<string>",
"created_by_suggestion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchant_type_filter": "<string>",
"transaction_description_filter": "<string>",
"counterparty_filter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_transaction_type_filter": "PURCHASE",
"bank_direction_filter": "MONEY_OUT",
"amount_min_filter": 123,
"amount_max_filter": 123
}
'import requests
url = "https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}"
payload = {
"name": "<string>",
"category": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_1": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_2": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_3": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"apply_retroactively": False,
"external_id": "<string>",
"created_by_suggestion_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"merchant_type_filter": "<string>",
"transaction_description_filter": "<string>",
"counterparty_filter": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bank_transaction_type_filter": "PURCHASE",
"bank_direction_filter": "MONEY_OUT",
"amount_min_filter": 123,
"amount_max_filter": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
category: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
suggestion_1: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
suggestion_2: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
suggestion_3: {type: 'AccountId', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'},
apply_retroactively: false,
external_id: '<string>',
created_by_suggestion_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
merchant_type_filter: '<string>',
transaction_description_filter: '<string>',
counterparty_filter: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
bank_transaction_type_filter: 'PURCHASE',
bank_direction_filter: 'MONEY_OUT',
amount_min_filter: 123,
amount_max_filter: 123
})
};
fetch('https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}', 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://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'category' => [
'type' => 'AccountId',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'suggestion_1' => [
'type' => 'AccountId',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'suggestion_2' => [
'type' => 'AccountId',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'suggestion_3' => [
'type' => 'AccountId',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'apply_retroactively' => false,
'external_id' => '<string>',
'created_by_suggestion_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'merchant_type_filter' => '<string>',
'transaction_description_filter' => '<string>',
'counterparty_filter' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'bank_transaction_type_filter' => 'PURCHASE',
'bank_direction_filter' => 'MONEY_OUT',
'amount_min_filter' => 123,
'amount_max_filter' => 123
]),
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://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"category\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_1\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_2\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_3\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"apply_retroactively\": false,\n \"external_id\": \"<string>\",\n \"created_by_suggestion_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"merchant_type_filter\": \"<string>\",\n \"transaction_description_filter\": \"<string>\",\n \"counterparty_filter\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_transaction_type_filter\": \"PURCHASE\",\n \"bank_direction_filter\": \"MONEY_OUT\",\n \"amount_min_filter\": 123,\n \"amount_max_filter\": 123\n}")
req, _ := http.NewRequest("PUT", 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.put("https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"category\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_1\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_2\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_3\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"apply_retroactively\": false,\n \"external_id\": \"<string>\",\n \"created_by_suggestion_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"merchant_type_filter\": \"<string>\",\n \"transaction_description_filter\": \"<string>\",\n \"counterparty_filter\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_transaction_type_filter\": \"PURCHASE\",\n \"bank_direction_filter\": \"MONEY_OUT\",\n \"amount_min_filter\": 123,\n \"amount_max_filter\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/{categorizationRuleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"category\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_1\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_2\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"suggestion_3\": {\n \"type\": \"AccountId\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"apply_retroactively\": false,\n \"external_id\": \"<string>\",\n \"created_by_suggestion_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"merchant_type_filter\": \"<string>\",\n \"transaction_description_filter\": \"<string>\",\n \"counterparty_filter\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"bank_transaction_type_filter\": \"PURCHASE\",\n \"bank_direction_filter\": \"MONEY_OUT\",\n \"amount_min_filter\": 123,\n \"amount_max_filter\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "Categorization_Rule",
"name": "<string>",
"category": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_1": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_2": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"suggestion_3": {
"type": "AccountId",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"merchant_type_filter": "<string>",
"transaction_description_filter": "<string>",
"counterparty_filter": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"logo_url": "<string>",
"website": "<string>"
},
"bank_transaction_type_filter": "PURCHASE",
"bank_direction_filter": "MONEY_OUT",
"amount_min_filter": 123,
"amount_max_filter": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Content-Type must be set to application/json.
Path Parameters
The UUID of the business.
The UUID of the categorization rule.
Body
application/json
Parameters for creating or updating a categorization rule. At least one filter must be specified.
Optional name for the rule.
- Account ID
- Account Stable Name
- Exclusion
Show child attributes
Show child attributes
- Account ID
- Account Stable Name
- Exclusion
Show child attributes
Show child attributes
- Account ID
- Account Stable Name
- Exclusion
Show child attributes
Show child attributes
- Account ID
- Account Stable Name
- Exclusion
Show child attributes
Show child attributes
Whether to apply this rule to existing uncategorized transactions.
External identifier for idempotency. Used for create/upsert operations.
UUID of the suggestion that created this rule (if applicable).
Regex pattern that matches the entire merchant name. Patterns must contain 1 to 1,024 characters. Lookaround and backreferences are not supported.
Required string length:
1 - 1024Regex pattern that matches the entire transaction description. Patterns must contain 1 to 1,024 characters. Lookaround and backreferences are not supported.
Required string length:
1 - 1024UUID of a specific counterparty (merchant/vendor) to match.
Type of bank transaction.
Available options:
REVENUE, LOAN_DISBURSEMENT, REFUND_RECEIVED, INCOMING_P2P_TRANSFER, INTRA_ACCOUNT_TRANSFER_IN, CHECK_WITHDRAWAL, ATM_DEPOSIT, BANK_DEPOSIT, BANK_VERIFICATION_TRIAL_CREDIT, REVERSAL_IN, CREDIT_CARD_REWARD, CREDIT_CARD_PAYMENT_IN, INTEREST_EARNED, GOVERNMENT_OR_OTHER_GRANT, TAX_REFUND, PURCHASE, REFUND_GIVEN, OUTGOING_P2P_TRANSFER, INTRA_ACCOUNT_TRANSFER_OUT, CHECK_DEPOSIT, CREDIT_CARD_PAYMENT_OUT, ATM_WITHDRAWAL, BANK_WITHDRAWAL, BANKING_FEE, PAYMENT_PROCESSING_FEE, BANK_VERIFICATION_TRIAL_DEBIT, REVERSAL_OUT, LOAN_PAYMENT, TAX_PAYMENT, CASH_DEPOSIT_OR_WITHDRAWAL, CHECK_DEPOSIT_OR_WITHDRAWAL, NOT_ENOUGH_INFORMATION Example:
"PURCHASE"
Transaction direction to match.
Available options:
MONEY_IN, MONEY_OUT Example:
"MONEY_OUT"
Minimum transaction amount in cents.
Maximum transaction amount in cents.
Response
Categorization rule updated successfully.
A categorization rule that automatically categorizes transactions matching specified filters.
Show child attributes
Show child attributes