transactions

Create a new transaction

Creates a new transaction with participants and split configuration

post/transactions

Request

  • Base URL: http://localhost:3001
  • URL: http://localhost:3001/transactions
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Request body

type'expense' | 'transfer' | 'income' required

Type of transaction

descriptionstring required

Description of the transaction

settlementKind'settle'

Marks a transfer as a settlement. Only 'settle' is accepted from clients; other kinds are set by backend settlement flows.

amountnumber required

Total amount of the transaction

currencystring required

Currency code (e.g., USD, EUR)

groupIdstring required

Group ID this transaction belongs to

recurringExpenseIdstring

Recurring expense ID if created by a recurring rule

categoryIdstring

Category ID for the transaction

transactionDatestring

Date of the transaction (ISO string)

billDataobject

Bill splitter data (JSONB)

Example request

{
  "description": "Dinner at restaurant",
  "paidIn": {
    "currency": "UYU",
    "amount": 28.57,
    "rate": 35
  },
  "amount": 50,
  "currency": "USD",
  "transactionDate": "2024-01-15"
}

Response

Transaction created successfully

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.