Upvest API Documentation
Operating Model:
Upvest API Documentation
Operating Model:

Reports

Download Spec

All reports related paths.

List user reports

get /users/{user_id}/reports

List user reports

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

reports:read

All Scopes

  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:read · Read reports
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

user_id

string

uuid

required

User unique identifier.

type

string

Filters the list to only show reports of a certain type (e.g. only buy order confirmations)

Enum
  • BUY_ORDER
  • SELL_ORDER
  • INCOME_DISTRIBUTION
  • GENERAL_MEETING_NOTIFICATION
  • INCOME_REINVESTMENT
  • FUND_COMMUNICATION
  • TAX_REFUND
  • TAX_EXEMPTION_CREATION
  • CANCELLED_ORDER
  • REVOKED_ORDER
  • ACCOUNT_OPENING
  • ACCOUNT_CLOSING
  • DIRECT_DEBIT_MANDATE
  • ANNUAL_TAX_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • GENERIC_COMMUNICATION
  • BANK_ACCOUNT_CONNECTED
Example
"BUY_ORDER"

instrument

One Of

Filters the list to only include reports concerning specified instrument

Example
"uuid:ebabcf4d-61c3-4942-875c-e265a7c2d062"

International securities identification number, prefixed with string 'isin:'

string

^isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number, prefixed with string 'isin:'

Unique identifier, prefixed with string 'uuid:'

string

^uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Unique identifier, prefixed with string 'uuid:'

start_date

string

date

Returns reports generated starting from and including this date (UTC)

Example
"2020-08-21"

end_date

string

date

Returns reports generated up until this date (UTC)

Example
"2020-09-25"

sort

string

Field of resource to sort by

Default
"created_at"
Enum
  • id
  • type
  • created_at
Example
"id"

order

string

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

limit

int

i32

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

Default
100
Min
0
Max
1000

offset

int

i32

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

Min
0

Responses

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/json

meta

object (meta)

required

offset

int

required

Amount of resource to offset in the response.

limit

int

required

Total limit of the response.

count

int

required

Count of the resources returned in the response.

total_count

int

required

Total count of all the resources.

sort

string

required

The field that the list is sorted by.

order

string

required

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum
  • ASC
  • DESC

data

array[object (Report)]

required

Report

object (Report)

id

string

uuid

required

Report unique identifier.

created_at

string

date-time

required

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

user_id

string

uuid

required

User unique identifier.

type

string

required

Report type

  • BUY_ORDER - Buy order
  • SELL_ORDER - Sell order
  • INCOME_DISTRIBUTION - Income distribution report
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • FUND_COMMUNICATION - Generic fund communication
  • TAX_REFUND - Tax refund document (after tax optimization)
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • ACCOUNT_OPENING - Securities account opening
  • ACCOUNT_CLOSING - Securities account closure
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • GENERIC_COMMUNICATION - Generic communication
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
Enum
  • BUY_ORDER
  • SELL_ORDER
  • INCOME_DISTRIBUTION
  • GENERAL_MEETING_NOTIFICATION
  • INCOME_REINVESTMENT
  • FUND_COMMUNICATION
  • TAX_REFUND
  • TAX_EXEMPTION_CREATION
  • CANCELLED_ORDER
  • REVOKED_ORDER
  • ACCOUNT_OPENING
  • ACCOUNT_CLOSING
  • DIRECT_DEBIT_MANDATE
  • ANNUAL_TAX_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • GENERIC_COMMUNICATION
  • BANK_ACCOUNT_CONNECTED

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

data

object (data)

Contents of the reports.

account

object (account)

Account information.

id

string

uuid

Account unique identifier.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Examples

