Fees
Download SpecAll fees related paths.
Authentication
oauth-client-credentials
Required Scopes:
fees:read
fees:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
meta
object (meta)
required
data
array[object (Fee Collection)]
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
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": [
{
"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_end": "2022-11-30",
"period_start": "2022-11-01",
"processed_amount": {
"cash_balance": "6.50",
"sell_to_cover": "0"
},
"status": "PROCESSING",
"type": "SERVICE_FEE",
"updated_at": "2022-11-30T14:16:22Z"
},
{
"account_group_id": "87805651-ad25-4a85-8c04-88a666164ad4",
"account_id": "5b8b1e66-cf3c-40f3-94d3-c94f2ac7abb7",
"collection_amount": "82.12",
"created_at": "2022-11-30T14:16:22Z",
"currency": "EUR",
"id": "7c5f2b11-7078-4bb9-8ed8-9dcf5eb7597f",
"period_end": "2022-12-31",
"period_start": "2022-09-01",
"processed_amount": {
"cash_balance": "40.00",
"sell_to_cover": "42.12"
},
"status": "FINALISED",
"type": "SERVICE_FEE",
"updated_at": "2022-11-30T14:16:22Z"
},
{
"account_group_id": "f930f9d4-3e21-4ad5-a266-730821d9a9fc",
"account_id": "c28b6611-7ac1-405a-8eb7-ab3b35caccc2",
"collection_amount": "65.30",
"created_at": "2022-11-30T14:16:22Z",
"currency": "EUR",
"id": "85fba2a0-da2f-46ac-a2a8-b4e7c66cb375",
"period_end": "2022-07-30",
"period_start": "2022-03-01",
"processed_amount": {
"cash_balance": "0.00",
"sell_to_cover": "0.00"
},
"status": "CANCELLED",
"type": "SERVICE_FEE_LIQUIDATION",
"updated_at": "2022-11-30T14:16:22Z"
}
],
"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": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Create a fee collection
Creates a fee collection for pre-calculated fee amounts.
Authentication
oauth-client-credentials
Required Scopes:
fees:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
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
currency
string
ISO4217
required
Three-letter ISO 4217 alphabetical 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
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.
Request Examples
{
"account_id": "689f7566-2ca3-4007-b99d-e501be8c7783",
"collection_amount": "12.41",
"currency": "EUR",
"period_end": "2022-11-30",
"period_start": "2022-11-01",
"type": "SERVICE_FEE"
}
Response Examples
{
"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_end": "2022-11-30",
"period_start": "2022-11-01",
"processed_amount": {
"cash_balance": "6.50",
"sell_to_cover": "0"
},
"status": "PROCESSING",
"type": "SERVICE_FEE",
"updated_at": "2022-11-30T14:16:22Z"
}
{
"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"
}
Get a fee collection by ID
Returns the fee collection specified by its ID.
Authentication
oauth-client-credentials
Required Scopes:
fees:read
fees:admin
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
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
currency
string
ISO4217
required
Three-letter ISO 4217 alphabetical 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
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
{
"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_end": "2022-11-30",
"period_start": "2022-11-01",
"processed_amount": {
"cash_balance": "6.50",
"sell_to_cover": "0"
},
"status": "PROCESSING",
"type": "SERVICE_FEE",
"updated_at": "2022-11-30T14:16:22Z"
}
{
"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"
}
Was this page helpful?