Update Option Exercise Tax Withholding

URL Expired

The URL for this request expired after 30 days.

UpdateTaxWithholding Request

Parameters

• issuerId

  • string
  • Required: The identifier of the issuer that issued the option exercises to update tax withholding information for.

• exerciseId

  • string
  • Required: The identifier of the option exercise to update tax withholding information for.

• taxWithholdings

  • array of objects
  • The tax withholdings information to update.

Response

• 200

  • A successful response.
  • issuerId
    • string
    • Length between 1 and 50.

• exerciseId

  • string
  • Length between 1 and 50.

• taxWithholdings

  • array of objects
  • The updated tax withholdings.

• taxWithholdings Object

  • Tax withholding information for an option exercise, calculated for a specific jurisdiction for a given stakeholder.

• name

  • string
  • Length ≤ 100.

• rate

  • object
  • The tax withholding percentage rate for the specified jurisdiction.

• taxes

  • object
  • The tax to withhold for the specified jurisdiction.

• jurisdiction

  • object
  • The jurisdiction for which the tax withholding is calculated.

Error Responses

• 400

  • Returned if required fields are omitted or if provided fields fail validation.

• 401

  • Returned if a valid Authorization header has not been included with the request.

• 403

  • Returned when the user does not have permission to access the resource.

• 500

  • Returned if an unexpected internal server error is encountered.

• default

  • An unexpected error response.

Example Request

curl --request POST \
     --url https://mock-api.carta.com/v1alpha1/issuers/issuerId/optionExercises/exerciseId:updateTaxWithholding \
     --header 'accept: application/json' \ 
     --header 'content-type: application/json'

Example Request Body

{
  "issuerId": "7",
  "exerciseId": "string",
  "taxWithholdings": [
    {
      "name": "string",
      "rate": {
        "value": "100.57"
      },
      "taxes": {
        "currencyCode": "USD",
        "amount": {
          "value": "1000.77"
        }
      },
      "jurisdiction": {
        "city": "San Francisco",
        "countrySubdivision": {
          "value": "US-CA"
        },
        "country": {
          "value": "USA"
        }
      }
    }
  ]
}