go-firefly3/docs/ChartsApi.md
2024-05-11 14:45:50 +03:00

1.8 KiB

{{classname}}

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

Method HTTP request Description
GetChartAccountOverview Get /v1/chart/account/overview Dashboard chart with asset account balance information.

GetChartAccountOverview

[]ChartDataSet GetChartAccountOverview(ctx, start, end, optional) Dashboard chart with asset account balance information.

This endpoint returns the data required to generate a chart with basic asset account balance information.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
start string A date formatted YYYY-MM-DD.
end string A date formatted YYYY-MM-DD.
optional *ChartsApiGetChartAccountOverviewOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ChartsApiGetChartAccountOverviewOpts struct

Name Type Description Notes

xTraceId | optional.Interface of string| Unique identifier associated with this request. |

Return type

[]ChartDataSet

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]