Skip to main content
GET
/
v1
/
businesses
/
{businessId}
/
categorization-rules
/
suggestions
/
{suggestionId}
Get suggested categorization rule
curl --request GET \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/categorization-rules/suggestions/{suggestionId} \
  --header 'Authorization: Bearer <token>'
{
  "type": "Create_Categorization_Rule_For_Counterparty",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "new_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"
    },
    "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",
    "amount_min_filter": 123,
    "amount_max_filter": 123
  },
  "suggestion_prompt": "<string>",
  "transactions_that_will_be_affected": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "source_transaction_id": "g4DlKyjXqGH3Kp5XlaWMtwLRrE4Z9AiE8B4Ko",
      "source_account_id": "Aaoy8G7VXZHVeqNoL1GvcmkPdqpLRWi9NArdG",
      "external_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "imported_at": "2023-11-07T05:31:56Z",
      "date": "2023-11-07T05:31:56Z",
      "amount": 123,
      "counterparty_name": "WeWork",
      "description": "WeWork monthly rent payment",
      "account_name": "Plaid Checking",
      "memo": "<string>",
      "metadata": {
        "custom_field": "value",
        "any valid json": "below 1kb",
        "nested": {
          "meaning of life": 42,
          "array": []
        }
      },
      "reference_number": "<string>"
    }
  ],
  "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "business_name": "<string>",
  "counterparty": {},
  "accepted_at": "2023-11-07T05:31:56Z",
  "dismissed_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business.

​
suggestionId
string<uuid>
required

The UUID of the suggestion to fetch.

Response

Suggested categorization rule update.

Consumer-facing rule suggestion for creating a categorization rule for a specific counterparty.

​
type
enum<string>
required
Available options:
Create_Categorization_Rule_For_Counterparty
​
id
string<uuid>
required
​
created_at
string<date-time>
required
​
new_rule
object
required

Parameters for creating or updating a categorization rule. At least one filter must be specified.

​
suggestion_prompt
string
required
​
transactions_that_will_be_affected
object[]
required
​
status
enum<string>
required
Available options:
PENDING,
ACCEPTED,
REJECTED
​
business_id
string<uuid> | null
​
business_name
string | null
​
counterparty
object

Counterparty associated with the suggestion.

​
accepted_at
string<date-time> | null
​
dismissed_at
string<date-time> | null