API

Download the json formatted openapi spec here.

transactions

GET /api/v1/groups/{group_id}/transactions

list all transactions in a group

Parameters:

  • group_id (integer)

Query Parameters:

  • min_last_changed ({'date-time', 'null'})

  • transaction_ids ({'string', 'null'})

Status Codes:
POST /api/v1/groups/{group_id}/transactions

create a new transaction

Parameters:

  • group_id (integer)

Status Codes:
GET /api/v1/groups/{group_id}/transactions/{transaction_id}

get transaction details

Parameters:

  • group_id (integer)

  • transaction_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/transactions/{transaction_id}

update transaction details

Parameters:

  • group_id (integer)

  • transaction_id (integer)

Status Codes:
DELETE /api/v1/groups/{group_id}/transactions/{transaction_id}

delete a transaction

Parameters:

  • group_id (integer)

  • transaction_id (integer)

Status Codes:
GET /api/v1/groups/{group_id}/transactions/{transaction_id}/history

get transaction history

Parameters:

  • group_id (integer)

  • transaction_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/transactions/{transaction_id}/positions

update transaction positions

Parameters:

  • group_id (integer)

  • transaction_id (integer)

Status Codes:
GET /api/v1/files/{file_id}/{blob_id}

fetch the (binary) contents of a transaction attachment

Parameters:

  • file_id (integer)

  • blob_id (integer)

Status Codes:
GET /api/v1/{group_id}/currency-conversion-rates/{base_currency}

get the currency conversion rate

Parameters:

  • group_id (integer)

  • base_currency (string)

Status Codes:

groups

POST /api/v1/groups/preview

preview a group before joining using an invite token

Status Codes:
POST /api/v1/groups/join

join a group using an invite token

Status Codes:
GET /api/v1/groups

list the current users groups

Status Codes:
POST /api/v1/groups

create a group

Status Codes:
GET /api/v1/groups/{group_id}

fetch group details

Parameters:

  • group_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}

update group details

Parameters:

  • group_id (integer)

Status Codes:
DELETE /api/v1/groups/{group_id}

delete a group

Parameters:

  • group_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/leave

leave a group

Parameters:

  • group_id (integer)

Status Codes:
GET /api/v1/groups/{group_id}/members

list all members of a group

Parameters:

  • group_id (integer)

Status Codes:
GET /api/v1/groups/{group_id}/logs

fetch the group log

Parameters:

  • group_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/send_message

post a message to the group log

Parameters:

  • group_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/members/{user_id}

update the permissions of a group member

Parameters:

  • group_id (integer)

  • user_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/members/{user_id}/owned-account

update the owned account of a group member

Parameters:

  • group_id (integer)

  • user_id (integer)

Status Codes:
GET /api/v1/groups/{group_id}/invites

list all invite links of a group

Parameters:

  • group_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/invites

create a new group invite link

Parameters:

  • group_id (integer)

Status Codes:
DELETE /api/v1/groups/{group_id}/invites/{invite_id}

delete a group invite link

Parameters:

  • group_id (integer)

  • invite_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/archive

archive a group

Parameters:

  • group_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/un-archive

un-archive a group

Parameters:

  • group_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/export-json

un-archive a group

Parameters:

  • group_id (integer)

Status Codes:
POST /api/v1/import-group

import a group from json

Status Codes:

auth

POST /api/v1/auth/token

login with username and password

Status Codes:
POST /api/v1/auth/login

login with username and password

Status Codes:
POST /api/v1/auth/logout

sign out of the current session

Status Codes:
POST /api/v1/auth/register

register a new user

Status Codes:
POST /api/v1/auth/confirm_registration

confirm a pending registration

Status Codes:
GET /api/v1/profile

fetch user profile information

Status Codes:

  • 200 OK – Successful Response

POST /api/v1/profile/change_password

change password

Status Codes:
POST /api/v1/profile/change_email

change email

Status Codes:
POST /api/v1/auth/confirm_email_change

confirm a pending email change

Status Codes:
POST /api/v1/auth/recover_password

recover password

Status Codes:
POST /api/v1/auth/confirm_password_recovery

confirm a pending password recovery

Status Codes:
POST /api/v1/auth/delete_session

delete a given user session

Status Codes:
POST /api/v1/auth/rename_session

rename a given user session

Status Codes:

accounts

GET /api/v1/groups/{group_id}/accounts

list all accounts in a group

Parameters:

  • group_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/accounts

create a new group account

Parameters:

  • group_id (integer)

Status Codes:
GET /api/v1/groups/{group_id}/accounts/{account_id}

fetch a group account

Parameters:

  • group_id (integer)

  • account_id (integer)

Status Codes:
POST /api/v1/groups/{group_id}/accounts/{account_id}

update an account

Parameters:

  • group_id (integer)

  • account_id (integer)

Status Codes:
DELETE /api/v1/groups/{group_id}/accounts/{account_id}

delete an account

Parameters:

  • group_id (integer)

  • account_id (integer)

Status Codes:

common

GET /api/version

Get Version

Status Codes:

  • 200 OK – Successful Response

GET /api/config

Get Frontend Config

Status Codes:

  • 200 OK – Successful Response