GET
Listar lançamentos

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

date
string

Mês de referência no formato YYYY-MM-DD (qualquer dia do mês). Padrão: mês atual.

Example:

"2026-09-01"

date_start
string

Início do intervalo (YYYY-MM-DD). Sobrepõe date quando usado com date_end.

Example:

"2026-09-01"

date_end
string

Fim do intervalo (YYYY-MM-DD).

Example:

"2026-09-30"

Busca por título/descrição.

Example:

"mercado"

category_ids
string[]

Filtra pelas categorias informadas. Também aceita a forma category_ids[].

Example:
subcategory_ids
string[]

Filtra pelas subcategorias informadas. Também aceita a forma subcategory_ids[].

Example:
tag_ids
string[]

Filtra pelas tags informadas. Também aceita a forma tag_ids[].

Example:
account_ids
string[]

Filtra pelas contas informadas (repita o parâmetro ou use account_ids[]). Também aceita a forma account_ids[].

Example:
credit_card_ids
string[]

Filtra pelos cartões informados. Também aceita a forma credit_card_ids[].

Example:
is_expense
enum<string>

"true" só despesas, "false" só receitas.

Available options:
true,
false
Example:

"true"

is_paid
enum<string>

"true" só pagos, "false" só pendentes.

Available options:
true,
false
Example:

"true"

account_type
enum<string>

Tipo de conta.

Available options:
PERSONAL_BANK,
BUSINESS_BANK,
INVESTMENT,
OTHER
Example:

"PERSONAL_BANK"

types
string[]

Tipos de lançamento (FIXED, RECURRENT, PARCELLED, TRANSFER); repita o parâmetro ou separe por vírgula. Também aceita a forma types[].

Example:
bill_id
string

Restringe à fatura informada.

Example:

"f6a7b8c9-d0e1-4f2a-8b3c-4d5e6f7a8b9c"

value
number

Valor exato em reais (ex.: 259.9).

Example:

259.9

hide_reconciled
boolean

Oculta lançamentos previstos que já foram conciliados.

Example:

true

order_by
string

Campo de ordenação.

Example:

"date"

order
enum<string>

Direção da ordenação.

Available options:
asc,
desc
Example:

"asc"

Response

Sucesso.

amount
integer
required

Valor, sempre positivo — o sinal vem de is_expense. Em centavos.

Example:

25990

createdAt
string<date-time>
required

Criação.

Example:

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

date
string<date-time>
required

Data do lançamento.

Example:

"2026-09-15T00:00:00.000Z"

id
string
required

Id do lançamento.

Example:

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

installments
integer
required

Quantidade de parcelas (1 quando à vista).

Example:

1

is_expense
boolean
required

true = despesa, false = receita.

Example:

true

paid
boolean
required

Pago/recebido.

Example:

true

title
string
required

Título.

Example:

"Supermercado Pão de Açúcar"

type
enum<string>
required

Tipo do lançamento.

Available options:
FIXED,
RECURRENT,
PARCELLED,
TRANSFER
Example:

"FIXED"

updatedAt
string<date-time>
required

Última alteração.

Example:

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

account
null | object

Conta expandida (quando o lançamento é de conta).

account_id
string | null

Conta (lançamentos de conta).

Example:

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

bill_id
string | null

Fatura à qual pertence.

Example:

null

billed_at
string<date-time> | null

Data de faturamento (cartão).

Example:

null

category
null | object

Categoria expandida, já traduzida/editada para o contexto.

category_id
string | null

Categoria.

Example:

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

competence_date
string<date-time> | null

Competência (Business).

Example:

null

connected_transaction_id
string | null

Liga as parcelas/recorrências de uma mesma série.

Example:

null

contact_id
string | null

Contato (Business).

Example:

null

cost_center_id
string | null

Centro de custo (Business).

Example:

null

credit_card
null | object

Cartão expandido (quando o lançamento é de cartão).

credit_card_id
string | null

Cartão (lançamentos de cartão — sempre pagos).

Example:

null

currency
string | null

Moeda.

Example:

"BRL"

description
string | null

Descrição livre.

Example:

"Compra do mês"

document_number
string | null

Número do documento (Business).

Example:

null

excluded_dates
string[]

Sempre vazio (campo legado).

Example:
frequency
enum<string>

Frequência (só faz sentido em RECURRENT).

Available options:
DAILY,
WEEKLY,
BIWEEKLY,
MONTHLY,
BIMONTHLY,
QUARTERLY,
SEMIANNUAL,
YEARLY
Example:

"MONTHLY"

installment_number
integer | null

Número desta parcela.

Example:

null

is_bill_payment
boolean | null

Se é o pagamento de uma fatura.

Example:

false

is_full_amount
boolean

Em parcelamentos, se amount foi informado como o total da compra.

Example:

false

is_previous_balance
boolean | null

Se é saldo anterior de fatura.

Example:

false

is_remote
boolean

Sempre true (campo legado).

Example:

true

logo_url
string | null

Logo do estabelecimento.

Example:

null

merchant_cnae
string | null

CNAE do estabelecimento (Open Finance).

Example:

null

merchant_cnpj
string | null

CNPJ do estabelecimento (Open Finance).

Example:

null

merchant_name
string | null

Nome do estabelecimento (Open Finance).

Example:

null

operation_type
string | null

Tipo de operação informado pelo banco (Open Finance).

Example:

null

paid_at
string<date-time> | null

Quando foi pago.

Example:

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

payment_dates
string[]

Sempre vazio (campo legado).

Example:
profile_id
string | null

Perfil de Acesso / empresa (nulo no contexto pessoal).

Example:

null

projected_date
string<date-time>

Data projetada da ocorrência (recorrências) — igual a date nos demais.

Example:

"2026-09-15T00:00:00.000Z"

projected_installment
integer | null

Número projetado da parcela (nulo fora de parcelamentos).

Example:

null

reconciled_at
string<date-time> | null

Quando foi conciliado.

Example:

null

reconciled_by_user_id
string | null

Quem conciliou.

Example:

null

reconciled_with
null | object

O pagamento real que substituiu este lançamento previsto (nulo quando não conciliado).

reconciled_with_transaction_id
string | null

Lançamento real com o qual este previsto foi conciliado.

Example:

null

reconciles
object[]

Lançamentos previstos que este pagamento real liquidou.

show_on_balance
boolean

Se entra no saldo.

Example:

true

subcategory
null | object

Subcategoria expandida.

subcategory_id
string | null

Subcategoria.

Example:

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

tags
object[]

Tags aplicadas.

total
integer

Valor a exibir: em parcelamentos com is_full_amount, a parcela; caso contrário igual a amount. Em centavos.

Example:

25990

user_id
string

Dono do lançamento.

Example:

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