Reports
Download SpecAll reports related paths.
Authentication
oauth-client-credentials
Required Scopes:
reports:read
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
meta
object (meta)
required
data
array[object (Report)]
required
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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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",
"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"
}
Authentication
oauth-client-credentials
Required Scopes:
reports:read
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
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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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
Conveying the HTTP status code; this is so that all information is in one place, but also to correct for changes in the status code due to the usage 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",
"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"
}
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",
"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?