Tax Exemptions

Get a tax exemption by ID

Changed on

Returns the tax exemption order identified by tax_exemption_id, including its status and the allowance used and remaining for the tax year.

See the Retrieving tax exemption orders guide for implementation details.

get/tax_exemptions/{tax_exemption_id}

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/tax_exemptions/{tax_exemption_id}
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: taxes:admin)

Response

OK

idstring uuid required

The unique identifier of the tax exemption order, as a UUID.

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

status'NEW' | 'ACTIVE' | 'EXPIRED' | 'CANCELLED' required

Tax exemption status

  • NEW - The tax exemption request is created.
  • ACTIVE - The tax exemption is valid and active for the current year.
  • EXPIRED - The tax exemption is no longer ACTIVE and the valid_to_date already lies in the past. An update is not possible.
  • CANCELLED - The tax exemption could not be created or was cancelled.
user_idsstring[] required

Ids of the users for whom the tax exemption was created.

countrystring required

Country code. ISO 3166 alpha-2 Codes.

valid_from_datestring date required

Date from which the tax exemption is valid. RFC 3339, section 5.6

valid_to_datestring date nullable required

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

Changes

  • 85aff1852bf8Revision changes
    • warning

      added the new CIVIL_PARTNERSHIP enum value to the / response property for the response status