Retrieving tax exemption orders
Via the Investment API, you have the option to retrieve tax exemption orders either for a specific user or a specific order specified by its ID.
Get tax exemptions of a user
To retrieve the tax exemptions of a user, call
GET /users/{user_id}/tax_exemptions
Path parameter | Description | Example value |
---|---|---|
user_id | Required: The identifier for the user whose tax exemptions are to be fetched. | 70821d79-366f-4873-804b-14857d690496 |
Example response
{
"meta": {
"offset": 0,
"limit": 100,
"count": 1,
"total_count": 1,
"sort": "created_at",
"order": "ASC"
},
"data": [
{
"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"
}
}
}
]
}
Get a tax exemption by ID
To get the tax exemption specified by its ID, call
GET /tax_exemptions/{tax_exemption_id}
Path parameter | Description | Example value |
---|---|---|
tax_exemption_id | Required: The identifier for the tax exemption order that is to be fetched. | f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1 |
Example response
{
"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"
}
}
}