POST
Pré-visualizar regra

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.

Body

application/json

Informe transaction_id (regra nova a partir de um lançamento) ou rule_id (regra existente); match_fields simula outros critérios.

match_fields
string[]

Campos a comparar; omitido = sugestão automática.

Example:
rule_id
string | null

Regra existente a simular (alternativa a transaction_id).

Example:

null

transaction_id
string

Lançamento de origem de uma regra nova.

Example:

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

Response

Sucesso.

available_criteria
object[]
required

Critérios disponíveis no lançamento de origem.

is_expense
boolean
required

Se vale para despesas.

Example:

true

match_fields
string[]
required

Campos considerados nesta simulação.

Example:
matching_existing_count
integer
required

Quantos lançamentos existentes a regra atingiria.

Example:

14

source_id
string
required

Id da conta ou do cartão.

Example:

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

source_kind
enum<string>
required

Origem.

Available options:
ACCOUNT,
CREDIT_CARD
Example:

"ACCOUNT"

source_transaction_id
string
required

Lançamento de origem.

Example:

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

suggested_match_fields
string[]
required

Campos que a API sugere.

Example: