tradevest.ai

Tax Exemption

Create Tax Exemption Order

Create Tax Exemption Order

post
/taxes/tax-exemption-orders

Create a new tax exemption order for the given entity.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
entityIdstring · uuidRequired

Unique entity identification in UUID format

entityTypestring · enumRequired

Type of the entity.

Possible values:
fsaTypestring · enumRequired

The type of the fsa

Possible values:
fsaAmountnumber · decimalRequired

The amount to allocate for FSA (must be positive)

fsaValidFromstring · dateOptional

Date from which the allocation becomes valid (optional, it will be January 1st if not provided)

fsaValidUntilstring · dateOptional

Date until which the allocation is valid (optional, must be December 31st if provided)

Responses
200

OK

application/json
post
/taxes/tax-exemption-orders
POST /taxes/tax-exemption-orders HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 175

{
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "entityType": "NATURAL_PERSON",
  "fsaType": "INDIVIDUAL",
  "fsaAmount": 1,
  "fsaValidFrom": "2025-12-04",
  "fsaValidUntil": "2025-12-04"
}
200

OK

{
  "taxExemptionOrderId": "123e4567-e89b-12d3-a456-426614174000"
}

Update Tax Exemption Order

Update Tax Exemption Order

patch
/taxes/tax-exemption-orders/{taxExemptionOrderId}

Update tax exemption order

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
taxExemptionOrderIdstring · uuidRequired

Tax exemption order ID

Header parameters
Requestor-IDstring · uuidRequired

Unique requestor identification in UUID format

Body
fsaAmountnumber · decimalOptional

The amount to allocate for FSA (must be positive)

fsaValidUntilstring · dateOptional

Date until which the allocation is valid (optional, must be December 31st if provided)

Responses
patch
/taxes/tax-exemption-orders/{taxExemptionOrderId}
PATCH /taxes/tax-exemption-orders/{taxExemptionOrderId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Requestor-ID: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "fsaAmount": 1,
  "fsaValidUntil": "2025-12-04"
}
No content

Get Tax Exemption Orders

Get Tax Exemption Orders

get
/taxes/tax-exemption-orders

Get a list of tax exemption orders

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Query parameters
cursorstringOptional

String value used for pagination

limitinteger · min: 1Required

Maximum number of items to return

Default: 20
taxExemptionOrderIdstring · uuidOptional

Tax exemption order ID

entityIdstring · uuidOptional

Unique entity identification in UUID format

statusstring · enumOptional

The status of the tax exemption order

Possible values:
Responses
200

OK

application/json
get
/taxes/tax-exemption-orders
GET /taxes/tax-exemption-orders?limit=20 HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "taxExemptionOrderId": "123e4567-e89b-12d3-a456-426614174000",
      "status": "RECEIVED",
      "createdOn": "2025-12-04T15:59:40.705Z",
      "modifiedOn": "2025-12-04T15:59:40.705Z",
      "entityId": "123e4567-e89b-12d3-a456-426614174000",
      "entityType": "NATURAL_PERSON",
      "fsaType": "INDIVIDUAL",
      "fsaAmount": 1,
      "fsaValidFrom": "2025-12-04",
      "fsaValidUntil": "2025-12-04"
    }
  ],
  "pagination": {
    "cursor": "text",
    "limit": 1
  }
}

Get Tax Exemption Order

Get Tax Exemption Order

get
/taxes/tax-exemption-orders/{taxExemptionOrderId}

Get tax exemption order

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
taxExemptionOrderIdstring · uuidRequired

Tax exemption order ID

Responses
200

OK

application/json
get
/taxes/tax-exemption-orders/{taxExemptionOrderId}
GET /taxes/tax-exemption-orders/{taxExemptionOrderId} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "taxExemptionOrderId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "RECEIVED",
  "createdOn": "2025-12-04T15:59:40.705Z",
  "modifiedOn": "2025-12-04T15:59:40.705Z",
  "entityId": "123e4567-e89b-12d3-a456-426614174000",
  "entityType": "NATURAL_PERSON",
  "fsaType": "INDIVIDUAL",
  "fsaAmount": 1,
  "fsaValidFrom": "2025-12-04",
  "fsaValidUntil": "2025-12-04"
}

Last updated