banks2ff/firefly-iii-api/docs/ObjectGroupsApi.md

\ObjectGroupsApi

All URIs are relative to https://demo.firefly-iii.org/api

Method	HTTP request	Description
delete_object_group	DELETE /v1/object-groups/{id}	Delete a object group.
get_object_group	GET /v1/object-groups/{id}	Get a single object group.
list_bill_by_object_group	GET /v1/object-groups/{id}/bills	List all bills with this object group.
list_object_groups	GET /v1/object-groups	List all oject groups.
list_piggy_bank_by_object_group	GET /v1/object-groups/{id}/piggy-banks	List all piggy banks related to the object group.
update_object_group	PUT /v1/object-groups/{id}	Update existing object group.

delete_object_group

delete_object_group(id, x_trace_id) Delete a object group.

Delete a object group.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the object group.	[required]
x_trace_id	Option<uuid::Uuid>	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]

get_object_group

models::ObjectGroupSingle get_object_group(id, x_trace_id) Get a single object group.

Get a single object group.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the object group.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::ObjectGroupSingle

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]

list_bill_by_object_group

models::BillArray list_bill_by_object_group(id, x_trace_id, limit, page) List all bills with this object group.

List all bills with this object group.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the account.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::BillArray

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]

list_object_groups

models::ObjectGroupArray list_object_groups(x_trace_id, limit, page) List all oject groups.

List all oject groups.

Parameters

Name	Type	Description	Required	Notes
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::ObjectGroupArray

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]

list_piggy_bank_by_object_group

models::PiggyBankArray list_piggy_bank_by_object_group(id, x_trace_id, limit, page) List all piggy banks related to the object group.

This endpoint returns a list of all the piggy banks connected to the object group.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the account.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.
limit	Option<i32>	Number of items per page. The default pagination is per 50 items.
page	Option<i32>	Page number. The default pagination is per 50 items.

Return type

models::PiggyBankArray

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]

update_object_group

models::ObjectGroupSingle update_object_group(id, object_group_update, x_trace_id) Update existing object group.

Update existing object group.

Parameters

Name	Type	Description	Required	Notes
id	String	The ID of the object group	[required]
object_group_update	ObjectGroupUpdate	JSON array with updated piggy bank information. See the model for the exact specifications.	[required]
x_trace_id	Option<uuid::Uuid>	Unique identifier associated with this request.

Return type

models::ObjectGroupSingle

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]