Tax Collection Webhook
The webhook for tax collection makes it possible to inform end users about the ongoing process. This allows us to offer our clients real-time transparency so you can take action if a tax payment cannot be collected for various reasons, such as:
- the end user has no positions to sell
- the end user's account has been closed
The TAX_COLLECTION
webhook not only reports the pending tax collection for an end user, but also when a collection is unsuccessful and cancelled.
Tax collection webhooks are always sent if the tax collection amounts are greater than 0.00 EUR. Accordingly, this does not apply if the tax collection has been used up by an existing tax exemption.
Webhook Types
Webhook type | Status | Description | ||
---|---|---|---|---|
TAX_COLLECTION.CREATED | PROCESSING | This webhook is sent when the process is started and tax collection is created. | ||
TAX_COLLECTION.FINALISED | FINALISED | This webhook is sent when taxes are successfully collected. | ||
TAX_COLLECTION.CANCELLED | CANCELLED | This webhook is sent when the process has failed (e.g., no position for sale, etc.). |
Tax collection webhook objects
{
"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": {
"amount": "100.00",
"currency": "EUR"
},
"id": "d77e6924-9bb7-4db0-addc-404442258f4b",
"type": "TAX_PREPAYMENT_DE",
"instrument": {
"uuid": "d77e6924-9bb7-4db0-addc-404442258f4b",
"isin": "DE000A0D8QZ0"
},
"processed_amount": {
"cash_balance": {
"amount": "0.00",
"currency": "EUR"
},
"sell_to_cover": {
"amount": "0.00",
"currency": "EUR"
},
"offset_amount": {
"amount": "0.00",
"currency": "EUR"
}
},
"status": "PROCESSING",
"updated_at": "2024-08-19T13:06:57.820371265Z",
"created_at": "2024-08-19T13:06:57.820371265Z"
}
}
Parameter | Description |
---|---|
collection_amount | Indicates the total amount and currency in which the tax was collected. |
processed_amount | In the FINALISED status, this attribute contains the breakdown of how the taxes were collected (i.e. either in the form of cash or securities). |
Note: For now 100% of the amount will be allocated to sell_to_cover
.
In addition to this webhook, there are other options for tracking tax collections in the Investment API. See the following chapter Tracking tax collections.