Sign in
insight

Insight into total income.

This endpoint gives a sum of the total income received by the user.

get/v1/insight/income/total

Query parameters

startstring date required

A date formatted YYYY-MM-DD.

endstring date required

A date formatted YYYY-MM-DD.

accounts[]integer[]

The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only deposits to those asset accounts / liabilities will be included. Other account ID's will be ignored.

[
  1,
  2,
  3
]

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Response

A list of sums in different currencies.

differencestring string

The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts.

difference_floatnumber double

The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.

currency_idstring string

The currency ID of the expenses listed for this expense account.

currency_codestring string

The currency code of the expenses listed for this expense account.

Example response

[
  {
    "difference": "123.45",
    "difference_float": 123.45,
    "currency_id": "5",
    "currency_code": "EUR"
  }
]

Changes

No recorded changes to this endpoint across all 1 revision of this API.