Skip to content

Tax exemption verification request.

POST
/api/web/namespaces/system/customer_support/tax_exempt_request
curl --request POST \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/namespaces/system/customer_support/tax_exempt_request \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--data '{ "attachments": [ { "attachment": "example", "content_type": "example", "filename": "example", "tp_id": "example" } ], "request_description": "example" }'

Raises a tax exemption verification request. This will ultimately create a support ticket and assign it to our billing department. If verified and approved then the customer will not be levied sale taxes.

Examples of this operation.

Media typeapplication/json
Request to verify customer tax exemption status

Provides ability to request tax status of the customer, eventually flagging them as tax exempt (U.S. Only)

object
attachments
Attachments information

Information about any attachments (such as screenshots, plain text files) to support the tax exemption review request.

Array<object>
Attachment

Attachment represents a single support ticket comment attachment. Attachment are normally not store with the ticket itself, they represent a handle in the third party, so the contact can be retrieved omn demand.

object
attachment
Binary attachment

Any binary attachment (such as screenshots, plain text files, PDFs) encoded as base64 if used over HTTP.

string format: byte
<= 1024 characters
content_type
Content type

Mime content type of the attachment. Helps the UI to properly display the data.

string
<= 1024 characters
filename
Filename of the attachment

Filename of the attachment as provided by the caller.

string
<= 1024 characters
tp_id
3rd party ID

Optional ID as assigned by the 3rd party actually storing the data.

string
<= 1024 characters
request_description
Request description

Description introducing reasons for tax exemption status verification.

string
<= 1024 characters
Examplegenerated
{
"attachments": [
{
"attachment": "example",
"content_type": "example",
"filename": "example",
"tp_id": "example"
}
],
"request_description": "example"
}

A successful response.

Media typeapplication/json
Tax exemption status verification response

Any error that may occurred during tax status verification request. Note that the verification process itself takes a lot of time (days) - this message only indicates the reception of the request.

object
err
string
default: EUNKNOWN
Allowed values: EUNKNOWN EOK E_NOT_CLOSED E_NOT_OPEN E_NOT_ELIGIBLE E_NOT_NOT_FOUND
name
name of ticket

X-displayName : “Name” name of the ticket created on the back of the request.

string
>= 6 characters <= 1024 characters
Example
{
"err": "EUNKNOWN"
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example