Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-08-0715707.5 MB
Fees

Create a fee collection

Creates a fee collection for pre-calculated fee amounts.

post/fees/collections

Headers

idempotency-keystring uuid required
Example:ccb07f42-4104-44ad-8e1f-c660bb7b269c

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

Request body

account_idstring uuid required

Account unique identifier.

type'SERVICE_FEE' | 'SERVICE_FEE_LIQUIDATION' 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
collection_amountstring required
currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling
period_startstring date required

Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

period_endstring date required

End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

Response

Fee collection created.

idstring uuid required

Fee collection unique identifier.

created_atstring date-time required

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

updated_atstring date-time required

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

account_idstring uuid required

Account unique identifier.

account_group_idstring uuid required

Account group unique identifier.

type'SERVICE_FEE' | 'SERVICE_FEE_LIQUIDATION' 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
collection_amountstring required
currency'EUR' | 'GBP' required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling
status'PROCESSING' | 'FINALISED' | 'CANCELLED' 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.
period_startstring date required

Start date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

period_endstring date required

End date of the fee collection period in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

replaced_collection_idstring uuid

Fee collection unique identifier.