Tax Exemptions

List tax exemptions for a user

Changed on

Returns the tax exemption orders of the end user identified by user_id.

Use the offset and limit query parameters to page through results; meta.total_count gives the total number of matching tax exemptions.

See the Retrieving tax exemption orders guide for implementation details.

get/users/{user_id}/tax_exemptions

Request

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

Query parameters

sort'created_at'

Sort the result by created_at.

order'ASC' | 'DESC'

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

offsetinteger

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

limitinteger

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

Response

OK

Changes

  • 85aff1852bf8Revision changes
    • warning

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