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

Fees

Download Spec

All fees related paths.

Get fee collections

get /fees/collections

Returns a list of fee collections.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

fees:readfees:admin

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

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"

order

string

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

Default
"ASC"
Enum
  • ASC

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

limit

int

i32

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

Default
100
Min
0
Max
1000

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

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

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

{
  "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

post /fees/collections

Creates a fee collection for pre-calculated fee amounts.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

fees:admin

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

idempotency-key

string

uuid

required

Idempotency key to prevent the same request from replaying. https://datatracker.ietf.org/doc/id/draft-ietf-httpapi-idempotency-key-header-01.html

Example
"f1150421-2e34-42b6-aae9-52ef157065b9"

application/json

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

ISO4217

required

Three-letter ISO 4217 alphabetical 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

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

cash_balance

string

^[0-9]{1,9}(\.[0-9]{2})?$

sell_to_cover

string

^[0-9]{1,9}(\.[0-9]{2})?$

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

get /fees/collections/{fee_collection_id}

Returns the fee collection specified by its ID.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

fees:readfees:admin

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

fee_collection_id

string

uuid

required

Fee collection unique identifier.

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

cash_balance

string

^[0-9]{1,9}(\.[0-9]{2})?$

sell_to_cover

string

^[0-9]{1,9}(\.[0-9]{2})?$

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?