v1

latestOpenAPI 3.1.0MIT2026-07-2484155300.5 KB

Create Category Rule

Create a single category rule

post/categories/rules

Request body

descriptionstring required

Description of the transaction rule.

categoryIdstring required

Identifier of the category

transactionTypestring

Transaction type (DEBIT/CREDIT)

accountTypestring

Account type (CHECKING_ACCOUNT/CREDIT_CARD)

matchTypestring

Type of match used to identify the rule (exact/contains/startsWith/endsWith), if not provided, defaults to 'exact'

Example request

{
  "description": "uber payment",
  "categoryId": "05000000",
  "transactionType": "DEBIT",
  "accountType": "CHECKING_ACCOUNT"
}

Response

Creates a Category Rule and recover the result

descriptionstring required

Description of the transaction rule.

categoryIdstring

Identifier of the category

categorystring required

Description of the category

clientIdstring

Identifier of the client

transactionTypestring

Transaction type (DEBIT/CREDIT)

accountTypestring

Account type (CHECKING_ACCOUNT/CREDIT_CARD)

Example response

{
  "description": "uber payment",
  "category": "Salary/pro-labore",
  "categoryId": "05000000",
  "clientId": "03cc0eff-4ec5-495c-adb3-1ef9611624fc",
  "transactionType": "DEBIT",
  "accountType": "CHECKING_ACCOUNT"
}