Fees
Download SpecAll fees related paths.
account_id
string
uuid
Filters the list to show only fees associated with a specific account ID.
- Example
- "413715f2-5401-4b97-8055-034a6b879f8c"
account_group_id
string
uuid
Filters the list to show only fees associated with a specific account group ID.
- Example
- "72da9e41-9926-419f-976e-4c8069a04249"
sort
string
Field of resource to sort by.
- Default
- "created_at"
- Enum
-
- created_at
- updated_at
- Example
- "created_at"
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
offset
int
int32
Use the offset argument to specify where in the list of results to start when returning items for a particular query.
- Min
- 0
limit
int
int32
Use the limit argument to specify the maximum number of items returned.
- Default
- 100
- Min
- 0
- Max
- 1000
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"
oauth-client-credentials
Required Scopes:
fees:readfees:admin Returns a list of fee collections.
All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
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 -
files:read· Read files metadata -
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 -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
securities_transfers:admin· Securities Transfers operations -
securities_transfers:read· Securities Transfers read transfers -
taxes:admin· Modify tax residencies and tax exemptions -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
Response
OK
{
"meta": {
"offset": 0,
"limit": 100,
"count": 3,
"total_count": 3,
"sort": "id",
"order": "ASC"
},
"data": [
{
"id": "d77e6924-9bb7-4db0-addc-404442258f4b",
"created_at": "2022-11-30T14:16:22Z",
"updated_at": "2022-11-30T14:16:22Z",
"account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
"account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
"type": "SERVICE_FEE",
"collection_amount": "12.41",
"processed_amount": {
"cash_balance": "6.50",
"sell_to_cover": "0"
},
"currency": "EUR",
"status": "PROCESSING",
"period_start": "2022-11-01",
"period_end": "2022-11-30"
},
{
"id": "7c5f2b11-7078-4bb9-8ed8-9dcf5eb7597f",
"created_at": "2022-11-30T14:16:22Z",
"updated_at": "2022-11-30T14:16:22Z",
"account_id": "5b8b1e66-cf3c-40f3-94d3-c94f2ac7abb7",
"account_group_id": "87805651-ad25-4a85-8c04-88a666164ad4",
"type": "SERVICE_FEE",
"collection_amount": "82.12",
"processed_amount": {
"cash_balance": "40.00",
"sell_to_cover": "42.12"
},
"currency": "EUR",
"status": "FINALISED",
"period_start": "2022-09-01",
"period_end": "2022-12-31"
},
{
"id": "85fba2a0-da2f-46ac-a2a8-b4e7c66cb375",
"created_at": "2022-11-30T14:16:22Z",
"updated_at": "2022-11-30T14:16:22Z",
"account_id": "c28b6611-7ac1-405a-8eb7-ab3b35caccc2",
"account_group_id": "f930f9d4-3e21-4ad5-a266-730821d9a9fc",
"type": "SERVICE_FEE_LIQUIDATION",
"collection_amount": "65.30",
"processed_amount": {
"cash_balance": "0.00",
"sell_to_cover": "0.00"
},
"currency": "EUR",
"status": "CANCELLED",
"period_start": "2022-03-01",
"period_end": "2022-07-30"
}
]
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad Request. The incoming request had a malformed parameter/object.
{
"status": 400,
"type": "bad_request"
}Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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
The field that the list is sorted by.
order
string
The ordering of the response.
- ASC - Ascending order
- DESC - Descending order
- Enum
-
- ASC
- DESC
data
array[object (Fee Collection)]
required
Fee Collection
object (Fee Collection)
id
string
uuid
required
Fee collection unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
account_id
string
uuid
required
Account unique identifier.
account_group_id
string
uuid
required
Account group unique identifier.
type
string
required
Type of the fee collection
- SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)
- SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation
- Enum
-
- SERVICE_FEE
- SERVICE_FEE_LIQUIDATION
collection_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
processed_amount
object (processed_amount)
required
cash_balance
string
^[0-9]{1,9}(\.[0-9]{2})?$
sell_to_cover
string
^[0-9]{1,9}(\.[0-9]{2})?$
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
status
string
required
Status of the fee collection
- PROCESSING - Fee collection is in progress.
- FINALISED - Fees have been collected from the account and the funds has been transferred to the client.
- CANCELLED - Fee collection has been cancelled.
- Enum
-
- PROCESSING
- FINALISED
- CANCELLED
period_start
string
date
required
Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
period_end
string
date
required
End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Create a fee collection
Creates a fee collection for pre-calculated fee amounts.
account_id
string
uuid
required
Account unique identifier.
type
string
required
Type of the fee collection
- SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)
- SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation
- Enum
-
- SERVICE_FEE
- SERVICE_FEE_LIQUIDATION
collection_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
period_start
string
date
required
Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
period_end
string
date
required
End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
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"
idempotency-key
string
uuid
^[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$
required
A UUID to be used as an idempotency key. This prevents a duplicate request from being replayed. https://docs.upvest.co/documentation/concepts/api_concepts/idempotency
- Example
- "ccb07f42-4104-44ad-8e1f-c660bb7b269c"
oauth-client-credentials
Required Scopes:
fees:admin Creates a fee collection for pre-calculated fee amounts.
All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
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 -
files:read· Read files metadata -
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 -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
securities_transfers:admin· Securities Transfers operations -
securities_transfers:read· Securities Transfers read transfers -
taxes:admin· Modify tax residencies and tax exemptions -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
Request
{
"account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
"type": "SERVICE_FEE",
"collection_amount": "12.41",
"currency": "EUR",
"period_start": "2022-11-01",
"period_end": "2022-11-30"
}Response
Fee collection created.
{
"id": "d77e6924-9bb7-4db0-addc-404442258f4b",
"created_at": "2022-11-30T14:16:22Z",
"updated_at": "2022-11-30T14:16:22Z",
"account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
"account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
"type": "SERVICE_FEE",
"collection_amount": "12.41",
"processed_amount": {
"cash_balance": "6.50",
"sell_to_cover": "0"
},
"currency": "EUR",
"status": "PROCESSING",
"period_start": "2022-11-01",
"period_end": "2022-11-30"
}Empty response
Empty response
Empty response
Empty response
Empty response
Bad Request. The incoming request had a malformed parameter/object.
{
"status": 400,
"type": "bad_request"
}Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
id
string
uuid
required
Fee collection unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
account_id
string
uuid
required
Account unique identifier.
account_group_id
string
uuid
required
Account group unique identifier.
type
string
required
Type of the fee collection
- SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)
- SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation
- Enum
-
- SERVICE_FEE
- SERVICE_FEE_LIQUIDATION
collection_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
processed_amount
object (processed_amount)
required
cash_balance
string
^[0-9]{1,9}(\.[0-9]{2})?$
sell_to_cover
string
^[0-9]{1,9}(\.[0-9]{2})?$
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
status
string
required
Status of the fee collection
- PROCESSING - Fee collection is in progress.
- FINALISED - Fees have been collected from the account and the funds has been transferred to the client.
- CANCELLED - Fee collection has been cancelled.
- Enum
-
- PROCESSING
- FINALISED
- CANCELLED
period_start
string
date
required
Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
period_end
string
date
required
End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Get a fee collection by ID
Returns the fee collection specified by its ID.
fee_collection_id
string
uuid
required
Fee collection unique identifier.
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"
oauth-client-credentials
Required Scopes:
fees:readfees:admin Returns the fee collection specified by its ID.
All Scopes
-
account_liquidations:admin· Trigger/read/cancel accounts liquidations -
account_liquidations:read· Read accounts liquidations -
account_returns:read· Read accounts returns -
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 -
files:read· Read files metadata -
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 -
prices:read· Read instrument prices, -
reference_accounts:admin· Create/update/delete reference accounts -
reference_accounts:read· Read reference accounts -
reports:admin· Create reports -
reports:read· Read reports -
savings_plans:admin· Create/read savings plans -
savings_plans:read· Read savings plans -
securities_transfers:admin· Securities Transfers operations -
securities_transfers:read· Securities Transfers read transfers -
taxes:admin· Modify tax residencies and tax exemptions -
taxes:read· Read tax residencies -
tests:admin· Testing related operations -
topups:admin· Top-ups operations -
topups:read· Top-ups read operations -
transactions:read· Read cash and securities transactions -
users:admin· Create/update/delete users -
users:read· Read users -
valuations:read· Read valuations -
virtual_cash_balances:admin· Virtual cash balances -
webhooks:admin· Create/update/delete webhooks -
webhooks:read· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
Response
OK
{
"id": "d77e6924-9bb7-4db0-addc-404442258f4b",
"created_at": "2022-11-30T14:16:22Z",
"updated_at": "2022-11-30T14:16:22Z",
"account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
"account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
"type": "SERVICE_FEE",
"collection_amount": "12.41",
"processed_amount": {
"cash_balance": "6.50",
"sell_to_cover": "0"
},
"currency": "EUR",
"status": "PROCESSING",
"period_start": "2022-11-01",
"period_end": "2022-11-30"
}Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
id
string
uuid
required
Fee collection unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
account_id
string
uuid
required
Account unique identifier.
account_group_id
string
uuid
required
Account group unique identifier.
type
string
required
Type of the fee collection
- SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)
- SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation
- Enum
-
- SERVICE_FEE
- SERVICE_FEE_LIQUIDATION
collection_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
processed_amount
object (processed_amount)
required
cash_balance
string
^[0-9]{1,9}(\.[0-9]{2})?$
sell_to_cover
string
^[0-9]{1,9}(\.[0-9]{2})?$
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
status
string
required
Status of the fee collection
- PROCESSING - Fee collection is in progress.
- FINALISED - Fees have been collected from the account and the funds has been transferred to the client.
- CANCELLED - Fee collection has been cancelled.
- Enum
-
- PROCESSING
- FINALISED
- CANCELLED
period_start
string
date
required
Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
period_end
string
date
required
End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Fee collection events
id
string
uuid
required
Event unique identifier
created_at
string
date-time
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
- Enum
-
- FEE_COLLECTION.CREATED
- FEE_COLLECTION.FINALISED
- FEE_COLLECTION.CANCELLED
object
object (object)
required
id
string
uuid
required
Fee collection unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
account_id
string
uuid
required
Account unique identifier.
account_group_id
string
uuid
required
Account group unique identifier.
type
string
required
Type of the fee collection
- SERVICE_FEE - Service fee intake in a pre-defined cadence (e.g. monthly)
- SERVICE_FEE_LIQUIDATION - Service fee intake as a result of a Portfolio liquidation
- Enum
-
- SERVICE_FEE
- SERVICE_FEE_LIQUIDATION
collection_amount
string
^[0-9]{1,9}(\.[0-9]{2})?$
required
processed_amount
object (processed_amount)
required
cash_balance
string
^[0-9]{1,9}(\.[0-9]{2})?$
sell_to_cover
string
^[0-9]{1,9}(\.[0-9]{2})?$
currency
string
required
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- Default
- "EUR"
- Enum
-
- EUR
status
string
required
Status of the fee collection
- PROCESSING - Fee collection is in progress.
- FINALISED - Fees have been collected from the account and the funds has been transferred to the client.
- CANCELLED - Fee collection has been cancelled.
- Enum
-
- PROCESSING
- FINALISED
- CANCELLED
period_start
string
date
required
Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
period_end
string
date
required
End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339
webhook_id
string
uuid
required
Webhook unique identifier.
Request
{
"id": "38fc59d0-fc42-46ef-9512-824773219b2e",
"created_at": "2023-08-19T13:06:57.820371265Z",
"type": "FEE_COLLECTION.CREATED",
"webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b",
"object": {
"account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
"account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
"collection_amount": "12.41",
"created_at": "2022-11-30T14:16:22Z",
"currency": "EUR",
"id": "d77e6924-9bb7-4db0-addc-404442258f4b",
"period_start": "2022-11-01",
"period_end": "2022-11-30",
"processed_amount": {
"cash_balance": "0",
"sell_to_cover": "0"
},
"status": "PROCESSING",
"type": "SERVICE_FEE",
"updated_at": "2022-11-30T14:16:22Z"
}
}Response
Request has been processed successfully.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Was this page helpful?