List transactions counted toward a budget's current period

GET

/budgets/{id}/transactions

const url = 'http://localhost:8000/api/v1/budgets/1/transactions?limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:8000/api/v1/budgets/1/transactions?limit=50' \
  --header 'Authorization: Bearer <token>'

Transactions that match the budget’s targets and fall inside the current period window. Ordered latest-first. Accepts limit query (default 50, max 200).

Authorizations

bearerAuth

Parameters

Path Parameters

required

integer

Query Parameters

limit

integer

default: 50 >= 1 <= 200

Number of transactions to return (1-200, default 50)

Responses

200

Transactions within the period

application/json

object

period_start

string format: date

period_end

string format: date

data

Array<object>

object

ID of the transaction

integer

type

required

Type of the transaction (income or expense)

string

Allowed values: income expense

amount

required

Amount of the transaction

number format: float

description

Description of the transaction

string

datetime

Date and time of the transaction

string format: date

categories

List of categories of the transaction

Array<integer>

is_recurring

Set the transaction as a recurring transaction

boolean

user_id

ID of the user who created the transaction

integer

amount_in_budget_currency

Transaction amount converted to the currency of the budget

string

transfer_id

ID of the associated transfer, if any

integer

wallet_client_generated_id

Client-generated ID of the associated wallet

string format: uuid

party_client_generated_id

Client-generated ID of the associated party

string format: uuid

files

Files attached to the transaction

Array<object>

object

ID of the file

integer

path

Path or content of the file

string

link

URL to access the file

string

type

Type of file (image, icon, emoji, pdf)

string

Allowed values: image pdf icon emoji

model

Related model name

string

model_id

ID of the related model

integer

recurring_rules

object

ID of the transaction

integer

transaction_id

ID of the transaction

integer

recurrence_period

Set how often the transaction should repeat

string

recurrence_interval

Set how often the transaction should repeat

integer

recurrence_ends_at

When the transaction stops repeating

string format: date-time

next_scheduled_at

When next the transaction should happen

string format: date-time

Example

{
  "data": [
    {
      "type": "income",
      "files": [
        {
          "type": "image"
        }
      ]
    }
  ]
}

404

Budget not found