12 KiB
{{classname}}
All URIs are relative to https://demo.firefly-iii.org/api
| Method | HTTP request | Description |
|---|---|---|
| DeletePiggyBank | Delete /v1/piggy-banks/{id} | Delete a piggy bank. |
| GetPiggyBank | Get /v1/piggy-banks/{id} | Get a single piggy bank. |
| ListAttachmentByPiggyBank | Get /v1/piggy-banks/{id}/attachments | Lists all attachments. |
| ListEventByPiggyBank | Get /v1/piggy-banks/{id}/events | List all events linked to a piggy bank. |
| ListPiggyBank | Get /v1/piggy-banks | List all piggy banks. |
| StorePiggyBank | Post /v1/piggy-banks | Store a new piggy bank |
| UpdatePiggyBank | Put /v1/piggy-banks/{id} | Update existing piggy bank. |
DeletePiggyBank
DeletePiggyBank(ctx, id, optional) Delete a piggy bank.
Delete a piggy bank.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the piggy bank. | |
| optional | *PiggyBanksApiDeletePiggyBankOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a PiggyBanksApiDeletePiggyBankOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. |
Return type
(empty response body)
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetPiggyBank
PiggyBankSingle GetPiggyBank(ctx, id, optional) Get a single piggy bank.
Get a single piggy bank.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the piggy bank. | |
| optional | *PiggyBanksApiGetPiggyBankOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a PiggyBanksApiGetPiggyBankOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListAttachmentByPiggyBank
AttachmentArray ListAttachmentByPiggyBank(ctx, id, optional) Lists all attachments.
Lists all attachments.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the piggy bank. | |
| optional | *PiggyBanksApiListAttachmentByPiggyBankOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a PiggyBanksApiListAttachmentByPiggyBankOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. | limit | optional.Int32| Number of items per page. The default pagination is per 50 items. | page | optional.Int32| Page number. The default pagination is per 50 items. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListEventByPiggyBank
PiggyBankEventArray ListEventByPiggyBank(ctx, id, optional) List all events linked to a piggy bank.
List all events linked to a piggy bank (adding and removing money).
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the piggy bank | |
| optional | *PiggyBanksApiListEventByPiggyBankOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a PiggyBanksApiListEventByPiggyBankOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. | limit | optional.Int32| Number of items per page. The default pagination is per 50 items. | page | optional.Int32| Page number. The default pagination is per 50 items. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListPiggyBank
PiggyBankArray ListPiggyBank(ctx, optional) List all piggy banks.
List all piggy banks.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *PiggyBanksApiListPiggyBankOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a PiggyBanksApiListPiggyBankOpts struct
| Name | Type | Description | Notes |
|---|---|---|---|
| xTraceId | optional.Interface of string | Unique identifier associated with this request. | |
| limit | optional.Int32 | Number of items per page. The default pagination is per 50 items. | |
| page | optional.Int32 | Page number. The default pagination is per 50 items. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: Not defined
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
StorePiggyBank
PiggyBankSingle StorePiggyBank(ctx, body, name, accountId, targetAmount, currentAmount, startDate, targetDate, order, active, notes, objectGroupId, objectGroupTitle, optional) 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.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PiggyBankStore | JSON array or key=value pairs with the necessary piggy bank information. See the model for the exact specifications. | |
| name | string | ||
| accountId | string | ||
| targetAmount | string | ||
| currentAmount | string | ||
| startDate | string | ||
| targetDate | string | ||
| order | int32 | ||
| active | bool | ||
| notes | string | ||
| objectGroupId | string | ||
| objectGroupTitle | string | ||
| optional | *PiggyBanksApiStorePiggyBankOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a PiggyBanksApiStorePiggyBankOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdatePiggyBank
PiggyBankSingle UpdatePiggyBank(ctx, body, name, accountId, currencyId, currencyCode, targetAmount, currentAmount, startDate, targetDate, order, active, notes, objectGroupId, objectGroupTitle, id, optional) Update existing piggy bank.
Update existing piggy bank.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | PiggyBankUpdate | JSON array with updated piggy bank information. See the model for the exact specifications. | |
| name | string | ||
| accountId | string | ||
| currencyId | string | ||
| currencyCode | string | ||
| targetAmount | string | ||
| currentAmount | string | ||
| startDate | string | ||
| targetDate | string | ||
| order | int32 | ||
| active | bool | ||
| notes | string | ||
| objectGroupId | string | ||
| objectGroupTitle | string | ||
| id | string | The ID of the piggy bank | |
| optional | *PiggyBanksApiUpdatePiggyBankOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a PiggyBanksApiUpdatePiggyBankOpts struct
| Name | Type | Description | Notes |
|---|
xTraceId | optional.Interface of string| Unique identifier associated with this request. |
Return type
Authorization
firefly_iii_auth, local_bearer_auth
HTTP request headers
- Content-Type: application/json, application/x-www-form-urlencoded
- Accept: application/vnd.api+json, application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]