POST
Criar regra de categoria

Authorizations

X-API-KEY
string
header
required

Chave de API da aplicação. Obrigatória em todos os endpoints. Renove via POST /auth.

Body

application/json

Corpo para criar uma regra de categoria do cliente.

description
string
required

Texto casado contra as descrições das transações (case-insensitive).

Example:

"uber payment"

categoryId
string
required

Categoria a atribuir.

Example:

"05000000"

transactionType
enum<string>

Restringe a regra a transações DEBIT ou CREDIT.

Available options:
DEBIT,
CREDIT
accountType
enum<string>

Restringe a regra a contas CHECKING_ACCOUNT ou CREDIT_CARD.

Available options:
CHECKING_ACCOUNT,
CREDIT_CARD
matchType
enum<string>

Modo de correspondência. Padrão exact.

Available options:
exact,
contains,
startsWith,
endsWith

Response

A regra criada.

Regra de categoria do cliente. As regras são client-wide (escopadas ao clientId da API). category é a descrição resolvida de categoryId.

description
string
required

Texto casado contra as descrições das transações.

Example:

"uber payment"

category
string
required

Descrição resolvida de categoryId.

Example:

"Salary/pro-labore"

categoryId
string

Id da categoria atribuída.

Example:

"05000000"

clientId
string<uuid>

Id do cliente (API) ao qual a regra pertence.

Example:

"03cc0eff-4ec5-495c-adb3-1ef9611624fc"

transactionType
enum<string>

Restrição por tipo de transação, se definida.

Available options:
DEBIT,
CREDIT
accountType
enum<string>

Restrição por tipo de conta, se definida.

Available options:
CHECKING_ACCOUNT,
CREDIT_CARD
matchType
enum<string>

Modo de correspondência.

Available options:
exact,
contains,
startsWith,
endsWith