List all transactions

GET

/transactions

const url = 'http://localhost:8000/api/v1/transactions?type=income&intent=investment_buy%2Cinvestment_return&limit=20';
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/transactions?type=income&intent=investment_buy%2Cinvestment_return&limit=20' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

type

string

Allowed values: income expense

Type of transaction (income/expense)

date_from

string format: date

Filter transactions from this date (YYYY-MM-DD)

date_to

string format: date

Filter transactions up to this date (YYYY-MM-DD)

wallet_ids[]

Array<integer>

Filter by wallet IDs

category_ids[]

Array<integer>

Filter by category IDs

search

string

Search transactions by description

intent

string

Example

investment_buy,investment_return

Filter by one or more transaction intents (comma-separated)

limit

integer

default: 20

Number of items to return per page

synced_since

string format: date-time

Get recent changes after this date

no_client_id

boolean

Get results with no client id

Responses

200

Successful operation

application/json

object

last_sync

string format: date-time

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"
        }
      ]
    }
  ]
}

400

Invalid transaction type