Sign in
insight

Insight into transfers, grouped by account.

This endpoint gives a summary of the transfers made by the user, grouped by asset account or lability.

get/v1/insight/transfer/asset

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 transfers between 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 asset accounts and transfer details. Each asset account 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 total amount transferred between start date and end date, a number defined as a string, for this asset account.

difference_floatnumber double

The total amount transferred between start date and end date, a number as a float, for this asset account. May have rounding errors.

instring string

The total amount transferred TO this account between start date and end date, a number defined as a string, for this asset account.

in_floatnumber double

The total amount transferred FROM this account between start date and end date, a number as a float, for this asset account. May have rounding errors.

outstring string

The total amount transferred FROM this account between start date and end date, a number defined as a string, for this asset account.

out_floatnumber double

The total amount transferred TO this account between start date and end date, a number as a float, for this asset account. 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,
    "in": "123.45",
    "in_float": 123.45,
    "out": "123.45",
    "out_float": 123.45,
    "currency_id": "5",
    "currency_code": "EUR"
  }
]

Changes

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