Reporting

Transactions

Download Spec

All transactions related paths.

get/transactions/cash

List cash transactions

account_group_idstring

Filters the list to show only transactions associated with a certain account group ID.

Format: uuid
Example: "413715f2-5401-4b97-8055-034a6b879f8c"

start_datestring

Returns transactions starting from and including this date (UTC).

Format: date
Example: "2023-01-03"

end_datestring

Returns transactions up until this date (UTC)

Format: date
Example: "2023-01-11"

sortstring

Sort the result by booking_date.

Default: "booking_date"
Enum: booking_date

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

Responses

Response examples

Cash Transactions

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 2,
    "total_count": 2,
    "sort": "booking_date",
    "order": "ASC"
  },
  "data": [
    {
      "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
      "created_at": "2023-01-01",
      "updated_at": "2023-01-01",
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "booking_date": "2023-01-01",
      "delta": {
        "amount": "-305.00",
        "currency": "EUR"
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "taxes": [
        {
          "amount": "5.00",
          "currency": "EUR",
          "type": "TOTAL"
        }
      ],
      "type": "ORDER_EXECUTION",
      "value_date": "2023-01-01"
    },
    {
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "booking_date": "2023-01-01",
      "created_at": "2023-01-01",
      "delta": {
        "amount": "100.00",
        "currency": "EUR"
      },
      "id": "9e7a3188-eff8-11ed-a05b-0242ac120003",
      "references": [
        {
          "id": "98f01200-eff8-11ed-a05b-0242ac120003",
          "type": "DIRECT_DEBIT"
        }
      ],
      "taxes": [],
      "type": "SEPA_DIRECT_DEBIT",
      "updated_at": "2023-01-01",
      "value_date": "2023-01-01"
    }
  ]
}

get/transactions/securities

List securities transactions

account_group_idstring

Filters the list to only show transactions associated with a certain account group ID.

Format: uuid
Example: "413715f2-5401-4b97-8055-034a6b879f8c"

account_idstring

Filters the list to only show transactions associated with a certain account ID.

Format: uuid
Example: "413715f2-5401-4b97-8055-034a6b879f8c"

start_datestring

Returns transactions starting from and including this date (UTC)

Format: date
Example: "2023-01-03"

end_datestring

Returns transactions up until this date (UTC)

Format: date
Example: "2023-01-11"

sortstring

Sort the result by booking_date.

Default: "booking_date"
Enum: booking_date

orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default: "ASC"
Enum: ASC
DESC

offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format: int32
Min: 0

limitint

Use the limit argument to specify the maximum number of items returned.

Format: int32
Default: 100
Min: 0
Max: 1000

Responses

Response examples

Securities Transactions

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 2,
    "total_count": 2,
    "sort": "booking_date",
    "order": "ASC"
  },
  "data": [
    {
      "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
      "created_at": "2023-01-01",
      "updated_at": "2023-01-01",
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
      "booking_date": "2023-01-01",
      "delta": {
        "amount": "-2.5234543879"
      },
      "instrument": {
        "isin": "US0378331005",
        "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "type": "ORDER_EXECUTION",
      "value_date": "2023-01-01"
    },
    {
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
      "booking_date": "2023-01-01",
      "created_at": "2023-01-01",
      "delta": {
        "amount": "2.5234543879"
      },
      "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
      "instrument": {
        "isin": "US0378331005",
        "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "type": "ORDER_EXECUTION_CANCELLATION",
      "updated_at": "2023-01-01",
      "value_date": "2023-01-01"
    }
  ]
}

webhook

Cash transactions events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Default: "CASH_TRANSACTION.EXECUTED"
Enum: CASH_TRANSACTION.EXECUTED

objectobject (Cash Transaction)

required

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "55a877ce-effa-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01",
  "type": "CASH_TRANSACTION.EXECUTED",
  "object": {
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "account_id": "0255e6c4-effa-11ed-a05b-0242ac120003",
    "booking_date": "2023-01-01",
    "created_at": "2023-01-01",
    "delta": {
      "amount": "25.00",
      "currency": "EUR"
    },
    "instrument": {
      "isin": "US0378331005",
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
    },
    "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
    "references": [
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "CORPORATE_ACTION_TRANSACTION_ID"
      }
    ],
    "taxes": [
      {
        "amount": "2.00",
        "currency": "EUR",
        "type": "TOTAL"
      }
    ],
    "type": "CASH_DIVIDEND",
    "updated_at": "2023-01-01",
    "value_date": "2023-01-01"
  },
  "webhook_id": "9d3ac2e0-effa-11ed-a05b-0242ac120003"
}

Response examples

Request has been processed successfully.

Empty response

webhook

Security transactions events

idstring

required

Event unique identifier

Format: uuid

created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format: date-time

typestring

required

Event type

Default: "SECURITY_TRANSACTION.EXECUTED"
Enum: SECURITY_TRANSACTION.EXECUTED

objectobject (Security Transaction)

required

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "543c9996-eff6-11ed-a05b-0242ac120003",
  "created_at": "2023-01-01",
  "type": "SECURITY_TRANSACTION.EXECUTED",
  "object": {
    "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
    "created_at": "2023-01-01",
    "updated_at": "2023-01-01",
    "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
    "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
    "booking_date": "2023-01-01",
    "delta": {
      "amount": "-2.5234543879"
    },
    "instrument": {
      "isin": "US0378331005",
      "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321"
    },
    "references": [
      {
        "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
        "type": "ORDER_EXECUTION"
      },
      {
        "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
        "type": "ORDER"
      }
    ],
    "type": "ORDER_EXECUTION",
    "value_date": "2023-01-01"
  },
  "webhook_id": "3ae8a8a4-eff6-11ed-a05b-0242ac120003"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?