Skip to content
/Tax Collections

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
Overview
URL

https://docs.upvest.co

Upvest API Support

api@upvest.co

License

Apache 2.0

Languages
Servers
Sandbox environment

https://sandbox.upvest.co/

Live environment

https://api.upvest.co/

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Tax Collection EventsWebhook

Request

Tax Collection Events

Bodyapplication/json
idstring(uuid)required

Event unique identifier

created_atstring(date-time)required

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

typestringrequired

Tax collection webhook type

  • TAX_COLLECTION.CREATED - Tax collection processing started successfully.
  • TAX_COLLECTION.FINALISED - Tax collection processing finalised successfully.
  • TAX_COLLECTION.CANCELLED - Tax collection processing cancelled successfully.
Enum"TAX_COLLECTION.CREATED""TAX_COLLECTION.FINALISED""TAX_COLLECTION.CANCELLED"
objectobjectrequired
idstring(uuid)required

Tax 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

typestringrequired

Type of the tax collection

  • TAX_PREPAYMENT_DE - German preliminary lump-sum tax payment
  • TAX_PAYMENT - Tax payment
Enum"TAX_PREPAYMENT_DE""TAX_PAYMENT"
collection_amountobjectrequired

Total amount of taxes to be collected

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

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
processed_amountobjectrequired

Processed amount details

cash_balanceobjectrequired

Taxes collected from the cash balance

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

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
sell_to_coverobjectrequired

Taxes collected by selling assets

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

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
offset_amountobjectrequired

Taxes collected by offsetting automatic corrections

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

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
statusstringrequired

Tax collection status

  • PROCESSING - The tax collection processing has started.
  • FINALISED - The tax collection has been processed successfully.
  • CANCELLED - The tax collection was cancelled.
Enum"PROCESSING""FINALISED""CANCELLED"
account_group_idstring(uuid)

Account Group Unique Identifier

instrumentobject

Instrument details

referencesArray of objects
webhook_idstring(uuid)required

Webhook unique identifier.

application/json
{
  "id": "38fc59d0-fc42-46ef-9512-824773219b2e",
  "created_at": "2024-08-19T13:06:57.820371265Z",
  "type": "TAX_COLLECTION.CREATED",
  "webhook_id": "1b097e06-8a14-4181-b72a-de0972a3c57b",
  "object": {
    "account_group_id": "999f7566-2ca3-4007-b99d-e501be8c7222",
    "collection_amount": { … },
    "id": "d77e6924-9bb7-4db0-addc-404442258f4b",
    "type": "TAX_PREPAYMENT_DE",
    "instrument": { … },
    "processed_amount": { … },
    "status": "PROCESSING",
    "updated_at": "2024-08-19T13:06:57.820371265Z",
    "created_at": "2024-08-19T13:06:57.820371265Z"
  }
}

Responses

Request has been processed successfully.

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Files

All files API related paths.

Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Tests

All test related paths.

Operations