List Exemption Certificates

Available on Enterprise Plan

Forwards to TaxCloud GET /exemption-certificates, scoped to the merchant’s connection via a connectionId query filter, and returns the certificate collection verbatim.

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
merchantIdstringRequired
UUID of the merchant. Must be owned by the calling account. Consumed by the Ziptax layer for routing and not forwarded to TaxCloud.
ascendingbooleanOptionalDefaults to false

Whether to sort results in ascending order. Defaults to false (descending).

cursorstringOptional
Opaque pagination cursor from the nextCursor field of a previous response. Omit to start at the first page.
customerIdstringOptional
Filter results to certificates belonging to this customerId.
disabledbooleanOptionalDefaults to false

Set true to list disabled (revoked) certificates instead of active ones. Defaults to false.

limitlongOptionalDefaults to 20

Maximum number of certificates to return per page. Defaults to 20; maximum 100.

sortByenumOptionalDefaults to id

The field to sort results by: ‘createdDate’ or ‘id’. Defaults to ‘id’.

Allowed values:

Response

TaxCloud response relayed verbatim.
limitlong
The maximum number of results per page that was applied.
nextCursorstring
Opaque cursor to pass as 'cursor' on the next call to fetch the following page. Null when there are no further results.
itemslist of objects
The exemption certificates on this page of results.

Errors

400
Merchant Cert List Body Bad Request Error
401
Merchant Cert List Body Unauthorized Error
403
Merchant Cert List Body Forbidden Error
404
Merchant Cert List Body Not Found Error
413
Merchant Cert List Body Content Too Large Error
422
Merchant Cert List Body Unprocessable Entity Error
429
Merchant Cert List Body Too Many Requests Error
500
Merchant Cert List Body Internal Server Error
502
Merchant Cert List Body Bad Gateway Error
504
Merchant Cert List Body Gateway Timeout Error