dinzo.api
Referência da APILançamentos

Listar lançamentos

Lista a visão canônica mesclada (linhas persistidas + projeções mocked-*) dentro de uma janela from/to obrigatória (YYYY-MM-DD, máx. 366 dias), com filtros por conta, categoria, tag, tipo, status, subtipo, fatura, busca textual e ocultos. Retorna a página ordenada (dia mais novo primeiro, id ascendente dentro do dia) com paginação por cursor.

GET
/v1/transactions

Authorization

bearerAuth
AuthorizationBearer <token>

Chave de API no cabeçalho Authorization: Bearer dz_live_...

In: header

Query Parameters

from*string

Início da janela (YYYY-MM-DD), obrigatório.

to*string

Fim da janela (YYYY-MM-DD), obrigatório; máx. 366 dias.

view?string

cashflow (padrão: faturas na conta pagadora) ou ledger (linhas cruas por conta).

status?string

PENDING ou POSTED.

type?string

DEBIT ou CREDIT.

account_id?string

Ids de conta separados por vírgula.

category_id?string

Ids de categoria separados por vírgula.

include_subcategories?string

true (padrão) expande categorias-pai para subcategorias.

tag_id?string

Ids de tag separados por vírgula.

no_category?string

true: só lançamentos sem categoria.

no_tags?string

true: só lançamentos sem tags.

is_recurring?string

true: só lançamentos de recorrência.

is_installments?string

true: só parcelas.

bill_id?string

Id de fatura (mocked-bill:… ou id de fatura Open Finance): lançamentos daquele ciclo do cartão.

sub_type?string

Subtipos de conta separados por vírgula (SAVINGS_ACCOUNT, CHECKING_ACCOUNT, CREDIT_CARD).

hidden?string

true: só linhas ocultas; false/omitido: só visíveis.

search?string

Busca em descrição/notas/descrição original.

limit?string

Tamanho da página (padrão 50, máx. 100).

cursor?string

Cursor da página anterior (next_cursor).

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/transactions?from=string&to=string"
{  "data": [    {      "id": "9f2b6a1c-4e3d-4a2b-8c1e-2b7d5f0a1c33",      "projected": false,      "projection": null,      "date": "2026-08-19",      "type": "DEBIT",      "status": "POSTED",      "amount": 89.9,      "currency": "BRL",      "description": "Mercado Pao de Acucar",      "notes": null,      "account_id": "1a2b3c4d-5e6f-4a1b-9c8d-7e6f5a4b3c2d",      "bill_to_account_id": null,      "category_id": "c0ffee00-1111-4222-8333-444455556666",      "tags": [        {          "id": "7a11d00d-2222-4333-8444-555566667777",          "title": "Supermercado",          "color_hex": "#22C55E"        }      ],      "recurrence_id": null,      "recurrence_period_date": null,      "installment": null,      "transfer_group_id": null,      "created_by_user": false,      "source": "OPEN_FINANCE",      "hide_from_results": false,      "card_number": "4821",      "holder": "Stefanie",      "holder_is_me": false,      "original_description": "PAO DE ACUCAR 1234 SAO PAULO BR",      "receipt_url": null,      "open_finance": true    }  ],  "has_more": true,  "next_cursor": "eyJkIjoxNzU1NTY0ODAwMDAwLCJpZCI6IjlmMmI2YTFjLTRlM2QtNGEyYi04YzFlLTJiN2Q1ZjBhMWMzMyJ9"}

GETConsultar limite usado do cartão

Retorna o limite utilizado, o limite total e o disponível de um cartão de crédito (valores com 2 casas decimais). Responde 400 quando a conta não é cartão de crédito e 404 quando não existe.

POSTCriar lançamento

Cria um lançamento simples, uma compra parcelada (`installments`) ou uma regra de recorrência (`recurrence`). Aceita `id` (uuid) do cliente para idempotência em criações simples (replay do mesmo payload devolve a linha com `deduped: true` e status 200; payload divergente devolve 409 id_conflict). Criação simples/parcelada devolve o lançamento criado (201); recorrência devolve o id da regra (201, ou 200 quando reaproveita uma regra equivalente).