GET
Listar regras

Authorizations

Authorization
string
header
required

HTTP Basic com o token como usuário e o secret como senha: curl -u dpz_tk_…:dpz_sk_…. Crie a chave em https://despezzas.com/settings/api-keys.

Query Parameters

source_kind
enum<string>

Filtra pela origem.

Available options:
ACCOUNT,
CREDIT_CARD
Example:

"ACCOUNT"

source_id
string

Filtra pela conta ou cartão de origem.

Example:

"3a9e7d21-4b5c-4d6e-8f70-1a2b3c4d5e6f"

enabled
boolean

Só ativas (true) ou só inativas (false).

Example:

true

Response

Sucesso.

category_id
string
required

Categoria aplicada.

Example:

"b1a2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"

enabled
boolean
required

Ativa.

Example:

true

id
string
required

Id.

Example:

"d4e5f6a7-b8c9-4d0e-8f1a-2b3c4d5e6f7a"

is_expense
boolean
required

Se vale para despesas (senão, receitas).

Example:

true

match_fields
string[]
required

Campos que a regra compara.

Example:
source_id
string
required

Id da conta ou do cartão de origem.

Example:

"3a9e7d21-4b5c-4d6e-8f70-1a2b3c4d5e6f"

source_kind
enum<string>
required

De onde vêm os lançamentos comparados.

Available options:
ACCOUNT,
CREDIT_CARD
Example:

"ACCOUNT"

source_transaction_id
string
required

Lançamento que originou a regra.

Example:

"8f1c2a34-5b6d-4e7f-8a9b-0c1d2e3f4a5b"

available_criteria
object[]

Critérios que o lançamento de origem oferece.

createdAt
string<date-time>

Criação.

Example:

"2026-09-01T09:00:00.000Z"

fingerprint
string

Assinatura dos critérios (evita regras duplicadas).

Example:

"sha256:4f2a…"

profile_id
string | null

Perfil de Acesso / empresa.

Example:

null

subcategory_id
string | null

Subcategoria aplicada.

Example:

"d7e8f9a0-b1c2-4d3e-8f4a-5b6c7d8e9f0a"

updatedAt
string<date-time>

Última alteração.

Example:

"2026-09-15T14:32:10.000Z"

user_id
string | null

Dono.

Example:

"0d6b923c-3392-424e-a152-2ee32474e8d5"