# Store a new piggy bank

`POST /v1/piggy-banks`

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

Authentication (security requirement alternatives):

```json
[
  {
    "firefly_iii_auth": []
  },
  {
    "local_bearer_auth": []
  }
]
```

- firefly_iii_auth: oauth2. OAuth2 authorization code flow. Create a client on your installation's `/profile` page; it authorizes at `/oauth/authorize` and issues tokens at `/oauth/token` there. The URLs below are the demo site's. [How to use the API](https://sourcey-firefly.pages.dev/how-to/firefly-iii/features/api/index.md) walks through it.
- local_bearer_auth: http (bearer). A Personal Access Token, sent as a bearer token. Create one on your installation under Options > Profile > OAuth > Personal Access Tokens.

Parameters:

- `X-Trace-Id` (header, string, uuid, optional) - Unique identifier associated with this request.
  Type: string, uuid
  
  Example:
  
  ```json
  "40c71bbb-c676-4f24-83cf-cc725d7d7a00"
  ```

Request body: application/json (required)

JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications.

Type: object

Schema: [PiggyBankStore](https://sourcey-firefly.pages.dev/api/models/piggybankstore/index.md)

- `name` (required)
  Type: string, string
  
  Example:
  
  ```json
  "New digital camera"
  ```

- `accounts` (optional)
  Type: array
  
  Items:
    Reference: [PiggyBankAccountStore](https://sourcey-firefly.pages.dev/api/models/piggybankaccountstore/index.md); Type: object

- `target_amount` (required)
  Type: string, amount; nullable
  
  Example:
  
  ```json
  "123.45"
  ```

- `current_amount` (optional)
  Type: string, amount
  
  Example:
  
  ```json
  "123.45"
  ```

- `start_date` (required)
  Type: string, date
  
  The date you started with this piggy bank.
  
  Example:
  
  ```json
  "2026-10-01"
  ```

- `target_date` (optional)
  Type: string, date; nullable
  
  The date you intend to finish saving money.
  
  Example:
  
  ```json
  "2026-10-31"
  ```

- `order` (optional)
  Type: integer, int32
  
  Example:
  
  ```json
  5
  ```

- `active` (optional)
  Type: boolean
  
  readOnly: true
  
  Example:
  
  ```json
  true
  ```

- `notes` (optional)
  Type: string, string; nullable
  
  Example:
  
  ```json
  "Some notes"
  ```

- `object_group_id` (optional)
  Type: string, string; nullable
  
  The group ID of the group this object is part of. NULL if no group.
  
  Example:
  
  ```json
  "5"
  ```

- `object_group_title` (optional)
  Type: string, string; nullable
  
  The name of the group. NULL if no group.
  
  Example:
  
  ```json
  "Example Group"
  ```

Request body: application/x-www-form-urlencoded (required)

JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications.

Type: object

Schema: [PiggyBankStore](https://sourcey-firefly.pages.dev/api/models/piggybankstore/index.md)

- `name` (required)
  Type: string, string
  
  Example:
  
  ```json
  "New digital camera"
  ```

- `accounts` (optional)
  Type: array
  
  Items:
    Reference: [PiggyBankAccountStore](https://sourcey-firefly.pages.dev/api/models/piggybankaccountstore/index.md); Type: object

- `target_amount` (required)
  Type: string, amount; nullable
  
  Example:
  
  ```json
  "123.45"
  ```

- `current_amount` (optional)
  Type: string, amount
  
  Example:
  
  ```json
  "123.45"
  ```

- `start_date` (required)
  Type: string, date
  
  The date you started with this piggy bank.
  
  Example:
  
  ```json
  "2026-10-01"
  ```

- `target_date` (optional)
  Type: string, date; nullable
  
  The date you intend to finish saving money.
  
  Example:
  
  ```json
  "2026-10-31"
  ```

- `order` (optional)
  Type: integer, int32
  
  Example:
  
  ```json
  5
  ```

- `active` (optional)
  Type: boolean
  
  readOnly: true
  
  Example:
  
  ```json
  true
  ```

- `notes` (optional)
  Type: string, string; nullable
  
  Example:
  
  ```json
  "Some notes"
  ```

- `object_group_id` (optional)
  Type: string, string; nullable
  
  The group ID of the group this object is part of. NULL if no group.
  
  Example:
  
  ```json
  "5"
  ```

- `object_group_title` (optional)
  Type: string, string; nullable
  
  The name of the group. NULL if no group.
  
  Example:
  
  ```json
  "Example Group"
  ```

Responses:

- 200: New piggy bank stored, result in response.

Content type: application/vnd.api+json

Type: object

Schema: [PiggyBankSingle](https://sourcey-firefly.pages.dev/api/models/piggybanksingle/index.md)

- `data` (required)
  Reference: [PiggyBankRead](https://sourcey-firefly.pages.dev/api/models/piggybankread/index.md); Type: object

- 400: Bad request

Content type: application/json

Type: object

Schema: [BadRequestResponse](https://sourcey-firefly.pages.dev/api/models/badrequestresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Bad Request"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "BadRequestHttpException"
  ```

- 401: Unauthenticated

Content type: application/json

Type: object

Schema: [UnauthenticatedResponse](https://sourcey-firefly.pages.dev/api/models/unauthenticatedresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Unauthenticated"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "AuthenticationException"
  ```

- 404: Page not found

Content type: application/json

Type: object

Schema: [NotFoundResponse](https://sourcey-firefly.pages.dev/api/models/notfoundresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Resource not found"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "NotFoundHttpException"
  ```

- 422: Validation error. The body will have the exact details.

Content type: application/json

Type: object

Schema: [ValidationErrorResponse](https://sourcey-firefly.pages.dev/api/models/validationerrorresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "The given data was invalid."
  ```

- `errors` (optional)
  Type: object
  
  - `email` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `force` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `blocked` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `field` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `role` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `blocked_code` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `name` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `type` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `iban` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `start` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `end` (optional)
    Type: array
    
    Items:
      Type: string, string
  
  - `date` (optional)
    Type: array
    
    Items:
      Type: string, string

- 500: Internal exception

Content type: application/json

Type: object

Schema: [InternalExceptionResponse](https://sourcey-firefly.pages.dev/api/models/internalexceptionresponse/index.md)

- `message` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "Internal Exception"
  ```

- `exception` (optional)
  Type: string, string
  
  Example:
  
  ```json
  "InternalException"
  ```

## Examples

### cURL

```bash
curl -X POST 'https://firefly.example.com/api/v1/piggy-banks' \
  -H 'X-Trace-Id: 40c71bbb-c676-4f24-83cf-cc725d7d7a00' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "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-10-01",
  "target_date": "2026-10-31",
  "order": 5,
  "notes": "Some notes",
  "object_group_id": "5",
  "object_group_title": "Example Group"
}'
```

### JavaScript

```javascript
const body = `{
  "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-10-01",
  "target_date": "2026-10-31",
  "order": 5,
  "notes": "Some notes",
  "object_group_id": "5",
  "object_group_title": "Example Group"
}`;

const response = await fetch('https://firefly.example.com/api/v1/piggy-banks', {
  method: 'POST',
  headers: {
    'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();
```

### Python

```python
import requests

body = '''{
  "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-10-01",
  "target_date": "2026-10-31",
  "order": 5,
  "notes": "Some notes",
  "object_group_id": "5",
  "object_group_title": "Example Group"
}'''

response = requests.post(
    'https://firefly.example.com/api/v1/piggy-banks',
    data=body.encode('utf-8'),
    headers={
        'X-Trace-Id': '40c71bbb-c676-4f24-83cf-cc725d7d7a00',
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)
```