Store a new piggy bank

Creates a new piggy bank. The data required can be submitted as a JSON body or as a list of parameters.

post/v1/piggy-banks

Headers

X-Trace-Idstring uuid

Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

namestring string required

target_amountstring amount nullable required

current_amountstring amount

start_datestring date required

The date you started with this piggy bank.

target_datestring date nullable

The date you intend to finish saving money.

orderinteger

activeboolean

notesstring string nullable

object_group_idstring string nullable

The group ID of the group this object is part of. NULL if no group.

object_group_titlestring string nullable

The name of the group. NULL if no group.

Example request

{
  "name": "New digital camera",
  "accounts": [
    {
      "id": "3",
      "name": "Checking account",
      "current_amount": "123.45"
    }
  ],
  "target_amount": "123.45",
  "current_amount": "123.45",
  "start_date": "2026-08-01",
  "target_date": "2026-08-31",
  "order": 5,
  "active": true,
  "notes": "Some notes",
  "object_group_id": "5",
  "object_group_title": "Example Group"
}

Response

New piggy bank stored, result in response.

Changes

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