9.6 KiB
{{classname}}
All URIs are relative to https://demo.firefly-iii.org/api
| Method | HTTP request | Description |
|---|---|---|
| DeleteObjectGroup | Delete /v1/object-groups/{id} | Delete a object group. |
| GetObjectGroup | Get /v1/object-groups/{id} | Get a single object group. |
| ListBillByObjectGroup | Get /v1/object-groups/{id}/bills | List all bills with this object group. |
| ListObjectGroups | Get /v1/object-groups | List all oject groups. |
| ListPiggyBankByObjectGroup | Get /v1/object-groups/{id}/piggy-banks | List all piggy banks related to the object group. |
| UpdateObjectGroup | Put /v1/object-groups/{id} | Update existing object group. |
DeleteObjectGroup
DeleteObjectGroup(ctx, id, optional) Delete a object group.
Delete a object group.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the object group. | |
| optional | *ObjectGroupsApiDeleteObjectGroupOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ObjectGroupsApiDeleteObjectGroupOpts 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]
GetObjectGroup
ObjectGroupSingle GetObjectGroup(ctx, id, optional) Get a single object group.
Get a single object group.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the object group. | |
| optional | *ObjectGroupsApiGetObjectGroupOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ObjectGroupsApiGetObjectGroupOpts 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]
ListBillByObjectGroup
BillArray ListBillByObjectGroup(ctx, id, optional) List all bills with this object group.
List all bills with this object group.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the account. | |
| optional | *ObjectGroupsApiListBillByObjectGroupOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ObjectGroupsApiListBillByObjectGroupOpts 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]
ListObjectGroups
ObjectGroupArray ListObjectGroups(ctx, optional) List all oject groups.
List all oject groups.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *ObjectGroupsApiListObjectGroupsOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ObjectGroupsApiListObjectGroupsOpts 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]
ListPiggyBankByObjectGroup
PiggyBankArray ListPiggyBankByObjectGroup(ctx, id, optional) List all piggy banks related to the object group.
This endpoint returns a list of all the piggy banks connected to the object group.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| id | string | The ID of the account. | |
| optional | *ObjectGroupsApiListPiggyBankByObjectGroupOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ObjectGroupsApiListPiggyBankByObjectGroupOpts 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]
UpdateObjectGroup
ObjectGroupSingle UpdateObjectGroup(ctx, body, title, order, id, optional) Update existing object group.
Update existing object group.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| body | ObjectGroupUpdate | JSON array with updated piggy bank information. See the model for the exact specifications. | |
| title | string | ||
| order | int32 | ||
| id | string | The ID of the object group | |
| optional | *ObjectGroupsApiUpdateObjectGroupOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a ObjectGroupsApiUpdateObjectGroupOpts 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]