Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 1.36 KB

SummaryApi.md

File metadata and controls

41 lines (23 loc) · 1.36 KB
Raw

\SummaryApi

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

Method HTTP request Description
get_basic_summary GET /api/v1/summary/basic Returns basic sums of the users data.

get_basic_summary

Veccrate::models::BasicSummaryEntry get_basic_summary(start, end, currency_code) Returns basic sums of the users data.

Returns basic sums of the users data, like the net worth, spent and earned amounts. It is multi-currency, and is in Firefly III to populate the dashboard.

Parameters

Name Type Description Required Notes
start String A date formatted YYYY-MM-DD. [required]
end String A date formatted YYYY-MM-DD. [required]
currency_code Option<String> A currency code like EUR or USD, to filter the result.

Return type

Veccrate::models::BasicSummaryEntry

Authorization

firefly_iii_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]