{
  "data": [
    {
      "created_at": "2020-08-24T14:15:22Z",
      "data": {
        "account": {
          "id": "a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"
        }
      },
      "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
      "substituted_report_id": null,
      "type": "BUY_ORDER",
      "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5"
    }
  ],
  "meta": {
    "count": 1,
    "limit": 100,
    "offset": 0,
    "order": "ASC",
    "sort": "id",
    "total_count": 1
  }
}
{
  "status": 400,
  "type": "bad_request"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Retrieve a user report

get /reports/{report_id}

Retrieve a user report

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

reports:read

All Scopes

  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:read · Read reports
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

accept

string

Report format

Default
"application/json"
Enum
  • application/json
  • application/pdf

report_id

string

uuid

required

Report unique identifier.

Responses

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/json

id

string

uuid

required

Report unique identifier.

created_at

string

date-time

required

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

user_id

string

uuid

required

User unique identifier.

type

string

required

Report type

  • BUY_ORDER - Buy order
  • SELL_ORDER - Sell order
  • INCOME_DISTRIBUTION - Income distribution report
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • FUND_COMMUNICATION - Generic fund communication
  • TAX_REFUND - Tax refund document (after tax optimization)
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • ACCOUNT_OPENING - Securities account opening
  • ACCOUNT_CLOSING - Securities account closure
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • GENERIC_COMMUNICATION - Generic communication
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
Enum
  • BUY_ORDER
  • SELL_ORDER
  • INCOME_DISTRIBUTION
  • GENERAL_MEETING_NOTIFICATION
  • INCOME_REINVESTMENT
  • FUND_COMMUNICATION
  • TAX_REFUND
  • TAX_EXEMPTION_CREATION
  • CANCELLED_ORDER
  • REVOKED_ORDER
  • ACCOUNT_OPENING
  • ACCOUNT_CLOSING
  • DIRECT_DEBIT_MANDATE
  • ANNUAL_TAX_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • GENERIC_COMMUNICATION
  • BANK_ACCOUNT_CONNECTED

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

data

object (data)

Contents of the reports.

account

object (account)

Account information.

id

string

uuid

Account unique identifier.

Response: application/pdf

Report

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Headers

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Response: application/problem+json

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

Response Examples

{
  "created_at": "2020-08-24T14:15:22Z",
  "data": {
    "account": {
      "id": "a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"
    }
  },
  "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
  "substituted_report_id": null,
  "type": "BUY_ORDER",
  "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

User reports events

webhook

User reports events

application/json

created_at

string

date-time

required

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

id

string

uuid

required

Event unique identifier

object

object (object)

required

created_at

string

date-time

required

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

data

object (data)

Contents of the reports.

account

object (account)

Account information.

id

string

uuid

Account unique identifier.

id

string

uuid

required

Report unique identifier.

substituted_report_id

One Of

required

null

null

Substituted Report unique identifier.

string

uuid

References report that has been replaced by this one.

type

string

required

Report type

  • BUY_ORDER - Buy order
  • SELL_ORDER - Sell order
  • INCOME_DISTRIBUTION - Income distribution report
  • GENERAL_MEETING_NOTIFICATION - General meeting notification
  • INCOME_REINVESTMENT - Reinvestment billing report (accumulating funds)
  • FUND_COMMUNICATION - Generic fund communication
  • TAX_REFUND - Tax refund document (after tax optimization)
  • TAX_EXEMPTION_CREATION - Creation of exemption order ("Freistellungsauftrag")
  • CANCELLED_ORDER - Cancelled buy or sell order (not yet executed, user cancels or trading venue cancelled)
  • REVOKED_ORDER - Revoked buy or sell order ("Storno")
  • ACCOUNT_OPENING - Securities account opening
  • ACCOUNT_CLOSING - Securities account closure
  • DIRECT_DEBIT_MANDATE - Creation of SEPA direct debit mandate
  • ANNUAL_TAX_STATEMENT - Annual tax reporting
  • ANNUAL_ACCOUNT_STATEMENT - Annual account statement
  • ANNUAL_INCOME_STATEMENT - Annual tax income statement ("Erträgnisaufstellung")
  • GENERIC_COMMUNICATION - Generic communication
  • BANK_ACCOUNT_CONNECTED - Connect reference bank account
Enum
  • BUY_ORDER
  • SELL_ORDER
  • INCOME_DISTRIBUTION
  • GENERAL_MEETING_NOTIFICATION
  • INCOME_REINVESTMENT
  • FUND_COMMUNICATION
  • TAX_REFUND
  • TAX_EXEMPTION_CREATION
  • CANCELLED_ORDER
  • REVOKED_ORDER
  • ACCOUNT_OPENING
  • ACCOUNT_CLOSING
  • DIRECT_DEBIT_MANDATE
  • ANNUAL_TAX_STATEMENT
  • ANNUAL_ACCOUNT_STATEMENT
  • ANNUAL_INCOME_STATEMENT
  • GENERIC_COMMUNICATION
  • BANK_ACCOUNT_CONNECTED

user_id

string

uuid

required

User unique identifier.

type

string

required

Event type

Default
"REPORT.CREATED"
Enum
  • REPORT.CREATED

webhook_id

string

uuid

required

Webhook unique identifier.

Responses

Request Examples

{
  "created_at": "2021-07-21T14:10:00.00Z",
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "object": {
    "created_at": "2020-08-24T14:15:22Z",
    "data": {
      "account": {
        "id": "a9a4ad54-6dd1-419a-a98d-ab48f9f23bc8"
      }
    },
    "id": "b96b1ee7-d491-43eb-b5e4-4833af9c9c2f",
    "substituted_report_id": null,
    "type": "BUY_ORDER",
    "user_id": "d1a4be99-8bb6-4e78-b897-8168f6823ab5"
  },
  "type": "REPORT.CREATED",
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Was this page helpful?