Sign in
insight

Insight into expenses, grouped by category.

This endpoint gives a summary of the expenses made by the user, grouped by (any) category.

get/v1/insight/expense/category

Query parameters

startstring date required

A date formatted YYYY-MM-DD.

endstring date required

A date formatted YYYY-MM-DD.

categories[]integer[]

The categories to be included in the results.

[
  1,
  2,
  3
]
accounts[]integer[]

The accounts to be included in the results. If you include ID's of asset accounts or liabilities, only withdrawals from 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 category and expense details. Each category has one row per currency.

idstring string

This ID is a reference to the original object.

namestring string

This is the name of the object.

differencestring string

The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts.

difference_floatnumber double

The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.

currency_idstring string

The currency ID of the expenses listed for this account.

currency_codestring string

The currency code of the expenses listed for this account.

Example response

[
  {
    "id": "123",
    "name": "Land lord",
    "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.