Element type: Suggested

Endpoints/models used: UnlinkCertificatesFromCustomer, UnlinkCustomersFromCertificate

As exemption certificates expire or no longer apply to a customer, your integration must provide a function to remove a certificate from that customer.

Important

A DeleteCertificate API is available to remove a certificate from ECM. Use caution when running this API. It’s possible that a certificate is linked to multiple customers, so deleting a certificate will remove it from all customers.

UnlinkCertificateFromCustomer

Use the UnlinkCertificatesFromCustomer API to remove one or more certificates from a customer. Include yourcompanyId and thecustomerCode in the request URL.

curl
  -X POST
  -H 'Accept: application/json'
  -H 'Authorization: Basic ${btoa(`:`)}'
  -H 'Content-Type: application/json'
  --data {
    "certificates": [
      1,
      3
    ]
  }
  'https://sandbox-rest.avatax.com/api/v2/companies/{companyId}/customers/{customerCode}/certificates/unlink'

UnlinkCustomersFromCertificate

Use the UnlinkCustomersFromCertificate API to remove customers from a certificate. Include yourcompanyId and the certificateid in the request URL.

curl
  -X POST
  -H 'Accept: application/json'
  -H 'Authorization: Basic ${btoa(`:`)}'
  -H 'Content-Type: application/json'
  --data {
    "customers": [
      "123456789"
    ]
  }
  'https://sandbox-rest.avatax.com/api/v2/companies/{companyId}/certificates/{id}/customers/unlink'

Revoke a certificate