Tax Exemptions

Download Spec

All tax exemptions related paths

Create a tax exemption
post /tax_exemptions

Creates a tax exemption.

user_ids

array[string]

required

Ids of the users for whom the tax exemption is to be created.

tax_exemption_details

One Of

required

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

valid_to_date

string

date

Date until which the tax exemption is valid. If it is unlimited, it is omitted. For Germany it is always the last day of the year (YYYY-12-31). RFC 3339, section 5.6

Request

{
  "user_ids": [
    "70fd317b-81e1-4f21-9f7e-3b5cb4dfe686"
  ],
  "tax_exemption_details": {
    "tax_exemption_type": "SINGLE",
    "tax_exemption_amount": {
      "currency": "EUR",
      "amount": "1000"
    }
  },
  "country": "DE",
  "valid_to_date": "2024-12-31"
}

Response

ExamplesSchema

Creation request accepted.

{
  "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1"
}

Get a tax exemption by ID
get /tax_exemptions/{tax_exemption_id}

Returns the tax exemption specified by its ID

tax_exemption_id

string

uuid

required

Response

ExamplesSchema

OK

{
  "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"
    }
  }
}

Update a tax exemption
put /tax_exemptions/{tax_exemption_id}

Updates a tax exemption specified by its ID.

user_ids

array[string]

required

Ids of the users for whom the tax exemption is to be updated.

tax_exemption_details

One Of

required

country

string

^[A-Z]{2}$

required

Country code. ISO 3166 alpha-2 Codes.

valid_to_date

string

date

Date until which the tax exemption is valid. If it is unlimited, it is omitted. For Germany it is always the last day of the year (YYYY-12-31). RFC 3339, section 5.6

Request

{
  "user_ids": [
    "70fd317b-81e1-4f21-9f7e-3b5cb4dfe686"
  ],
  "tax_exemption_details": {
    "tax_exemption_type": "SINGLE",
    "tax_exemption_amount": {
      "currency": "EUR",
      "amount": "955"
    }
  },
  "country": "DE",
  "valid_to_date": "2024-12-31"
}

Response

ExamplesSchema

The tax exemption update is submitted.

{
  "id": "f1a57a04-1a89-4dab-ae3a-ff9b2a9377c1"
}

Delete a tax exemption
delete /tax_exemptions/{tax_exemption_id}

Deletes a tax exemption specified by its ID.

tax_exemption_id

string

uuid

required

Response

ExamplesSchema

The request has been successfully accepted and will be processed asynchronously.

Empty response

List tax exemptions for a user
get /users/{user_id}/tax_exemptions

Returns the tax exemptions of the user specified by ID.

sort

string

Sort the result by created_at.

Default
"created_at"
Enum
  • created_at

order

string

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC

offset

int

int32

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Min
0

limit

int

int32

Use the limit argument to specify the maximum number of items returned.

Default
100
Min
0
Max
1000

Response

ExamplesSchema

OK

{
  "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"
        }
      }
    }
  ]
}

Tax Exemption Events
webhook

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Tax exemption events webhook type

  • TAX_EXEMPTION.CREATED - Tax exemption successfully created.
  • TAX_EXEMPTION.UPDATED - Tax exemption successfully updated.
  • TAX_EXEMPTION.DELETED - Tax exemption successfully deleted.
Enum
  • TAX_EXEMPTION.CREATED
  • TAX_EXEMPTION.UPDATED
  • TAX_EXEMPTION.DELETED

object

object (object)

required

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "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"
}

Response

ExamplesSchema

Request has been processed successfully.

Empty response

Tax Exemption Failure Events
webhook

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Type of the tax exemption failure events webhook.

  • TAX_EXEMPTION.CREATION_FAILED - Tax exemption creation failed.
  • TAX_EXEMPTION.UPDATE_FAILED - Tax exemption update failed.
  • TAX_EXEMPTION.DELETION_FAILED - Tax exemption deletion failed.
Enum
  • TAX_EXEMPTION.CREATION_FAILED
  • TAX_EXEMPTION.UPDATE_FAILED
  • TAX_EXEMPTION.DELETION_FAILED

object

object (object)

required

webhook_id

string

uuid

required

Webhook unique identifier.

Request

{
  "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"
}

Response

ExamplesSchema

Request has been processed successfully.

Empty response

Was this page helpful?