Rules

Retrieve rule

Returns one complete company automation rule using exactly the same representation as List rules, including UI-created rules. Requires Accounting setup: View and API access: Manage. Unknown, deleted, foreign-company, global, internal/system, category-owned, and department-owned rules return the same 404 resource_missing response without revealing existence. Only public rule_ IDs are accepted; numeric IDs, UUIDs and malformed IDs return 400 invalid_request. Conditions are a flat AND list and only configured actions are returned. Legacy account/card_name text predicates, exact account_id/card_id identities, and signed inclusive amount bounds retain their List semantics. This GET does not assign IDs, run rules, enqueue historical work, or change transactions. An unrepresentable requested definition returns 503 api_error/rules_not_ready; retry with exponential backoff, and seek operator attention for persistent failures. Missing IDs or unsupported definitions on other rules do not block retrieval of this rule.

GET

rules

{id}

Retrieve rule

curl --request GET \
  --url https://finta.lol/api/v1/rules/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://finta.lol/api/v1/rules/{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://finta.lol/api/v1/rules/{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://finta.lol/api/v1/rules/{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://finta.lol/api/v1/rules/{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": "rule_a1b2c3d4e5f6g7",
  "object": "rule",
  "conditions": [
    {
      "field": "merchant",
      "operator": "contains",
      "value": "Cursor"
    }
  ],
  "actions": {
    "merchant": "Cursor AI",
    "category_id": "cat_a1b2c3d4e5f6g7"
  }
}

Authorizations

Authorization

string

header

required

API key prefixed with finta_

Path Parameters

string

required

Public rule_ ID returned by List rules, with a nonempty alphanumeric suffix of any length.

Pattern: ^rule_[A-Za-z0-9]+$

Response

The complete rule object, identical to its entry in List rules.

The complete saved company automation definition. IDs are stable opaque rule_ identifiers, including for historical rules. No public condition IDs, priority, enable state, or historical application status are exposed. The create-time application flag is not response state.

string

required

Pattern: ^rule_[A-Za-z0-9]+$

object

enum<string>

required

Available options:

rule

conditions

object[]

required

Flat AND conditions; repeated fields express multiple constraints. Text matches are case-insensitive.

Minimum array length: 1

merchant matches the assigned merchant name; description matches the transaction description. account_id and card_id match exact stable identities, never display names. Legacy account and card_name are compatibility text fields; duplicate names and contains can match multiple sources. Their original stored text is preserved. transaction_type currently represents transfer only; it is not the public transaction resource's standard/transfer/split enum. Signed amount_cents uses integer cents without absolute values or currency conversion. greater_than means >=, less_than means <=, and between includes both bounds, minimum first. Signed amounts express inflow/outflow constraints; there is no separate direction field. Consumers must handle legacy text fields and should tolerate future supported condition variants.

Show child attributes

actions

object

required

Only configured actions are present; absent actions are omitted rather than null. category_id and department_id preserve the saved reference's public ID, including legacy references that may no longer be selectable for a new rule. Reading a rule performs no actions. Accounting-date offsets are relative to the original transaction date on import, and do not apply historically. Nonzero offsets cannot be combined with Asset category actions.

Show child attributes

Retrieve rule

curl --request GET \
  --url https://finta.lol/api/v1/rules/{id} \
  --header 'Authorization: Bearer <token>'

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

fetch('https://finta.lol/api/v1/rules/{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://finta.lol/api/v1/rules/{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://finta.lol/api/v1/rules/{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://finta.lol/api/v1/rules/{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": "rule_a1b2c3d4e5f6g7",
  "object": "rule",
  "conditions": [
    {
      "field": "merchant",
      "operator": "contains",
      "value": "Cursor"
    }
  ],
  "actions": {
    "merchant": "Cursor AI",
    "category_id": "cat_a1b2c3d4e5f6g7"
  }
}

API Reference

Company

Team

Categories

Rules

Departments

Integrations

Aggregations

Transactions

Journal Entries

Parties

Reports

Retrieve rule

Authorizations

Path Parameters

Response