dinzo.api
Referência da APILançamentos

Buscar lançamento

Retorna um único lançamento por id, aceitando tanto ids persistidos (uuid) quanto handles projetados (mocked-recurrence:/mocked-installment:/mocked-bill:...). Projeções são resolvidas re-executando a visão mesclada na janela que as reproduz; 404 not_found (persistido) ou 404 projection_not_found (projeção inexistente).

GET
/v1/transactions/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Path Parameters

id*string

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/transactions/string"
{  "transaction": {    "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": [],    "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": null,    "holder_is_me": true,    "original_description": "PAO DE ACUCAR 1234 SAO PAULO BR",    "receipt_url": "https://cdn.dinzo.app/receipts/…/1755600000000-abc.jpg",    "open_finance": true  }}

POSTAtualizar ou excluir lançamentos em massa

Aplica uma atualização (`set`) ou exclusão (`delete: true`) a um conjunto de lançamentos, selecionados por `ids` (só ids persistidos, sem projeções mocked-*) e/ou `filter`, com `expected_count` opcional de guarda. Sujeito a rate limit próprio (10/hora). Retorna as contagens de itens afetados e ignorados.

PATCHEditar lançamento

Edita um lançamento persistido ou uma projeção. Para ids projetados de recorrência/parcela `scope` é obrigatório ('this' | 'future' | 'all'). Editar um handle de fatura (mocked-bill:) registra o pagamento; editar uma parcela projetada a materializa; editar uma ocorrência de recorrência materializa/bifurca a série. O corpo de resposta varia conforme o alvo — devolve os ids afetados e mensagens de orientação.