Tax exemptions events
Whenever a requested change in tax exemptions has been processed, the client receives the complete response in a webhook. The webhook refers to the same tax exemption ID that was issued in the initial response.
To receive webhook updates, the consumer of the API must subscribe to the relevant webhooks; see "Create a webhook subscription".
The following table lists the possible webhook events in connection with tax exemptions:
Tax exemption created
The following example of a webhook response illustrates a successful tax exemption creation.
Example successful creation
{
"id": "295cf14f-368c-450e-b57e-48d115d30fe4",
"created_at": "2024-01-01T10:34:43Z",
"type": "TAX_EXEMPTION.CREATED",
"object": {
"id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1",
"created_at": "2024-01-01T10:33:43Z",
"updated_at": "2024-01-01T10:33:43Z",
"status": "ACTIVE",
"user_ids": [
"70821d79-366f-4873-804b-14857d690496"
],
"country": "DE",
"valid_from_date": "2024-01-01",
"valid_to_date": "2024-12-31",
"tax_exemption_details": {
"tax_exemption_type": "SINGLE",
"tax_exemption_amount": {
"amount": "1000.00",
"currency": "EUR"
},
"utilized_amount": {
"amount": "0.00",
"currency": "EUR"
},
"remaining_amount": {
"amount": "1000.00",
"currency": "EUR"
}
}
},
"webhook_id": "4a80c45f-204c-4498-ac20-d900a846e166"
}
Tax exemption creation failed
If the creation process fails, this is indicated in the webhook response as follows:
Example creation failed
{
"id": "2ce641a1-e89c-43be-b8d8-981d4aac5bd5",
"created_at": "2024-01-01T10:34:43Z",
"type": "TAX_EXEMPTION.CREATION_FAILED",
"object": {
"id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1",
"created_at": "2024-01-01T10:33:43Z",
"updated_at": "2024-01-01T10:33:43Z",
"reason": "Missing TIN",
"status": "CANCELLED",
"user_ids": [
"70821d79-366f-4873-804b-14857d690496"
]
},
"webhook_id": "606e3c01-c9cf-4073-900e-718bfc521953"
}
Tax exemption deleted
If a tax exemption order has been successfully deleted, the following webhook is triggered:
Example deletion successful
{
"id": "295cf14f-368c-450e-b57e-48d115d30fe4",
"created_at": "2024-01-01T10:34:43Z",
"type": "TAX_EXEMPTION.DELETED",
"object": {
"id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1",
"created_at": "2024-01-01T10:33:43Z",
"updated_at": "2024-09-01T01:13:03Z",
"status": "ACTIVE",
"user_ids": [
"70821d79-366f-4873-804b-14857d690496"
],
"country": "DE",
"valid_from_date": "2024-01-01",
"valid_to_date": "2024-12-31",
"tax_exemption_details": {
"tax_exemption_type": "SINGLE",
"tax_exemption_amount": {
"amount": "1000.00",
"currency": "EUR"
},
"utilized_amount": {
"amount": "0.00",
"currency": "EUR"
},
"remaining_amount": {
"amount": "1000.00",
"currency": "EUR"
}
}
},
"webhook_id": "cd26a6ce-7a1c-47de-a6fc-b5dfd996da99"
}
Was this page helpful?