Listar agenda

Devolve linhas de ocorrência expandida para despesas datadas do plano numa janela (predefinição hoje → +3 meses, máx. 36 meses). Opcionais boxId e query do nome da despesa. Valores convertidos para a baseCurrency do orçamento.

GET/v1/list_schedule

Consulta

Campo	Tipo	Obrigatório	Predefinição	Descrição
budgetId	string	Sim	—	Orçamento a projetar.
boxId	string	Não	—	Limitar a uma caixa de despesas.
fromDate	string	Não	today (UTC)	Início inclusivo `yyyy-MM-dd`.
toDate	string	Não	fromDate + 3mo	Fim inclusivo `yyyy-MM-dd` (janela ≤ 36 meses).
query	string	Não	—	Substring do nome da despesa sem diferenciar maiúsculas.
limit	number	Não	50	Máx. de ocorrências (1–100).

Formato da resposta: { items, hasMore }.

Resposta `data`

Campo	Tipo	Descrição
items	array	Linhas de ocorrência.
hasMore	boolean	Verdadeiro quando existem mais ocorrências além do limite.

Campos do item

Campo	Tipo	Descrição
date	string	Dia da ocorrência `yyyy-MM-dd`.
expenseId	string	Id da despesa do plano.
boxId	string	Id da caixa de despesas.
boxName	string	Nome da caixa de despesas.
name	string	Nome da despesa.
amount	number	Valor na moeda base do orçamento.
currency	string	Moeda base do orçamento.
originalAmount	number	Presente quando a moeda da despesa difere da base.
originalCurrency	string	Presente quando a moeda da despesa difere da base.

Request

curl --request GET \
  --url 'https://api.getliquify.com/v1/list_schedule?budgetId=bud_01&limit=50' \
  --header 'Authorization: Bearer <token>'

{
  "ok": true,
  "data": {
    "items": [
      {
        "date": "2026-11-05",
        "expenseId": "exp_01",
        "boxId": "box_01",
        "boxName": "Bills",
        "name": "Rent",
        "amount": 1200,
        "currency": "EUR"
      }
    ],
    "hasMore": false
  }
}

Consulta

Resposta data

Campos do item

Relacionado

Resposta `data`